blob: cd88d2a488dd75e8303bd6082db08e2428ec4794 [file] [log] [blame]
Carmelo Casconeb045ddc2017-09-01 01:26:35 +02001/*
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
17package org.onosproject.net.pi.runtime;
18
Carmelo Casconeb045ddc2017-09-01 01:26:35 +020019/**
Carmelo Cascone7f75be42017-09-07 14:37:02 +020020 * Identifier of a counter cell in a protocol-independent pipeline.
Carmelo Casconeb045ddc2017-09-01 01:26:35 +020021 */
Carmelo Cascone7f75be42017-09-07 14:37:02 +020022public interface PiCounterCellId {
Carmelo Casconeb045ddc2017-09-01 01:26:35 +020023
24 /**
Carmelo Cascone7f75be42017-09-07 14:37:02 +020025 * Returns the identifier of the counter instance where this cell is contained.
Carmelo Casconeb045ddc2017-09-01 01:26:35 +020026 *
27 * @return counter identifier
28 */
Carmelo Cascone7f75be42017-09-07 14:37:02 +020029 PiCounterId counterId();
Carmelo Casconeb045ddc2017-09-01 01:26:35 +020030
31 /**
Carmelo Cascone7f75be42017-09-07 14:37:02 +020032 * Returns the type of counter identified.
Carmelo Casconeb045ddc2017-09-01 01:26:35 +020033 *
Carmelo Cascone7f75be42017-09-07 14:37:02 +020034 * @return counter type
Carmelo Casconeb045ddc2017-09-01 01:26:35 +020035 */
Carmelo Cascone7f75be42017-09-07 14:37:02 +020036 PiCounterType type();
Carmelo Casconeb045ddc2017-09-01 01:26:35 +020037}