Class t.p.s.StatefulProtocol(protocol.Protocol):

Part of twisted.protocols.stateful View Source View In Hierarchy

A Protocol that stores state for you.

state is a pair (function, num_bytes). When num_bytes bytes of data arrives from the network, function is called. It is expected to return the next state or None to keep same state. Initial state is returned by getInitialState (override it).

Split Table into Classes Show Methods in One Table

Line # Kind Name Docs
24 Method makeConnection Make a connection to a transport and a server.
28 Method getInitialState Undocumented
31 Method dataReceived Called whenever data is received.

Inherited from Protocol:

Line # Kind Name Docs
384 Method connectionLost Called when the connection is shut down.

Inherited from BaseProtocol (via Protocol):

Line # Kind Name Docs
351 Method connectionMade Called when a connection is made.
Line # Kind Name Docs
384 Method connectionLost Called when the connection is shut down.
351 Method connectionMade Called when a connection is made.
31 Method dataReceived Called whenever data is received.
28 Method getInitialState Undocumented
24 Method makeConnection Make a connection to a transport and a server.
def makeConnection(self, transport): (source)

Make a connection to a transport and a server.

This sets the 'transport' attribute of this Protocol, and calls the connectionMade() callback.
def getInitialState(self): (source)
Undocumented
def dataReceived(self, data): (source)

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.
Parametersdataa 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.
API Documentation for Twisted, generated by pydoctor at 2008-10-26 16:12:37.