openstack/deb-ryu
Code Issues Proposed changes

packet_base: update docstring

Browse Source 
Signed-off-by: YAMAMOTO Takashi <yamamoto@valinux.co.jp>
Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
This commit is contained in:
YAMAMOTO Takashi 2013-08-13 10:07:55 +09:00 committed by FUJITA Tomonori
parent 0a8e581628
commit d15a23488f
1 changed files with 3 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
ryu/lib/packet/packet_base.py
View File

@ -56,21 +56,16 @@ class PacketBase(stringify.StringifyMixin):
This method is used only when decoding a packet. This method is used only when decoding a packet.
Decode a protocol header at offset 0 in bytearray *buf*. Decode a protocol header at offset 0 in bytearray *buf*.
Returns the following two objects. Returns the following three objects.
* An object to describe the decoded header. * An object to describe the decoded header.
It should have the following attributes at least.
=========== ============
Attribute Description
=========== ============
length The number of the corresponding on-wire octets.
=========== ============
* A packet_base.PacketBase subclass appropriate for the rest of * A packet_base.PacketBase subclass appropriate for the rest of
the packet. None when the rest of the packet should be considered the packet. None when the rest of the packet should be considered
as raw payload. as raw payload.
* The rest of packet.
""" """
pass pass