t.p.b.IntNStringReceiver(protocol.Protocol, _PauseableMixin) : class documentation

Generic class for length prefixed protocols.

Instance Variables	recvd	buffer holding received data when splitted. (type: `str` )
	structFormat	format used for struct packing/unpacking. Define it in subclass. (type: `str` )
	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.

Inherited from Protocol:

Method

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:

def stringReceived(self, string): (source)

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

def lengthLimitExceeded(self, length): (source)

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 )

def dataReceived(self, recd): (source)

Convert int prefixed strings into calls to stringReceived.

def sendString(self, string): (source)

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

API Documentation for Twisted, generated by pydoctor at 2011-10-27 16:27:37.