blob: 428e91f88d889b01643491de912a3e055d0ed917 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
|
# Copyright 2015 Intel Corporation.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
"""Interface to traffic controllers
"""
class ITrafficController(object):
"""Abstract class which defines a traffic controller object
Used to setup and control a traffic generator for a particular deployment
scenario.
"""
def send_traffic(self, traffic):
"""Triggers traffic to be sent from the traffic generator.
This is a blocking function.
:param traffic: A dictionary describing the traffic to send.
"""
raise NotImplementedError(
"The TrafficController does not implement",
"the \"send_traffic\" function.")
def send_traffic_async(self, traffic, function):
"""Triggers traffic to be sent asynchronously.
This is not a blocking function.
:param traffic: A dictionary describing the traffic to send.
:param function: A dictionary describing the function to call between
send and wait in the form:
function = {
'function' : package.module.function,
'args' : args
}
If this function requires more than one argument, all should be
should be passed using the args list and appropriately handled.
"""
raise NotImplementedError(
"The TrafficController does not implement",
"the \"send_traffic_async\" function.")
def stop_traffic(self):
"""Kills traffic being sent from the traffic generator.
"""
raise NotImplementedError(
"The TrafficController does not implement",
"the \"stop_traffic\" function.")
|
