class documentation

class StatefulProtocol(protocol.Protocol): (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).

Method dataReceived Called whenever data is received.
Method getInitialState Undocumented
Method makeConnection Make a connection to a transport and a server.
Instance Variable _sful_data Undocumented

Inherited from Protocol:

Method connectionLost Called when the connection is shut down.
Method logPrefix Return a prefix matching the class name, to identify log messages related to this protocol instance.
Class Variable factory Undocumented

Inherited from BaseProtocol (via Protocol):

Method connectionMade Called when a connection is made.
Instance Variable connected Undocumented
Instance Variable transport 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.

dataa 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.
def getInitialState(self): (source)


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.

_sful_data = (source)