summaryrefslogtreecommitdiffhomepage
path: root/doc/source/ofproto_v1_3_ref.rst
diff options
context:
space:
mode:
authorYoshihiro Kaneko <ykaneko0929@gmail.com>2013-09-03 12:12:56 +0900
committerFUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>2013-09-03 13:59:13 +0900
commit62170fba87eb53bb4bcebe48097f7aaf72c62fbf (patch)
tree7cb92ee206d767501b4898019ab469af4aab78b7 /doc/source/ofproto_v1_3_ref.rst
parenteacabd75c59c2f2c20fb84e66c2800abe1347a6b (diff)
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>
Diffstat (limited to 'doc/source/ofproto_v1_3_ref.rst')
-rw-r--r--doc/source/ofproto_v1_3_ref.rst178
1 files changed, 178 insertions, 0 deletions
diff --git a/doc/source/ofproto_v1_3_ref.rst b/doc/source/ofproto_v1_3_ref.rst
new file mode 100644
index 00000000..3e1a5139
--- /dev/null
+++ b/doc/source/ofproto_v1_3_ref.rst
@@ -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