doc: update format of pages for ofproto
- add explicit classified layout to ofproto_v1_[23]_ref - put contents of ofproto_ref back to toctree. Signed-off-by: Yoshihiro Kaneko <ykaneko0929@gmail.com> Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
This commit is contained in:
Yoshihiro Kaneko
FUJITA Tomonori
parent
eacabd75c5
commit
62170fba87
@ -27,7 +27,7 @@ from ryu import version as ryu_version
|
|||||||
|
|
||||||
# Add any Sphinx extension module names here, as strings. They can be extensions
|
# Add any Sphinx extension module names here, as strings. They can be extensions
|
||||||
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
|
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
|
||||||
extensions = [ 'sphinx.ext.autodoc', 'sphinx.ext.autosummary' ]
|
extensions = [ 'sphinx.ext.autodoc' ]
|
||||||
|
|
||||||
# Add any paths that contain templates here, relative to this directory.
|
# Add any paths that contain templates here, relative to this directory.
|
||||||
templates_path = ['_templates']
|
templates_path = ['_templates']
|
||||||
|
|||||||
@ -2,471 +2,8 @@
|
|||||||
OpenFlow protocol API Reference
|
OpenFlow protocol API Reference
|
||||||
*******************************
|
*******************************
|
||||||
|
|
||||||
| :ref:`OpenFlow v1.2 Messages and Structures <OpenFlow-v1.2>`
|
.. toctree::
|
||||||
| :ref:`OpenFlow v1.3 Messages and Structures <OpenFlow-v1.3>`
|
:maxdepth: 3
|
||||||
|
|
||||||
.. _OpenFlow-v1.2:
|
|
||||||
|
|
||||||
OpenFlow v1.2 Messages and Structures
|
|
||||||
=====================================
|
|
||||||
.. py:currentmodule:: ryu.ofproto.ofproto_v1_2_parser
|
|
||||||
|
|
||||||
Controller-to-Switch Messages
|
|
||||||
-----------------------------
|
|
||||||
|
|
||||||
Handshake
|
|
||||||
^^^^^^^^^
|
|
||||||
|
|
||||||
.. autosummary::
|
|
||||||
:nosignatures:
|
|
||||||
|
|
||||||
OFPFeaturesRequest
|
|
||||||
OFPSwitchFeatures
|
|
||||||
|
|
||||||
Switch Configuration
|
|
||||||
^^^^^^^^^^^^^^^^^^^^
|
|
||||||
|
|
||||||
.. autosummary::
|
|
||||||
:nosignatures:
|
|
||||||
|
|
||||||
OFPSetConfig
|
|
||||||
OFPGetConfigRequest
|
|
||||||
OFPGetConfigReply
|
|
||||||
|
|
||||||
Flow Table Configuration
|
|
||||||
^^^^^^^^^^^^^^^^^^^^^^^^
|
|
||||||
|
|
||||||
.. autosummary::
|
|
||||||
:nosignatures:
|
|
||||||
|
|
||||||
OFPTableMod
|
|
||||||
|
|
||||||
Modify State Messages
|
|
||||||
^^^^^^^^^^^^^^^^^^^^^
|
|
||||||
|
|
||||||
.. autosummary::
|
|
||||||
:nosignatures:
|
|
||||||
|
|
||||||
OFPFlowMod
|
|
||||||
OFPGroupMod
|
|
||||||
OFPPortMod
|
|
||||||
|
|
||||||
Read State Messages
|
|
||||||
^^^^^^^^^^^^^^^^^^^
|
|
||||||
|
|
||||||
.. autosummary::
|
|
||||||
:nosignatures:
|
|
||||||
|
|
||||||
OFPDescStatsRequest
|
|
||||||
OFPDescStats
|
|
||||||
OFPFlowStatsRequest
|
|
||||||
OFPFlowStats
|
|
||||||
OFPAggregateStatsRequest
|
|
||||||
OFPAggregateStatsReply
|
|
||||||
OFPTableStatsRequest
|
|
||||||
OFPTableStats
|
|
||||||
OFPPortStatsRequest
|
|
||||||
OFPPortStats
|
|
||||||
OFPQueueStatsRequest
|
|
||||||
OFPQueueStats
|
|
||||||
OFPGroupStatsRequest
|
|
||||||
OFPGroupStats
|
|
||||||
OFPGroupDescStatsRequest
|
|
||||||
OFPGroupDescStats
|
|
||||||
OFPGroupFeaturesStatsRequest
|
|
||||||
OFPGroupFeaturesStats
|
|
||||||
|
|
||||||
Queue Configuration Messages
|
|
||||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
|
||||||
|
|
||||||
.. autosummary::
|
|
||||||
:nosignatures:
|
|
||||||
|
|
||||||
OFPQueueGetConfigRequest
|
|
||||||
OFPQueueGetConfigReply
|
|
||||||
|
|
||||||
Packet-Out Message
|
|
||||||
^^^^^^^^^^^^^^^^^^
|
|
||||||
|
|
||||||
.. autosummary::
|
|
||||||
:nosignatures:
|
|
||||||
|
|
||||||
OFPPacketOut
|
|
||||||
|
|
||||||
Barrier Message
|
|
||||||
^^^^^^^^^^^^^^^
|
|
||||||
|
|
||||||
.. autosummary::
|
|
||||||
:nosignatures:
|
|
||||||
|
|
||||||
OFPBarrierRequest
|
|
||||||
OFPBarrierReply
|
|
||||||
|
|
||||||
Role Request Message
|
|
||||||
^^^^^^^^^^^^^^^^^^^^
|
|
||||||
|
|
||||||
.. autosummary::
|
|
||||||
:nosignatures:
|
|
||||||
|
|
||||||
OFPRoleRequest
|
|
||||||
OFPRoleReply
|
|
||||||
|
|
||||||
|
|
||||||
Asynchronous Messages
|
|
||||||
---------------------
|
|
||||||
|
|
||||||
Packet-In Message
|
|
||||||
^^^^^^^^^^^^^^^^^
|
|
||||||
|
|
||||||
.. autosummary::
|
|
||||||
|
|
||||||
OFPPacketIn
|
|
||||||
|
|
||||||
Flow Removed Message
|
|
||||||
^^^^^^^^^^^^^^^^^^^^
|
|
||||||
|
|
||||||
.. autosummary::
|
|
||||||
|
|
||||||
OFPFlowRemoved
|
|
||||||
|
|
||||||
Port Status Message
|
|
||||||
^^^^^^^^^^^^^^^^^^^
|
|
||||||
|
|
||||||
.. autosummary::
|
|
||||||
:nosignatures:
|
|
||||||
|
|
||||||
OFPPortStatus
|
|
||||||
|
|
||||||
Error Message
|
|
||||||
^^^^^^^^^^^^^
|
|
||||||
|
|
||||||
.. autosummary::
|
|
||||||
:nosignatures:
|
|
||||||
|
|
||||||
OFPErrorMsg
|
|
||||||
|
|
||||||
|
|
||||||
Symmetric Messages
|
|
||||||
------------------
|
|
||||||
|
|
||||||
Hello
|
|
||||||
^^^^^
|
|
||||||
|
|
||||||
.. autosummary::
|
|
||||||
:nosignatures:
|
|
||||||
|
|
||||||
OFPHello
|
|
||||||
|
|
||||||
Echo Request
|
|
||||||
^^^^^^^^^^^^
|
|
||||||
|
|
||||||
.. autosummary::
|
|
||||||
:nosignatures:
|
|
||||||
|
|
||||||
OFPEchoRequest
|
|
||||||
|
|
||||||
Echo Reply
|
|
||||||
^^^^^^^^^^
|
|
||||||
|
|
||||||
.. autosummary::
|
|
||||||
:nosignatures:
|
|
||||||
|
|
||||||
OFPEchoReply
|
|
||||||
|
|
||||||
Experimenter
|
|
||||||
^^^^^^^^^^^^
|
|
||||||
.. autosummary::
|
|
||||||
:nosignatures:
|
|
||||||
|
|
||||||
OFPExperimenter
|
|
||||||
|
|
||||||
|
|
||||||
Flow Match Structure
|
|
||||||
--------------------
|
|
||||||
|
|
||||||
.. autosummary::
|
|
||||||
:nosignatures:
|
|
||||||
|
|
||||||
OFPMatch
|
|
||||||
|
|
||||||
|
|
||||||
Flow Instruction Structures
|
|
||||||
---------------------------
|
|
||||||
|
|
||||||
.. autosummary::
|
|
||||||
:nosignatures:
|
|
||||||
|
|
||||||
OFPInstructionGotoTable
|
|
||||||
OFPInstructionWriteMetadata
|
|
||||||
OFPInstructionActions
|
|
||||||
|
|
||||||
|
|
||||||
Action Structures
|
|
||||||
-----------------
|
|
||||||
|
|
||||||
.. autosummary::
|
|
||||||
:nosignatures:
|
|
||||||
|
|
||||||
OFPActionOutput
|
|
||||||
OFPActionGroup
|
|
||||||
OFPActionSetQueue
|
|
||||||
OFPActionSetMplsTtl
|
|
||||||
OFPActionDecMplsTtl
|
|
||||||
OFPActionSetNwTtl
|
|
||||||
OFPActionDecNwTtl
|
|
||||||
OFPActionCopyTtlOut
|
|
||||||
OFPActionCopyTtlIn
|
|
||||||
OFPActionPushVlan
|
|
||||||
OFPActionPushMpls
|
|
||||||
OFPActionPopVlan
|
|
||||||
OFPActionPopMpls
|
|
||||||
OFPActionSetField
|
|
||||||
OFPActionExperimenter
|
|
||||||
|
|
||||||
|
|
||||||
.. _OpenFlow-v1.3:
|
|
||||||
|
|
||||||
OpenFlow v1.3 Messages and Structures
|
|
||||||
=====================================
|
|
||||||
.. py:currentmodule:: ryu.ofproto.ofproto_v1_3_parser
|
|
||||||
|
|
||||||
Controller-to-Switch Messages
|
|
||||||
-----------------------------
|
|
||||||
|
|
||||||
Handshake
|
|
||||||
^^^^^^^^^
|
|
||||||
|
|
||||||
.. autosummary::
|
|
||||||
:nosignatures:
|
|
||||||
|
|
||||||
OFPFeaturesRequest
|
|
||||||
OFPSwitchFeatures
|
|
||||||
|
|
||||||
Switch Configuration
|
|
||||||
^^^^^^^^^^^^^^^^^^^^
|
|
||||||
|
|
||||||
.. autosummary::
|
|
||||||
:nosignatures:
|
|
||||||
|
|
||||||
OFPSetConfig
|
|
||||||
OFPGetConfigRequest
|
|
||||||
OFPGetConfigReply
|
|
||||||
|
|
||||||
Flow Table Configuration
|
|
||||||
^^^^^^^^^^^^^^^^^^^^^^^^
|
|
||||||
|
|
||||||
.. autosummary::
|
|
||||||
:nosignatures:
|
|
||||||
|
|
||||||
OFPTableMod
|
|
||||||
|
|
||||||
Modify State Messages
|
|
||||||
^^^^^^^^^^^^^^^^^^^^^
|
|
||||||
|
|
||||||
.. autosummary::
|
|
||||||
:nosignatures:
|
|
||||||
|
|
||||||
OFPFlowMod
|
|
||||||
OFPGroupMod
|
|
||||||
OFPPortMod
|
|
||||||
OFPMeterMod
|
|
||||||
|
|
||||||
Multipart Messages
|
|
||||||
^^^^^^^^^^^^^^^^^^
|
|
||||||
|
|
||||||
.. autosummary::
|
|
||||||
:nosignatures:
|
|
||||||
|
|
||||||
OFPDescStatsRequest
|
|
||||||
OFPDescStatsReply
|
|
||||||
OFPFlowStatsRequest
|
|
||||||
OFPFlowStatsReply
|
|
||||||
OFPAggregateStatsRequest
|
|
||||||
OFPAggregateStatsReply
|
|
||||||
OFPTableStatsRequest
|
|
||||||
OFPTableStatsReply
|
|
||||||
OFPPortStatsRequest
|
|
||||||
OFPPortStatsReply
|
|
||||||
OFPPortDescStatsRequest
|
|
||||||
OFPPortDescStatsReply
|
|
||||||
OFPQueueStatsRequest
|
|
||||||
OFPQueueStatsReply
|
|
||||||
OFPGroupStatsRequest
|
|
||||||
OFPGroupStatsReply
|
|
||||||
OFPGroupDescStatsRequest
|
|
||||||
OFPGroupDescStatsReply
|
|
||||||
OFPGroupFeaturesStatsRequest
|
|
||||||
OFPGroupFeaturesStatsReply
|
|
||||||
OFPMeterStatsRequest
|
|
||||||
OFPMeterStatsReply
|
|
||||||
OFPMeterConfigStatsRequest
|
|
||||||
OFPMeterConfigStatsReply
|
|
||||||
OFPMeterFeaturesStatsRequest
|
|
||||||
OFPMeterFeaturesStatsReply
|
|
||||||
|
|
||||||
Queue Configuration Messages
|
|
||||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
|
||||||
|
|
||||||
.. autosummary::
|
|
||||||
:nosignatures:
|
|
||||||
|
|
||||||
OFPQueueGetConfigRequest
|
|
||||||
OFPQueueGetConfigReply
|
|
||||||
|
|
||||||
Packet-Out Message
|
|
||||||
^^^^^^^^^^^^^^^^^^
|
|
||||||
|
|
||||||
.. autosummary::
|
|
||||||
:nosignatures:
|
|
||||||
|
|
||||||
OFPPacketOut
|
|
||||||
|
|
||||||
Barrier Message
|
|
||||||
^^^^^^^^^^^^^^^
|
|
||||||
|
|
||||||
.. autosummary::
|
|
||||||
:nosignatures:
|
|
||||||
|
|
||||||
OFPBarrierRequest
|
|
||||||
OFPBarrierReply
|
|
||||||
|
|
||||||
Role Request Message
|
|
||||||
^^^^^^^^^^^^^^^^^^^^
|
|
||||||
|
|
||||||
.. autosummary::
|
|
||||||
:nosignatures:
|
|
||||||
|
|
||||||
OFPRoleRequest
|
|
||||||
OFPRoleReply
|
|
||||||
|
|
||||||
Set Asynchronous Configuration Message
|
|
||||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
|
||||||
|
|
||||||
.. autosummary::
|
|
||||||
:nosignatures:
|
|
||||||
|
|
||||||
OFPSetAsync
|
|
||||||
OFPGetAsyncRequest
|
|
||||||
OFPGetAsyncReply
|
|
||||||
|
|
||||||
|
|
||||||
Asynchronous Messages
|
|
||||||
---------------------
|
|
||||||
|
|
||||||
.. autosummary::
|
|
||||||
:nosignatures:
|
|
||||||
|
|
||||||
|
|
||||||
Packet-In Message
|
|
||||||
^^^^^^^^^^^^^^^^^
|
|
||||||
|
|
||||||
.. autosummary::
|
|
||||||
:nosignatures:
|
|
||||||
|
|
||||||
OFPPacketIn
|
|
||||||
|
|
||||||
Flow Removed Message
|
|
||||||
^^^^^^^^^^^^^^^^^^^^
|
|
||||||
|
|
||||||
.. autosummary::
|
|
||||||
:nosignatures:
|
|
||||||
|
|
||||||
OFPFlowRemoved
|
|
||||||
|
|
||||||
Port Status Message
|
|
||||||
^^^^^^^^^^^^^^^^^^^
|
|
||||||
|
|
||||||
.. autosummary::
|
|
||||||
:nosignatures:
|
|
||||||
|
|
||||||
OFPPortStatus
|
|
||||||
|
|
||||||
Error Message
|
|
||||||
^^^^^^^^^^^^^
|
|
||||||
|
|
||||||
.. autosummary::
|
|
||||||
:nosignatures:
|
|
||||||
|
|
||||||
OFPErrorMsg
|
|
||||||
|
|
||||||
|
|
||||||
Symmetric Messages
|
|
||||||
------------------
|
|
||||||
|
|
||||||
Hello
|
|
||||||
^^^^^
|
|
||||||
|
|
||||||
.. autosummary::
|
|
||||||
:nosignatures:
|
|
||||||
|
|
||||||
OFPHello
|
|
||||||
OFPHelloElemVersionBitmap
|
|
||||||
|
|
||||||
Echo Request
|
|
||||||
^^^^^^^^^^^^
|
|
||||||
|
|
||||||
.. autosummary::
|
|
||||||
:nosignatures:
|
|
||||||
|
|
||||||
OFPEchoRequest
|
|
||||||
|
|
||||||
Echo Reply
|
|
||||||
^^^^^^^^^^
|
|
||||||
|
|
||||||
.. autosummary::
|
|
||||||
:nosignatures:
|
|
||||||
|
|
||||||
OFPEchoReply
|
|
||||||
|
|
||||||
Experimenter
|
|
||||||
^^^^^^^^^^^^
|
|
||||||
|
|
||||||
.. autosummary::
|
|
||||||
:nosignatures:
|
|
||||||
|
|
||||||
OFPExperimenter
|
|
||||||
|
|
||||||
|
|
||||||
Flow Match Structure
|
|
||||||
--------------------
|
|
||||||
|
|
||||||
.. autosummary::
|
|
||||||
:nosignatures:
|
|
||||||
|
|
||||||
OFPMatch
|
|
||||||
|
|
||||||
|
|
||||||
Flow Instruction Structures
|
|
||||||
---------------------------
|
|
||||||
|
|
||||||
.. autosummary::
|
|
||||||
:nosignatures:
|
|
||||||
|
|
||||||
OFPInstructionGotoTable
|
|
||||||
OFPInstructionWriteMetadata
|
|
||||||
OFPInstructionActions
|
|
||||||
OFPInstructionMeter
|
|
||||||
|
|
||||||
|
|
||||||
Action Structures
|
|
||||||
-----------------
|
|
||||||
|
|
||||||
.. autosummary::
|
|
||||||
:nosignatures:
|
|
||||||
|
|
||||||
OFPActionOutput
|
|
||||||
OFPActionGroup
|
|
||||||
OFPActionSetQueue
|
|
||||||
OFPActionSetMplsTtl
|
|
||||||
OFPActionDecMplsTtl
|
|
||||||
OFPActionSetNwTtl
|
|
||||||
OFPActionDecNwTtl
|
|
||||||
OFPActionCopyTtlOut
|
|
||||||
OFPActionCopyTtlIn
|
|
||||||
OFPActionPushVlan
|
|
||||||
OFPActionPushMpls
|
|
||||||
OFPActionPopVlan
|
|
||||||
OFPActionPopMpls
|
|
||||||
OFPActionSetField
|
|
||||||
OFPActionExperimenter
|
|
||||||
|
|
||||||
|
ofproto_v1_2_ref.rst
|
||||||
|
ofproto_v1_3_ref.rst
|
||||||
|
|||||||
160
doc/source/ofproto_v1_2_ref.rst
Normal file
160
doc/source/ofproto_v1_2_ref.rst
Normal file
@ -0,0 +1,160 @@
|
|||||||
|
*************************************
|
||||||
|
OpenFlow v1.2 Messages and Structures
|
||||||
|
*************************************
|
||||||
|
|
||||||
|
.. py:currentmodule:: ryu.ofproto.ofproto_v1_2_parser
|
||||||
|
|
||||||
|
Controller-to-Switch Messages
|
||||||
|
=============================
|
||||||
|
|
||||||
|
Handshake
|
||||||
|
---------
|
||||||
|
|
||||||
|
.. autoclass:: OFPFeaturesRequest
|
||||||
|
.. autoclass:: OFPSwitchFeatures
|
||||||
|
|
||||||
|
Switch Configuration
|
||||||
|
--------------------
|
||||||
|
|
||||||
|
.. autoclass:: OFPSetConfig
|
||||||
|
.. autoclass:: OFPGetConfigRequest
|
||||||
|
.. autoclass:: OFPGetConfigReply
|
||||||
|
|
||||||
|
Flow Table Configuration
|
||||||
|
------------------------
|
||||||
|
|
||||||
|
.. autoclass:: OFPTableMod
|
||||||
|
|
||||||
|
Modify State Messages
|
||||||
|
---------------------
|
||||||
|
|
||||||
|
.. autoclass:: OFPFlowMod
|
||||||
|
.. autoclass:: OFPGroupMod
|
||||||
|
.. autoclass:: OFPPortMod
|
||||||
|
|
||||||
|
Read State Messages
|
||||||
|
-------------------
|
||||||
|
|
||||||
|
.. autoclass:: OFPDescStatsRequest
|
||||||
|
.. autoclass:: OFPDescStats
|
||||||
|
.. autoclass:: OFPFlowStatsRequest
|
||||||
|
.. autoclass:: OFPFlowStats
|
||||||
|
.. autoclass:: OFPAggregateStatsRequest
|
||||||
|
.. autoclass:: OFPAggregateStatsReply
|
||||||
|
.. autoclass:: OFPTableStatsRequest
|
||||||
|
.. autoclass:: OFPTableStats
|
||||||
|
.. autoclass:: OFPPortStatsRequest
|
||||||
|
.. autoclass:: OFPPortStats
|
||||||
|
.. autoclass:: OFPQueueStatsRequest
|
||||||
|
.. autoclass:: OFPQueueStats
|
||||||
|
.. autoclass:: OFPGroupStatsRequest
|
||||||
|
.. autoclass:: OFPGroupStats
|
||||||
|
.. autoclass:: OFPGroupDescStatsRequest
|
||||||
|
.. autoclass:: OFPGroupDescStats
|
||||||
|
.. autoclass:: OFPGroupFeaturesStatsRequest
|
||||||
|
.. autoclass:: OFPGroupFeaturesStats
|
||||||
|
|
||||||
|
Queue Configuration Messages
|
||||||
|
----------------------------
|
||||||
|
|
||||||
|
.. autoclass:: OFPQueueGetConfigRequest
|
||||||
|
.. autoclass:: OFPQueueGetConfigReply
|
||||||
|
|
||||||
|
Packet-Out Message
|
||||||
|
------------------
|
||||||
|
|
||||||
|
.. autoclass:: OFPPacketOut
|
||||||
|
|
||||||
|
Barrier Message
|
||||||
|
---------------
|
||||||
|
|
||||||
|
.. autoclass:: OFPBarrierRequest
|
||||||
|
.. autoclass:: OFPBarrierReply
|
||||||
|
|
||||||
|
Role Request Message
|
||||||
|
--------------------
|
||||||
|
|
||||||
|
.. autoclass:: OFPRoleRequest
|
||||||
|
.. autoclass:: OFPRoleReply
|
||||||
|
|
||||||
|
|
||||||
|
Asynchronous Messages
|
||||||
|
=====================
|
||||||
|
|
||||||
|
Packet-In Message
|
||||||
|
-----------------
|
||||||
|
|
||||||
|
.. autoclass:: OFPPacketIn
|
||||||
|
|
||||||
|
Flow Removed Message
|
||||||
|
--------------------
|
||||||
|
|
||||||
|
.. autoclass:: OFPFlowRemoved
|
||||||
|
|
||||||
|
Port Status Message
|
||||||
|
-------------------
|
||||||
|
|
||||||
|
.. autoclass:: OFPPortStatus
|
||||||
|
|
||||||
|
Error Message
|
||||||
|
-------------
|
||||||
|
|
||||||
|
.. autoclass:: OFPErrorMsg
|
||||||
|
|
||||||
|
|
||||||
|
Symmetric Messages
|
||||||
|
==================
|
||||||
|
|
||||||
|
Hello
|
||||||
|
-----
|
||||||
|
|
||||||
|
.. autoclass:: OFPHello
|
||||||
|
|
||||||
|
Echo Request
|
||||||
|
------------
|
||||||
|
|
||||||
|
.. autoclass:: OFPEchoRequest
|
||||||
|
|
||||||
|
Echo Reply
|
||||||
|
----------
|
||||||
|
|
||||||
|
.. autoclass:: OFPEchoReply
|
||||||
|
|
||||||
|
Experimenter
|
||||||
|
------------
|
||||||
|
|
||||||
|
.. autoclass:: OFPExperimenter
|
||||||
|
|
||||||
|
|
||||||
|
Flow Match Structure
|
||||||
|
====================
|
||||||
|
|
||||||
|
.. autoclass:: OFPMatch
|
||||||
|
|
||||||
|
|
||||||
|
Flow Instruction Structures
|
||||||
|
===========================
|
||||||
|
|
||||||
|
.. autoclass:: OFPInstructionGotoTable
|
||||||
|
.. autoclass:: OFPInstructionWriteMetadata
|
||||||
|
.. autoclass:: OFPInstructionActions
|
||||||
|
|
||||||
|
|
||||||
|
Action Structures
|
||||||
|
=================
|
||||||
|
|
||||||
|
.. autoclass:: OFPActionOutput
|
||||||
|
.. autoclass:: OFPActionGroup
|
||||||
|
.. autoclass:: OFPActionSetQueue
|
||||||
|
.. autoclass:: OFPActionSetMplsTtl
|
||||||
|
.. autoclass:: OFPActionDecMplsTtl
|
||||||
|
.. autoclass:: OFPActionSetNwTtl
|
||||||
|
.. autoclass:: OFPActionDecNwTtl
|
||||||
|
.. autoclass:: OFPActionCopyTtlOut
|
||||||
|
.. autoclass:: OFPActionCopyTtlIn
|
||||||
|
.. autoclass:: OFPActionPushVlan
|
||||||
|
.. autoclass:: OFPActionPushMpls
|
||||||
|
.. autoclass:: OFPActionPopVlan
|
||||||
|
.. autoclass:: OFPActionPopMpls
|
||||||
|
.. autoclass:: OFPActionSetField
|
||||||
|
.. autoclass:: OFPActionExperimenter
|
||||||
178
doc/source/ofproto_v1_3_ref.rst
Normal file
178
doc/source/ofproto_v1_3_ref.rst
Normal file
@ -0,0 +1,178 @@
|
|||||||
|
*************************************
|
||||||
|
OpenFlow v1.3 Messages and Structures
|
||||||
|
*************************************
|
||||||
|
|
||||||
|
.. py:currentmodule:: ryu.ofproto.ofproto_v1_3_parser
|
||||||
|
|
||||||
|
Controller-to-Switch Messages
|
||||||
|
=============================
|
||||||
|
|
||||||
|
Handshake
|
||||||
|
---------
|
||||||
|
|
||||||
|
.. autoclass:: OFPFeaturesRequest
|
||||||
|
.. autoclass:: OFPSwitchFeatures
|
||||||
|
|
||||||
|
Switch Configuration
|
||||||
|
--------------------
|
||||||
|
|
||||||
|
.. autoclass:: OFPSetConfig
|
||||||
|
.. autoclass:: OFPGetConfigRequest
|
||||||
|
.. autoclass:: OFPGetConfigReply
|
||||||
|
|
||||||
|
Flow Table Configuration
|
||||||
|
------------------------
|
||||||
|
|
||||||
|
.. autoclass:: OFPTableMod
|
||||||
|
|
||||||
|
Modify State Messages
|
||||||
|
---------------------
|
||||||
|
|
||||||
|
.. autoclass:: OFPFlowMod
|
||||||
|
.. autoclass:: OFPGroupMod
|
||||||
|
.. autoclass:: OFPPortMod
|
||||||
|
.. autoclass:: OFPMeterMod
|
||||||
|
|
||||||
|
Multipart Messages
|
||||||
|
------------------
|
||||||
|
|
||||||
|
.. autoclass:: OFPDescStatsRequest
|
||||||
|
.. autoclass:: OFPDescStatsReply
|
||||||
|
.. autoclass:: OFPFlowStatsRequest
|
||||||
|
.. autoclass:: OFPFlowStatsReply
|
||||||
|
.. autoclass:: OFPAggregateStatsRequest
|
||||||
|
.. autoclass:: OFPAggregateStatsReply
|
||||||
|
.. autoclass:: OFPTableStatsRequest
|
||||||
|
.. autoclass:: OFPTableStatsReply
|
||||||
|
.. autoclass:: OFPPortStatsRequest
|
||||||
|
.. autoclass:: OFPPortStatsReply
|
||||||
|
.. autoclass:: OFPPortDescStatsRequest
|
||||||
|
.. autoclass:: OFPPortDescStatsReply
|
||||||
|
.. autoclass:: OFPQueueStatsRequest
|
||||||
|
.. autoclass:: OFPQueueStatsReply
|
||||||
|
.. autoclass:: OFPGroupStatsRequest
|
||||||
|
.. autoclass:: OFPGroupStatsReply
|
||||||
|
.. autoclass:: OFPGroupDescStatsRequest
|
||||||
|
.. autoclass:: OFPGroupDescStatsReply
|
||||||
|
.. autoclass:: OFPGroupFeaturesStatsRequest
|
||||||
|
.. autoclass:: OFPGroupFeaturesStatsReply
|
||||||
|
.. autoclass:: OFPMeterStatsRequest
|
||||||
|
.. autoclass:: OFPMeterStatsReply
|
||||||
|
.. autoclass:: OFPMeterConfigStatsRequest
|
||||||
|
.. autoclass:: OFPMeterConfigStatsReply
|
||||||
|
.. autoclass:: OFPMeterFeaturesStatsRequest
|
||||||
|
.. autoclass:: OFPMeterFeaturesStatsReply
|
||||||
|
|
||||||
|
Queue Configuration Messages
|
||||||
|
----------------------------
|
||||||
|
|
||||||
|
.. autoclass:: OFPQueueGetConfigRequest
|
||||||
|
.. autoclass:: OFPQueueGetConfigReply
|
||||||
|
|
||||||
|
Packet-Out Message
|
||||||
|
------------------
|
||||||
|
|
||||||
|
.. autoclass:: OFPPacketOut
|
||||||
|
|
||||||
|
Barrier Message
|
||||||
|
---------------
|
||||||
|
|
||||||
|
.. autoclass:: OFPBarrierRequest
|
||||||
|
.. autoclass:: OFPBarrierReply
|
||||||
|
|
||||||
|
Role Request Message
|
||||||
|
--------------------
|
||||||
|
|
||||||
|
.. autoclass:: OFPRoleRequest
|
||||||
|
.. autoclass:: OFPRoleReply
|
||||||
|
|
||||||
|
Set Asynchronous Configuration Message
|
||||||
|
--------------------------------------
|
||||||
|
|
||||||
|
.. autoclass:: OFPSetAsync
|
||||||
|
.. autoclass:: OFPGetAsyncRequest
|
||||||
|
.. autoclass:: OFPGetAsyncReply
|
||||||
|
|
||||||
|
|
||||||
|
Asynchronous Messages
|
||||||
|
=====================
|
||||||
|
|
||||||
|
Packet-In Message
|
||||||
|
-----------------
|
||||||
|
|
||||||
|
.. autoclass:: OFPPacketIn
|
||||||
|
|
||||||
|
Flow Removed Message
|
||||||
|
--------------------
|
||||||
|
|
||||||
|
.. autoclass:: OFPFlowRemoved
|
||||||
|
|
||||||
|
Port Status Message
|
||||||
|
-------------------
|
||||||
|
|
||||||
|
.. autoclass:: OFPPortStatus
|
||||||
|
|
||||||
|
Error Message
|
||||||
|
-------------
|
||||||
|
|
||||||
|
.. autoclass:: OFPErrorMsg
|
||||||
|
|
||||||
|
|
||||||
|
Symmetric Messages
|
||||||
|
==================
|
||||||
|
|
||||||
|
Hello
|
||||||
|
-----
|
||||||
|
|
||||||
|
.. autoclass:: OFPHello
|
||||||
|
.. autoclass:: OFPHelloElemVersionBitmap
|
||||||
|
|
||||||
|
Echo Request
|
||||||
|
------------
|
||||||
|
|
||||||
|
.. autoclass:: OFPEchoRequest
|
||||||
|
|
||||||
|
Echo Reply
|
||||||
|
----------
|
||||||
|
|
||||||
|
.. autoclass:: OFPEchoReply
|
||||||
|
|
||||||
|
Experimenter
|
||||||
|
------------
|
||||||
|
|
||||||
|
.. autoclass:: OFPExperimenter
|
||||||
|
|
||||||
|
|
||||||
|
Flow Match Structure
|
||||||
|
====================
|
||||||
|
|
||||||
|
.. autoclass:: OFPMatch
|
||||||
|
|
||||||
|
|
||||||
|
Flow Instruction Structures
|
||||||
|
===========================
|
||||||
|
|
||||||
|
.. autoclass:: OFPInstructionGotoTable
|
||||||
|
.. autoclass:: OFPInstructionWriteMetadata
|
||||||
|
.. autoclass:: OFPInstructionActions
|
||||||
|
.. autoclass:: OFPInstructionMeter
|
||||||
|
|
||||||
|
|
||||||
|
Action Structures
|
||||||
|
=================
|
||||||
|
|
||||||
|
.. autoclass:: OFPActionOutput
|
||||||
|
.. autoclass:: OFPActionGroup
|
||||||
|
.. autoclass:: OFPActionSetQueue
|
||||||
|
.. autoclass:: OFPActionSetMplsTtl
|
||||||
|
.. autoclass:: OFPActionDecMplsTtl
|
||||||
|
.. autoclass:: OFPActionSetNwTtl
|
||||||
|
.. autoclass:: OFPActionDecNwTtl
|
||||||
|
.. autoclass:: OFPActionCopyTtlOut
|
||||||
|
.. autoclass:: OFPActionCopyTtlIn
|
||||||
|
.. autoclass:: OFPActionPushVlan
|
||||||
|
.. autoclass:: OFPActionPushMpls
|
||||||
|
.. autoclass:: OFPActionPopVlan
|
||||||
|
.. autoclass:: OFPActionPopMpls
|
||||||
|
.. autoclass:: OFPActionSetField
|
||||||
|
.. autoclass:: OFPActionExperimenter
|
||||||
Loading…
x
Reference in New Issue
Block a user