Thomas Vachuska | 4f1a60c | 2014-10-28 13:39:07 -0700 | [diff] [blame] | 1 | /* |
Brian O'Connor | a09fe5b | 2017-08-03 21:12:30 -0700 | [diff] [blame] | 2 | * Copyright 2014-present Open Networking Foundation |
Thomas Vachuska | 4f1a60c | 2014-10-28 13:39:07 -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 | */ |
Brian O'Connor | abafb50 | 2014-12-02 22:26:20 -0800 | [diff] [blame] | 16 | package org.onosproject.net.statistic; |
alshabib | a43aa25 | 2014-10-21 21:36:41 -0700 | [diff] [blame] | 17 | |
| 18 | /** |
| 19 | * Simple data repository for link load information. |
| 20 | */ |
| 21 | public interface Load { |
| 22 | |
| 23 | /** |
alshabib | 3d643ec | 2014-10-22 18:33:00 -0700 | [diff] [blame] | 24 | * Obtain the current observed rate (in bytes/s) on a link. |
Sho SHIMIZU | cf6090b | 2014-11-13 17:34:46 -0800 | [diff] [blame] | 25 | * |
alshabib | a43aa25 | 2014-10-21 21:36:41 -0700 | [diff] [blame] | 26 | * @return long value |
| 27 | */ |
| 28 | long rate(); |
| 29 | |
| 30 | /** |
alshabib | 3d643ec | 2014-10-22 18:33:00 -0700 | [diff] [blame] | 31 | * Obtain the latest bytes counter viewed on that link. |
Sho SHIMIZU | cf6090b | 2014-11-13 17:34:46 -0800 | [diff] [blame] | 32 | * |
alshabib | a43aa25 | 2014-10-21 21:36:41 -0700 | [diff] [blame] | 33 | * @return long value |
| 34 | */ |
| 35 | long latest(); |
| 36 | |
alshabib | 3d643ec | 2014-10-22 18:33:00 -0700 | [diff] [blame] | 37 | /** |
| 38 | * Indicates whether this load was built on valid values. |
Sho SHIMIZU | cf6090b | 2014-11-13 17:34:46 -0800 | [diff] [blame] | 39 | * |
alshabib | 3d643ec | 2014-10-22 18:33:00 -0700 | [diff] [blame] | 40 | * @return boolean |
| 41 | */ |
| 42 | boolean isValid(); |
| 43 | |
| 44 | /** |
| 45 | * Returns when this value was seen. |
Sho SHIMIZU | cf6090b | 2014-11-13 17:34:46 -0800 | [diff] [blame] | 46 | * |
alshabib | 3d643ec | 2014-10-22 18:33:00 -0700 | [diff] [blame] | 47 | * @return epoch time |
| 48 | */ |
| 49 | long time(); |
| 50 | |
alshabib | a43aa25 | 2014-10-21 21:36:41 -0700 | [diff] [blame] | 51 | } |