Thomas Vachuska | f0397b5 | 2015-05-29 13:50:17 -0700 | [diff] [blame] | 1 | /* |
Thomas Vachuska | 52f2cd1 | 2018-11-08 21:20:04 -0800 | [diff] [blame] | 2 | * Copyright 2018-present Open Networking Foundation |
Thomas Vachuska | f0397b5 | 2015-05-29 13:50:17 -0700 | [diff] [blame] | 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 | */ |
Thomas Vachuska | 52f2cd1 | 2018-11-08 21:20:04 -0800 | [diff] [blame] | 16 | package org.onosproject.net.statistic; |
Thomas Vachuska | f0397b5 | 2015-05-29 13:50:17 -0700 | [diff] [blame] | 17 | |
Brian O'Connor | 42afe18 | 2015-06-25 15:10:50 -0400 | [diff] [blame] | 18 | import com.google.common.annotations.Beta; |
Thomas Vachuska | f0397b5 | 2015-05-29 13:50:17 -0700 | [diff] [blame] | 19 | import org.onosproject.net.ConnectPoint; |
Thomas Vachuska | f0397b5 | 2015-05-29 13:50:17 -0700 | [diff] [blame] | 20 | |
| 21 | /** |
| 22 | * Service for obtaining statistic information about device ports. |
| 23 | */ |
Brian O'Connor | 42afe18 | 2015-06-25 15:10:50 -0400 | [diff] [blame] | 24 | @Beta |
Thomas Vachuska | f0397b5 | 2015-05-29 13:50:17 -0700 | [diff] [blame] | 25 | public interface PortStatisticsService { |
| 26 | |
Thomas Vachuska | 0932ac5 | 2017-03-30 13:28:49 -0700 | [diff] [blame] | 27 | /** Specifies the type of metric. */ |
| 28 | enum MetricType { |
| 29 | /** Load is to be given in bytes/second. */ |
| 30 | BYTES, |
| 31 | |
| 32 | /** Load is to be given in packets/second. */ |
| 33 | PACKETS |
| 34 | } |
| 35 | |
Thomas Vachuska | f0397b5 | 2015-05-29 13:50:17 -0700 | [diff] [blame] | 36 | /** |
Thomas Vachuska | 0932ac5 | 2017-03-30 13:28:49 -0700 | [diff] [blame] | 37 | * Obtain the egress load for the given port in terms of bytes per second. |
Thomas Vachuska | f0397b5 | 2015-05-29 13:50:17 -0700 | [diff] [blame] | 38 | * |
| 39 | * @param connectPoint the port to query |
| 40 | * @return egress traffic load |
| 41 | */ |
| 42 | Load load(ConnectPoint connectPoint); |
| 43 | |
Thomas Vachuska | 0932ac5 | 2017-03-30 13:28:49 -0700 | [diff] [blame] | 44 | /** |
| 45 | * Obtain the egress load for the given port in terms of the specified metric. |
| 46 | * |
| 47 | * @param connectPoint the port to query |
| 48 | * @param metricType metric type |
| 49 | * @return egress traffic load |
| 50 | */ |
| 51 | default Load load(ConnectPoint connectPoint, MetricType metricType) { |
| 52 | return load(connectPoint); |
| 53 | } |
| 54 | |
Thomas Vachuska | f0397b5 | 2015-05-29 13:50:17 -0700 | [diff] [blame] | 55 | } |