class documentation

class Int32StringReceiver(IntNStringReceiver): (source)

View In Hierarchy

A receiver for int32-prefixed strings.

An int32 string is a string prefixed by 4 bytes, the 32-bit length of the string encoded in network byte order.

This class publishes the same interface as NetstringReceiver.

Class Variable prefixLength Undocumented
Class Variable structFormat Undocumented

Inherited from IntNStringReceiver:

Method dataReceived Convert int prefixed strings into calls to stringReceived.
Method lengthLimitExceeded Callback invoked when a length prefix greater than MAX_LENGTH is received. The default implementation disconnects the transport. Override this.
Method sendString Send a prefixed string to the other end of the connection.
Method stringReceived Override this for notification when each complete string is received.
Class Variable MAX_LENGTH Undocumented
Class Variable recvd Undocumented
Instance Variable _compatibilityOffset 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 connectionLost Called when the connection is shut down.
Method logPrefix 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 connectionMade Called when a connection is made.
Method makeConnection Make a connection to a transport and a server.
Instance Variable connected Undocumented
Instance Variable transport Undocumented

Inherited from _PauseableMixin (via IntNStringReceiver):

Method pauseProducing Undocumented
Method resumeProducing Undocumented
Method stopProducing Undocumented
Instance Variable paused Undocumented