diff options
author | Shinpei Muraoka <shinpei.muraoka@gmail.com> | 2017-04-07 15:19:21 +0900 |
---|---|---|
committer | FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp> | 2017-05-09 10:20:16 +0900 |
commit | 077eef801e7ed6f32abdf2e42dbff21620589cfc (patch) | |
tree | b17878213953591b69da5a92209d8d2dd0a1314e /doc/source/library_packet_ref.rst | |
parent | 99e7cc4074bffe0298c9852e2fc957e883bf3938 (diff) |
library_packet_ref: Separate ref into each protocol
To keep readablity if include all class into library reference, this
patch separates library_packet_ref.rst into each protocol.
Signed-off-by: Shinpei Muraoka <shinpei.muraoka@gmail.com>
Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
Diffstat (limited to 'doc/source/library_packet_ref.rst')
-rw-r--r-- | doc/source/library_packet_ref.rst | 174 |
1 files changed, 7 insertions, 167 deletions
diff --git a/doc/source/library_packet_ref.rst b/doc/source/library_packet_ref.rst index 48a5fc68..7c9b5625 100644 --- a/doc/source/library_packet_ref.rst +++ b/doc/source/library_packet_ref.rst @@ -14,175 +14,15 @@ Stream Parser class .. automodule:: ryu.lib.packet.stream_parser :members: -.. autoclass:: ryu.lib.packet.bgp.StreamParser - :members: +List of the sub-classes: + +- :py:mod:`ryu.lib.packet.bgp.StreamParser` Protocol Header classes ======================= -.. automodule:: ryu.lib.packet.packet_base - :members: - -.. automodule:: ryu.lib.packet.ethernet - :members: - -.. autoclass:: ryu.lib.packet.lldp.lldp - :members: - -.. automodule:: ryu.lib.packet.vlan - :members: - -.. automodule:: ryu.lib.packet.pbb - :members: - -.. automodule:: ryu.lib.packet.mpls - :members: - -.. automodule:: ryu.lib.packet.arp - :members: - -.. automodule:: ryu.lib.packet.ipv4 - :members: - -.. automodule:: ryu.lib.packet.icmp - :members: - -.. automodule:: ryu.lib.packet.ipv6 - :members: - -.. automodule:: ryu.lib.packet.icmpv6 - :members: - -.. automodule:: ryu.lib.packet.vxlan - :members: - -.. automodule:: ryu.lib.packet.geneve - :members: - -.. automodule:: ryu.lib.packet.gre - :members: - -.. automodule:: ryu.lib.packet.cfm - :members: - -.. automodule:: ryu.lib.packet.tcp - :members: - -.. automodule:: ryu.lib.packet.udp - :members: - -.. automodule:: ryu.lib.packet.dhcp - :members: - -.. autoclass:: ryu.lib.packet.dhcp6.dhcp6 - :members: -.. autoclass:: ryu.lib.packet.dhcp6.options - :members: -.. autoclass:: ryu.lib.packet.dhcp6.option - :members: - -.. autoclass:: ryu.lib.packet.vrrp.vrrp - :members: -.. autoclass:: ryu.lib.packet.vrrp.vrrpv2 - :members: -.. autoclass:: ryu.lib.packet.vrrp.vrrpv3 - :members: - -.. autoclass:: ryu.lib.packet.slow.slow - :members: -.. autoclass:: ryu.lib.packet.slow.lacp - :members: - -.. autoclass:: ryu.lib.packet.llc.llc - :members: -.. autoclass:: ryu.lib.packet.llc.ControlFormatI - :members: -.. autoclass:: ryu.lib.packet.llc.ControlFormatS - :members: -.. autoclass:: ryu.lib.packet.llc.ControlFormatU - :members: - -.. autoclass:: ryu.lib.packet.bpdu.bpdu - :members: -.. autoclass:: ryu.lib.packet.bpdu.ConfigurationBPDUs - :members: -.. autoclass:: ryu.lib.packet.bpdu.TopologyChangeNotificationBPDUs - :members: -.. autoclass:: ryu.lib.packet.bpdu.RstBPDUs - :members: - -.. autoclass:: ryu.lib.packet.igmp.igmp - :members: -.. autoclass:: ryu.lib.packet.igmp.igmpv3_query - :members: -.. autoclass:: ryu.lib.packet.igmp.igmpv3_report - :members: -.. autoclass:: ryu.lib.packet.igmp.igmpv3_report_group - :members: - -.. autoclass:: ryu.lib.packet.bgp.BGPMessage - :members: -.. autoclass:: ryu.lib.packet.bgp.BGPOpen - :members: -.. autoclass:: ryu.lib.packet.bgp.BGPUpdate - :members: -.. autoclass:: ryu.lib.packet.bgp.BGPKeepAlive - :members: -.. autoclass:: ryu.lib.packet.bgp.BGPNotification - :members: - -.. autoclass:: ryu.lib.packet.bgp.EvpnEsi - :members: -.. autoclass:: ryu.lib.packet.bgp.EvpnArbitraryEsi - :members: -.. autoclass:: ryu.lib.packet.bgp.EvpnLACPEsi - :members: -.. autoclass:: ryu.lib.packet.bgp.EvpnL2BridgeEsi - :members: -.. autoclass:: ryu.lib.packet.bgp.EvpnMacBasedEsi - :members: -.. autoclass:: ryu.lib.packet.bgp.EvpnRouterIDEsi - :members: -.. autoclass:: ryu.lib.packet.bgp.EvpnASBasedEsi - :members: - -.. autoclass:: ryu.lib.packet.bgp.FlowSpecIPv4NLRI - :members: -.. autoclass:: ryu.lib.packet.bgp.FlowSpecVPNv4NLRI - :members: -.. autoclass:: ryu.lib.packet.bgp.BGPFlowSpecTrafficRateCommunity - :members: -.. autoclass:: ryu.lib.packet.bgp.BGPFlowSpecTrafficActionCommunity - :members: -.. autoclass:: ryu.lib.packet.bgp.BGPFlowSpecRedirectCommunity - :members: -.. autoclass:: ryu.lib.packet.bgp.BGPFlowSpecTrafficMarkingCommunity - :members: - - -.. automodule:: ryu.lib.packet.bmp - :members: - -.. autoclass:: ryu.lib.packet.bfd.bfd - :members: -.. autoclass:: ryu.lib.packet.bfd.SimplePassword - :members: -.. autoclass:: ryu.lib.packet.bfd.KeyedMD5 - :members: -.. autoclass:: ryu.lib.packet.bfd.MeticulousKeyedMD5 - :members: -.. autoclass:: ryu.lib.packet.bfd.KeyedSHA1 - :members: -.. autoclass:: ryu.lib.packet.bfd.MeticulousKeyedSHA1 - :members: - -.. automodule:: ryu.lib.packet.openflow - :members: - -.. autoclass:: ryu.lib.packet.ospf.OSPFMessage - :members: - -.. automodule:: ryu.lib.packet.sctp - :members: +.. toctree:: + :glob: -.. autoclass:: ryu.lib.packet.zebra.ZebraMessage + library_packet_ref/packet_base + library_packet_ref/*
\ No newline at end of file |