class documentation

class Int8StringReceiver(IntNStringReceiver): (source)

View In Hierarchy

A receiver for int8-prefixed strings.

An int8 string is a string prefixed by 1 byte, the 8-bit length of the string.

This class publishes the same interface as NetstringReceiver.

Class Variable prefix​Length Undocumented
Class Variable struct​Format Undocumented

Inherited from IntNStringReceiver:

Method data​Received Convert int prefixed strings into calls to stringReceived.
Method length​Limit​Exceeded Callback invoked when a length prefix greater than MAX_LENGTH is received. The default implementation disconnects the transport. Override this.
Method send​String Send a prefixed string to the other end of the connection.
Method string​Received Override this for notification when each complete string is received.
Constant MAX​_LENGTH Undocumented
Class Variable recvd Undocumented
Instance Variable _compatibility​Offset the offset within _unprocessed to the next message to be parsed. (used to generate the recvd attribute)
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.

Inherited from Protocol (via IntNStringReceiver):

Method connection​Lost Called when the connection is shut down.
Method log​Prefix Return a prefix matching the class name, to identify log messages related to this protocol instance.
Class Variable factory Undocumented

Inherited from BaseProtocol (via IntNStringReceiver, Protocol):

Method connection​Made Called when a connection is made.
Method make​Connection Make a connection to a transport and a server.
Instance Variable connected Undocumented
Instance Variable transport Undocumented

Inherited from _PauseableMixin (via IntNStringReceiver):

Method pause​Producing Undocumented
Method resume​Producing Undocumented
Method stop​Producing Undocumented
Instance Variable paused Undocumented