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
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
|
"""Defines Header classes and related items."""
# System imports
from enum import IntEnum
# Local source tree imports
from pyof.foundation.base import GenericStruct
from pyof.foundation.basic_types import UBInt8, UBInt16, UBInt32
from pyof.v0x04.common.constants import OFP_VERSION
# Third-party imports
__all__ = ('Header', 'Type')
# Enums
class Type(IntEnum):
"""Enumeration of Message Types."""
# Symetric/Immutable messages
OFPT_HELLO = 0
OFPT_ERROR = 1
OFPT_ECHO_REQUEST = 2
OFPT_ECHO_REPLY = 3
OFPT_EXPERIMENTER = 4
# Switch configuration messages
# Controller/Switch messages
OFPT_FEATURES_REQUEST = 5
OFPT_FEATURES_REPLY = 6
OFPT_GET_CONFIG_REQUEST = 7
OFPT_GET_CONFIG_REPLY = 8
OFPT_SET_CONFIG = 9
# Async messages
OFPT_PACKET_IN = 10
OFPT_FLOW_REMOVED = 11
OFPT_PORT_STATUS = 12
# Controller command messages
# Controller/Switch message
OFPT_PACKET_OUT = 13
OFPT_FLOW_MOD = 14
OFPT_GROUP_MOD = 15
OFPT_PORT_MOD = 16
OFPT_TABLE_MOD = 17
# Multipart messages.
# Controller/Switch message
OFPT_MULTIPART_REQUEST = 18
OFPT_MULTIPART_REPLY = 19
# Barrier messages
# Controller/Switch message
OFPT_BARRIER_REQUEST = 20
OFPT_BARRIER_REPLY = 21
# Queue Configuration messages
# Controller/Switch message
OFPT_QUEUE_GET_CONFIG_REQUEST = 22
OFPT_QUEUE_GET_CONFIG_REPLY = 23
# Controller role change request message
# Controller/Switch message
OFPT_ROLE_REQUEST = 24
OFPT_ROLE_REPLY = 25
# Asynchronous message configuration
# Controller/Switch message
OFPT_GET_ASYNC_REQUEST = 26
OFPT_GET_ASYNC_REPLY = 27
OFPT_SET_ASYNC = 28
# Meters and rate limiters configuration messages
# Controller/Switch message
OFPT_METER_MOD = 29
# Classes
class Header(GenericStruct):
"""Representation of an OpenFlow message Header."""
version = UBInt8(OFP_VERSION)
message_type = UBInt8(enum_ref=Type)
length = UBInt16()
xid = UBInt32()
def __init__(self, message_type=None, length=None, xid=None):
"""Create a Header with the optional parameters below.
Args:
message_type (~pyof.v0x04.common.header.Type):
One of the OFPT_* constants.
length (int): Length including this ofp_header.
xid (int): Transaction id associated with this packet. Replies use
the same id as was in the request to facilitate pairing.
"""
super().__init__()
self.message_type = message_type
self.length = length
self.xid = xid
def __repr__(self):
return (f"{type(self).__name__}(version={self.version}, "
f"xid={self.xid}, {self.message_type!s})")
|
