class documentation

class twisted.protocols.basic.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 structFormat Undocumented
Class Variable prefixLength Undocumented

Inherited from IntNStringReceiver:

Class Variable MAX_LENGTH Undocumented
Class Variable recvd Undocumented
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.
Instance Variable _compatibilityOffset the offset within _unprocessed to the next message to be parsed. (used to generate the recvd attribute)

Inherited from Protocol (via IntNStringReceiver):

Class Variable factory Undocumented
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 IntNStringReceiver, Protocol):

Instance Variable connected Undocumented
Instance Variable transport Undocumented
Method makeConnection Make a connection to a transport and a server.
Method connectionMade Called when a connection is made.

Inherited from _PauseableMixin (via IntNStringReceiver):

Instance Variable paused Undocumented
Method pauseProducing Undocumented
Method resumeProducing Undocumented
Method stopProducing Undocumented
API Documentation for Twisted, generated by pydoctor 20.12.1 at 2021-02-28 19:53:36.