Home | Trees | Index | Help |
---|
Package beepy :: Package core :: Module frame :: Class DataFrame |
|
Frame
--+
|
DataFrame
Method Summary | |
---|---|
When a frame is created, various checks on the data are performed to ensure that it is a correctly formed frame. | |
__repr__(self)
| |
Returns a frame as a formatted bytestring ready for passing to the transport layer. | |
Check to see if this is an ANS frame | |
Check to see if this is an ERR frame | |
Check to see if this is a MSG frame | |
Check to see if this is a NUL frame | |
Check to see if this is a RPY frame | |
Assigns a payload to a DataFrame. | |
Convert a bytestring databuffer to a DataFrame object. | |
Performs sanity checking on values of DataFrames at create time. |
Class Variable Summary | |
---|---|
int |
ansno = -1 |
int |
channelnum = -1 |
str |
frameType = 'data'
|
int |
msgno = -1 |
long |
seqno = -1L
|
long |
size = -1L
|
str |
TRAILER = 'END\r\n'
|
Method Details |
---|
__init__(self,
channelnum=None,
msgno=None,
seqno=None,
size=None,
dataFrameType='MSG',
more='.',
ansno=None,
databuffer=None)
When a frame is created, various checks on the data are performed to
ensure that it is a correctly formed frame. This is most useful for
validating data received from the transport layer.
|
__str__(self)
Returns a frame as a formatted bytestring ready for passing to the
transport layer. Pretty printed so it's human readable.
|
isANS(self)Check to see if this is an ANS frame
|
isERR(self)Check to see if this is an ERR frame
|
isMSG(self)Check to see if this is a MSG frame
|
isNUL(self)Check to see if this is a NUL frame
|
isRPY(self)Check to see if this is a RPY frame
|
setPayload(self, payload)Assigns a payload to a DataFrame. This is usually called after creating an empty frame with the header information set to populate the frame.
|
_bufferToFrame(self, data)Convert a bytestring databuffer to a DataFrame object. Mostly used to decode incoming datastreams from the transport layer into DataFrame objects.
|
_checkValues(self, channelnum, msgno, more, seqno, size, dataFrameType, ansno=None)Performs sanity checking on values of DataFrames at create time. |
Class Variable Details |
---|
ansno
|
channelnum
|
frameType
|
msgno
|
seqno
|
size
|
TRAILER
|
Home | Trees | Index | Help |
---|
Generated by Epydoc 2.0 on Thu Sep 30 14:39:26 2004 | http://epydoc.sf.net |