Signed-off-by: FUJITA Tomonori <[email protected]>
---
doc/source/index.rst | 1 +
doc/source/library.rst | 10 +++++
doc/source/library_packet.rst | 91 +++++++++++++++++++++++++++++++++++++++++
3 files changed, 102 insertions(+), 0 deletions(-)
create mode 100644 doc/source/library.rst
create mode 100644 doc/source/library_packet.rst
diff --git a/doc/source/index.rst b/doc/source/index.rst
index aab048c..f434e73 100644
--- a/doc/source/index.rst
+++ b/doc/source/index.rst
@@ -18,6 +18,7 @@ Contents:
using_with_openstack.rst
step_by_step.rst
how_l2_segregation_works.rst
+ library.rst
Indices and tables
==================
diff --git a/doc/source/library.rst b/doc/source/library.rst
new file mode 100644
index 0000000..6b084c3
--- /dev/null
+++ b/doc/source/library.rst
@@ -0,0 +1,10 @@
+*******
+Library
+*******
+
+Ryu provides some useful library for your network applications.
+
+.. toctree::
+ :maxdepth: 1
+
+ library_packet.rst
diff --git a/doc/source/library_packet.rst b/doc/source/library_packet.rst
new file mode 100644
index 0000000..8ca0e29
--- /dev/null
+++ b/doc/source/library_packet.rst
@@ -0,0 +1,91 @@
+**************
+Packet library
+**************
+
+Introduction
+============
+
+Ryu packet library helps you to parse and build various protocol
+packets. dpkt is the popular library for the same purpose, however it
+is not designed to handle protocols that are interleaved; vlan, mpls,
+gre, etc. So we implemented our own packet library.
+
+Parsing Packet
+==============
+
+First, let's look at how we can use the library to parse the received
+packets in a handler for OFPPacketIn messages.
+
+.. code-block:: python
+
+ from ryu.lib.packet import packet
+
+ @handler.set_ev_cls(ofp_event.EventOFPPacketIn, handler.MAIN_DISPATCHER)
+ def packet_in_handler(self, ev):
+ pkt = packet.Packet(array.array('B', ev.msg.data))
+ for p in pkt.protocols:
+ print p
+
+You can create a Packet class instance with the received raw
+data. Then the packet library parses the data and creates protocol
+class instances included the data. The packet class 'protocols' has
+the protocol class instances.
+
+If a TCP packet is received, something like the following is printed::
+
+ <ryu.lib.packet.ethernet.ethernet object at 0x107a5d790>
+ <ryu.lib.packet.vlan.vlan object at 0x107a5d7d0>
+ <ryu.lib.packet.ipv4.ipv4 object at 0x107a5d810>
+ <ryu.lib.packet.tcp.tcp object at 0x107a5d850>
+
+If vlan is not used, you see something like::
+
+ <ryu.lib.packet.ethernet.ethernet object at 0x107a5d790>
+ <ryu.lib.packet.ipv4.ipv4 object at 0x107a5d810>
+ <ryu.lib.packet.tcp.tcp object at 0x107a5d850>
+
+You can access to a specific protocol class instance by using the
+packet class find_protocol method. Let's try to check VLAN id if VLAN
+is used:
+
+.. code-block:: python
+
+ from ryu.lib.packet import packet
+
+ @handler.set_ev_cls(ofp_event.EventOFPPacketIn, handler.MAIN_DISPATCHER)
+ def packet_in_handler(self, ev):
+ pkt = packet.Packet(array.array('B', ev.msg.data))
+ for p in pkt.protocols:
+ print p
+ vp = pkt.find_protocol('vlan')
+ if vp:
+ print "vlan found:", vp.vid
+
+You see something like::
+
+ <ryu.lib.packet.ethernet.ethernet object at 0x107a5d790>
+ <ryu.lib.packet.vlan.vlan object at 0x107a5d7d0>
+ <ryu.lib.packet.ipv4.ipv4 object at 0x107a5d810>
+ <ryu.lib.packet.tcp.tcp object at 0x107a5d850>
+ vlan found: 10
+
+
+
+Building Packet
+===============
+
+You need to create protocol class instances that you want to send, add
+them to a packet class instance via add_protocol method, and then call
+serialize method. You have the raw data to send. The following example
+is building an arp packet.
+
+.. code-block:: python
+
+ dst = 'a' * 6
+ src = 'b' * 6
+ e = ethernet.ethernet(dst, src, ether.ETH_TYPE_8021Q)
+ a = arp.arp(1, 0x0800, 6, 4, 2, '\a' * 6, 50, '\b' * 6, 30)
+ p = packet.Packet()
+ p.add_protocol(e)
+ p.add_protocol(a)
+ p.serialize()
--
1.7.4.4
------------------------------------------------------------------------------
Live Security Virtual Conference
Exclusive live event will cover all the ways today's security and
threat landscape has changed and how IT managers can respond. Discussions
will include endpoint security, mobile security and the latest in malware
threats. http://www.accelacomm.com/jaw/sfrnl04242012/114/50122263/
_______________________________________________
Ryu-devel mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/ryu-devel
