From f7ff5b80bd05d26246ba43fed979f4eae73973b3 Mon Sep 17 00:00:00 2001 From: Yoshihiro Kaneko Date: Mon, 2 Sep 2013 19:21:19 +0900 Subject: [PATCH] of12, of13: small update of the document - add a note about type and type_. - change 0xffffffff into OFP_NO_BUFFER. Signed-off-by: Yoshihiro Kaneko Signed-off-by: FUJITA Tomonori --- ryu/ofproto/ofproto_v1_2_parser.py | 14 +++++++++++--- ryu/ofproto/ofproto_v1_3_parser.py | 12 +++++++++--- 2 files changed, 20 insertions(+), 6 deletions(-) diff --git a/ryu/ofproto/ofproto_v1_2_parser.py b/ryu/ofproto/ofproto_v1_2_parser.py index 04674f3e..5c031809 100644 --- a/ryu/ofproto/ofproto_v1_2_parser.py +++ b/ryu/ofproto/ofproto_v1_2_parser.py @@ -83,6 +83,8 @@ class OFPErrorMsg(MsgBase): data Variable length data depending on the type and code ========== ========================================================= + ``type`` attribute corresponds to ``type_`` parameter of __init__. + Types and codes are defined in ``ryu.ofproto.ofproto_v1_2``. ============================= =========== @@ -758,7 +760,7 @@ class OFPPacketOut(MsgBase): ================ ====================================================== Attribute Description ================ ====================================================== - buffer_id ID assigned by datapath (0xffffffff if none) + buffer_id ID assigned by datapath (OFP_NO_BUFFER if none) in_port Packet's input port or ``OFPP_CONTROLLER`` actions list of OpenFlow action class data Packet data @@ -829,7 +831,7 @@ class OFPFlowMod(MsgBase): idle_timeout Idle time before discarding (seconds) hard_timeout Max time before discarding (seconds) priority Priority level of flow entry - buffer_id Buffered packet to apply to (or 0xffffffff) + buffer_id Buffered packet to apply to (or OFP_NO_BUFFER) out_port For ``OFPFC_DELETE*`` commands, require matching entries to include this as an output port out_group For ``OFPFC_DELETE*`` commands, require matching @@ -852,7 +854,7 @@ class OFPFlowMod(MsgBase): table_id = 0 idle_timeout = hard_timeout = 0 priority = 32768 - buffer_id = 0xffffffff + buffer_id = ofp.OFP_NO_BUFFER match = ofp_parser.OFPMatch(in_port=1, eth_dst='ff:ff:ff:ff:ff:ff') actions = [ofp_parser.OFPActionOutput(ofp.OFPP_NORMAL, 0)] inst = [ofp_parser.OFPInstructionActions(ofp.OFPIT_APPLY_ACTIONS, @@ -1010,6 +1012,8 @@ class OFPInstructionActions(StringifyMixin): OFPIT_CLEAR_ACTIONS actions list of OpenFlow action class ================ ====================================================== + + ``type`` attribute corresponds to ``type_`` parameter of __init__. """ def __init__(self, type_, actions=None, len_=None): super(OFPInstructionActions, self).__init__() @@ -1630,6 +1634,8 @@ class OFPGroupMod(MsgBase): buckets list of ``OFPBucket`` ================ ====================================================== + ``type`` attribute corresponds to ``type_`` parameter of __init__. + Example:: def send_group_mod(self, datapath): @@ -2676,6 +2682,8 @@ class OFPGroupDescStats(StringifyMixin): buckets List of ``OFPBucket`` instance ================ ====================================================== + ``type`` attribute corresponds to ``type_`` parameter of __init__. + Example:: @set_ev_cls(ofp_event.EventOFPStatsReply, MAIN_DISPATCHER) diff --git a/ryu/ofproto/ofproto_v1_3_parser.py b/ryu/ofproto/ofproto_v1_3_parser.py index 721d02c6..71585709 100644 --- a/ryu/ofproto/ofproto_v1_3_parser.py +++ b/ryu/ofproto/ofproto_v1_3_parser.py @@ -155,6 +155,8 @@ class OFPErrorMsg(MsgBase): data Variable length data depending on the type and code ========== ========================================================= + ``type`` attribute corresponds to ``type_`` parameter of __init__. + Types and codes are defined in ``ryu.ofproto.ofproto_v1_3``. ============================= =========== @@ -2200,7 +2202,7 @@ class OFPPacketOut(MsgBase): ================ ====================================================== Attribute Description ================ ====================================================== - buffer_id ID assigned by datapath (0xffffffff if none) + buffer_id ID assigned by datapath (OFP_NO_BUFFER if none) in_port Packet's input port or ``OFPP_CONTROLLER`` actions list of OpenFlow action class data Packet data @@ -2269,7 +2271,7 @@ class OFPFlowMod(MsgBase): idle_timeout Idle time before discarding (seconds) hard_timeout Max time before discarding (seconds) priority Priority level of flow entry - buffer_id Buffered packet to apply to (or 0xffffffff) + buffer_id Buffered packet to apply to (or OFP_NO_BUFFER) out_port For ``OFPFC_DELETE*`` commands, require matching entries to include this as an output port out_group For ``OFPFC_DELETE*`` commands, require matching @@ -2294,7 +2296,7 @@ class OFPFlowMod(MsgBase): table_id = 0 idle_timeout = hard_timeout = 0 priority = 32768 - buffer_id = 0xffffffff + buffer_id = ofp.OFP_NO_BUFFER match = ofp_parser.OFPMatch(in_port=1, eth_dst='ff:ff:ff:ff:ff:ff') actions = [ofp_parser.OFPActionOutput(ofp.OFPP_NORMAL, 0)] inst = [ofp_parser.OFPInstructionActions(ofp.OFPIT_APPLY_ACTIONS, @@ -2452,6 +2454,8 @@ class OFPInstructionActions(StringifyMixin): OFPIT_CLEAR_ACTIONS actions list of OpenFlow action class ================ ====================================================== + + ``type`` attribute corresponds to ``type_`` parameter of __init__. """ def __init__(self, type_, actions=None, len_=None): super(OFPInstructionActions, self).__init__() @@ -3088,6 +3092,8 @@ class OFPGroupMod(MsgBase): buckets list of ``OFPBucket`` ================ ====================================================== + ``type`` attribute corresponds to ``type_`` parameter of __init__. + Example:: def send_group_mod(self, datapath):