twisted.protocols.basic.IntNStringReceiver(protocol.Protocol, _PauseableMixin)
class documentationtwisted.protocols.basic
View Source
(View In Hierarchy)
Known subclasses: twisted.protocols.basic.Int16StringReceiver, twisted.protocols.basic.Int32StringReceiver, twisted.protocols.basic.Int8StringReceiver
Generic class for length prefixed protocols.
Instance Variable | structFormat | format used for struct packing/unpacking. Define it in subclass. (type: str ) |
Instance Variable | prefixLength | length of the prefix, in bytes. Define it in subclass, using
struct.calcsize(structFormat) (type: int ) |
Method | stringReceived | Override this for notification when each complete string is received. |
Method | lengthLimitExceeded | Callback invoked when a length prefix greater than
MAX_LENGTH is received. The default implementation
disconnects the transport. Override this. |
Method | dataReceived | Convert int prefixed strings into calls to stringReceived. |
Method | sendString | Send a prefixed string to the other end of the connection. |
Instance Variable | _unprocessed | bytes received, but not yet broken up into messages / sent to
stringReceived. _compatibilityOffset must be updated when this value is
updated so that the recvd attribute can be generated
correctly. (type: bytes ) |
Instance Variable | _compatibilityOffset | the offset within _unprocessed to the next message to be
parsed. (used to generate the recvd attribute) (type: int ) |
Inherited from Protocol:
Method | logPrefix | Return a prefix matching the class name, to identify log messages related to this protocol instance. |
Method | connectionLost | Called when the connection is shut down. |
Inherited from BaseProtocol (via Protocol):
Method | makeConnection | Make a connection to a transport and a server. |
Method | connectionMade | Called when a connection is made. |
Inherited from _PauseableMixin:
Method | pauseProducing | Undocumented |
Method | resumeProducing | Undocumented |
Method | stopProducing | Undocumented |
recvd
attribute can be generated
correctly. (type: bytes
)
struct.calcsize(structFormat)
(type: int
)
_unprocessed
to the next message to be
parsed. (used to generate the recvd attribute) (type: int
)
Override this for notification when each complete string is received.
Parameters | string | The complete string which was received with all framing (length prefix,
etc) removed. (type: bytes ) |
Callback invoked when a length prefix greater than
MAX_LENGTH
is received. The default implementation
disconnects the transport. Override this.
Parameters | length | The length prefix which was received. (type: int ) |
Convert int prefixed strings into calls to stringReceived.
Send a prefixed string to the other end of the connection.
Parameters | string | The string to send. The necessary framing (length prefix, etc) will be
added. (type: bytes ) |