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 | |
Brian O'Connor | abafb50 | 2014-12-02 22:26:20 -0800 | [diff] [blame] | 18 | import org.onosproject.net.ConnectPoint; |
| 19 | import org.onosproject.net.flow.FlowEntry; |
| 20 | import org.onosproject.net.flow.FlowRule; |
alshabib | a43aa25 | 2014-10-21 21:36:41 -0700 | [diff] [blame] | 21 | |
| 22 | import java.util.Set; |
| 23 | |
| 24 | /** |
| 25 | * Store to house the computed statistics. |
| 26 | */ |
| 27 | public interface StatisticStore { |
| 28 | |
| 29 | /** |
| 30 | * Lay the foundation for receiving flow stats for this rule. |
Sho SHIMIZU | cf6090b | 2014-11-13 17:34:46 -0800 | [diff] [blame] | 31 | * |
Brian O'Connor | abafb50 | 2014-12-02 22:26:20 -0800 | [diff] [blame] | 32 | * @param rule a {@link org.onosproject.net.flow.FlowRule} |
alshabib | a43aa25 | 2014-10-21 21:36:41 -0700 | [diff] [blame] | 33 | */ |
| 34 | void prepareForStatistics(FlowRule rule); |
| 35 | |
| 36 | /** |
| 37 | * Remove entries associated with this rule. |
Sho SHIMIZU | cf6090b | 2014-11-13 17:34:46 -0800 | [diff] [blame] | 38 | * |
Brian O'Connor | abafb50 | 2014-12-02 22:26:20 -0800 | [diff] [blame] | 39 | * @param rule {@link org.onosproject.net.flow.FlowRule} |
alshabib | a43aa25 | 2014-10-21 21:36:41 -0700 | [diff] [blame] | 40 | */ |
| 41 | void removeFromStatistics(FlowRule rule); |
| 42 | |
| 43 | /** |
| 44 | * Adds a stats observation for a flow rule. |
Sho SHIMIZU | cf6090b | 2014-11-13 17:34:46 -0800 | [diff] [blame] | 45 | * |
Brian O'Connor | abafb50 | 2014-12-02 22:26:20 -0800 | [diff] [blame] | 46 | * @param rule a {@link org.onosproject.net.flow.FlowEntry} |
alshabib | a43aa25 | 2014-10-21 21:36:41 -0700 | [diff] [blame] | 47 | */ |
| 48 | void addOrUpdateStatistic(FlowEntry rule); |
| 49 | |
| 50 | /** |
| 51 | * Fetches the current observed stats values. |
Sho SHIMIZU | cf6090b | 2014-11-13 17:34:46 -0800 | [diff] [blame] | 52 | * |
alshabib | a43aa25 | 2014-10-21 21:36:41 -0700 | [diff] [blame] | 53 | * @param connectPoint the port to fetch information for |
| 54 | * @return set of current flow rules |
| 55 | */ |
| 56 | Set<FlowEntry> getCurrentStatistic(ConnectPoint connectPoint); |
| 57 | |
| 58 | /** |
Jian Li | 230ce4f | 2016-02-09 16:57:06 -0800 | [diff] [blame] | 59 | * Fetches the previous observed stats values. |
Sho SHIMIZU | cf6090b | 2014-11-13 17:34:46 -0800 | [diff] [blame] | 60 | * |
alshabib | a43aa25 | 2014-10-21 21:36:41 -0700 | [diff] [blame] | 61 | * @param connectPoint the port to fetch information for |
| 62 | * @return set of current values |
| 63 | */ |
| 64 | Set<FlowEntry> getPreviousStatistic(ConnectPoint connectPoint); |
| 65 | } |