packet_base: update docstring
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:
parent
0a8e581628
commit
d15a23488f
@ -56,21 +56,16 @@ class PacketBase(stringify.StringifyMixin):
|
||||
This method is used only when decoding a packet.
|
||||
|
||||
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.
|
||||
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
|
||||
the packet. None when the rest of the packet should be considered
|
||||
as raw payload.
|
||||
|
||||
* The rest of packet.
|
||||
|
||||
"""
|
||||
pass
|
||||
|
||||
|
Loading…
Reference in New Issue
Block a user