Frank Wang | d7e3b4b | 2017-09-24 13:37:54 +0900 | [diff] [blame] | 1 | /* |
| 2 | * Copyright 2017-present Open Networking Foundation |
| 3 | * |
| 4 | * Licensed under the Apache License, Version 2.0 (the "License"); |
| 5 | * you may not use this file except in compliance with the License. |
| 6 | * You may obtain a copy of the License at |
| 7 | * |
| 8 | * http://www.apache.org/licenses/LICENSE-2.0 |
| 9 | * |
| 10 | * Unless required by applicable law or agreed to in writing, software |
| 11 | * distributed under the License is distributed on an "AS IS" BASIS, |
| 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 13 | * See the License for the specific language governing permissions and |
| 14 | * limitations under the License. |
| 15 | */ |
| 16 | |
| 17 | package org.onosproject.net.meter; |
| 18 | |
| 19 | import com.google.common.annotations.Beta; |
| 20 | |
| 21 | /** |
| 22 | * A representation of a meter cell identifier. |
| 23 | * Uniquely identifies a meter cell in the scope of a single device. |
| 24 | */ |
| 25 | @Beta |
| 26 | public interface MeterCellId { |
| 27 | |
| 28 | /** |
| 29 | * Types of meter cell identifier. |
| 30 | */ |
| 31 | enum MeterCellType { |
| 32 | /** |
| 33 | * Signifies that the meter cell can be identified with an integer index. |
| 34 | * Valid for pipelines that defines one global meter table, e.g. as with |
| 35 | * OpenFlow meters. |
| 36 | */ |
| 37 | INDEX, |
| 38 | |
| 39 | /** |
| 40 | * Signifies that the meter cell identifier is pipeline-independent. |
| 41 | */ |
| 42 | PIPELINE_INDEPENDENT |
| 43 | } |
| 44 | |
| 45 | /** |
| 46 | * Return the type of this meter cell identifier. |
| 47 | * |
| 48 | * @return type |
| 49 | */ |
| 50 | MeterCellType type(); |
| 51 | } |