t.p.b.Int8StringReceiver(IntNStringReceiver) : class documentation

Part of twisted.protocols.basic View 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.

Inherited from IntNStringReceiver:

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 (via IntNStringReceiver):

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):

Method makeConnection Make a connection to a transport and a server.
Method connectionMade Called when a connection is made.

Inherited from _PauseableMixin (via IntNStringReceiver):

Method pauseProducing Undocumented
Method resumeProducing Undocumented
Method stopProducing Undocumented
API Documentation for Twisted, generated by pydoctor at 2014-09-18 22:01:49.