Thomas Vachuska | ca88bb7 | 2015-04-08 19:38:02 -0700 | [diff] [blame] | 1 | /* |
Brian O'Connor | a09fe5b | 2017-08-03 21:12:30 -0700 | [diff] [blame] | 2 | * Copyright 2015-present Open Networking Foundation |
Thomas Vachuska | ca88bb7 | 2015-04-08 19:38:02 -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 | */ |
| 16 | package org.onosproject.net.behaviour; |
| 17 | |
| 18 | import org.onlab.osgi.ServiceDirectory; |
alshabib | 2a441c6 | 2015-04-13 18:39:38 -0700 | [diff] [blame] | 19 | import org.onosproject.net.flowobjective.FlowObjectiveStore; |
Thomas Vachuska | ca88bb7 | 2015-04-08 19:38:02 -0700 | [diff] [blame] | 20 | |
| 21 | /** |
| 22 | * Processing context and supporting services for the pipeline behaviour. |
| 23 | */ |
| 24 | public interface PipelinerContext { |
| 25 | |
| 26 | /** |
| 27 | * Returns the service directory which can be used to obtain references |
| 28 | * to various supporting services. |
| 29 | * |
| 30 | * @return service directory |
| 31 | */ |
| 32 | ServiceDirectory directory(); |
| 33 | |
alshabib | 2a441c6 | 2015-04-13 18:39:38 -0700 | [diff] [blame] | 34 | /** |
| 35 | * Returns the Objective Store where data can be stored and retrieved. |
| 36 | * @return the flow objective store |
| 37 | */ |
| 38 | FlowObjectiveStore store(); |
| 39 | |
Thomas Vachuska | ca88bb7 | 2015-04-08 19:38:02 -0700 | [diff] [blame] | 40 | // TODO: add means to store and access shared state |
pier | 8b3aef4 | 2019-03-11 15:14:02 -0700 | [diff] [blame] | 41 | |
| 42 | /** |
| 43 | * Returns the maximum number of objectives to accumulate before processing is triggered. |
| 44 | * |
| 45 | * @return the maximum number of objectives. -1 if the method is not implemented. |
| 46 | */ |
| 47 | default int accumulatorMaxObjectives() { |
| 48 | return -1; |
| 49 | } |
| 50 | |
| 51 | /** |
| 52 | * Returns the maximum number of millis between objectives before processing is triggered. |
| 53 | * |
| 54 | * @return the maximum number of millis between objectives. -1 if the method is not implemented. |
| 55 | */ |
| 56 | default int accumulatorMaxIdleMillis() { |
| 57 | return -1; |
| 58 | } |
| 59 | |
| 60 | /** |
| 61 | * Returns the maximum number of millis allowed since the first objective before processing is triggered. |
| 62 | * |
| 63 | * @return the maximum number of millis allowed since the first objective. -1 if the method is not implemented. |
| 64 | */ |
| 65 | default int accumulatorMaxBatchMillis() { |
| 66 | return -1; |
| 67 | } |
| 68 | |
Thomas Vachuska | ca88bb7 | 2015-04-08 19:38:02 -0700 | [diff] [blame] | 69 | } |