twisted.protocols.basic.NetstringReceiver : API documentation

This uses djb's Netstrings protocol to break up the input into strings.

Each string makes a callback to stringReceived, with a single argument of that string.

Security features:

Messages are limited in size, useful if you don't want someone sending you a 500MB netstring (change MAX_LENGTH to the maximum length you wish to accept).
The connection is lost if an illegal message is received.

Method	stringReceived	Override this.
Method	doData	Undocumented
Method	doComma	Undocumented
Method	doLength	Undocumented
Method	dataReceived	Called whenever data is received.
Method	sendString	Undocumented

Inherited from Protocol:

Method

connectionLost

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.

def stringReceived(self, line): (source)

Override this.

def doData(self): (source)

Undocumented

def doComma(self): (source)

Undocumented

def doLength(self): (source)

Undocumented

def dataReceived(self, data): (source)

from twisted.internet.interfaces.IProtocol

overrides twisted.internet.protocol.Protocol.dataReceived

Called whenever data is received.

Use this method to translate to a higher-level message. Usually, some callback will be made upon the receipt of each complete protocol message.

Parameters data a string of indeterminate length. Please keep in mind that you will probably need to buffer some data, as partial (or multiple) protocol messages may be received! I recommend that unit tests for protocols call through to this method with differing chunk sizes, down to one byte at a time.

t.p.b.NetstringReceiver(protocol.Protocol) : class documentation