t.p.p.TimeoutProtocol(ProtocolWrapper) : class documentation

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

Protocol that automatically disconnects when the connection is idle.
Method __init__ Constructor.
Method setTimeout Set a timeout.
Method cancelTimeout Cancel the timeout.
Method resetTimeout Reset the timeout, usually because some activity just happened.
Method write Undocumented
Method writeSequence Undocumented
Method dataReceived Called whenever data is received.
Method connectionLost Called when the connection is shut down.
Method timeoutFunc This method is called when the timeout is triggered.

Inherited from ProtocolWrapper:

Method makeConnection Make a connection to a transport and a server.
Method loseConnection Undocumented
Method getPeer Undocumented
Method getHost Undocumented
Method registerProducer Undocumented
Method unregisterProducer Undocumented
Method stopConsuming Undocumented
Method __getattr__ Undocumented
Method connectionMade Called when a connection is made.
def __init__(self, factory, wrappedProtocol, timeoutPeriod): (source)
ParametersfactoryAn IFactory.
wrappedProtocolA Protocol to wrapp.
timeoutPeriodNumber of seconds to wait for activity before timing out.
def setTimeout(self, timeoutPeriod=None): (source)

Set a timeout.

This will cancel any existing timeouts.
ParameterstimeoutPeriodIf not None, change the timeout period. Otherwise, use the existing value.
def cancelTimeout(self): (source)

Cancel the timeout.

If the timeout was already cancelled, this does nothing.
def resetTimeout(self): (source)
Reset the timeout, usually because some activity just happened.
def write(self, data): (source)
def writeSequence(self, seq): (source)
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.
def connectionLost(self, reason): (source)

Called when the connection is shut down.

Clear any circular references here, and any external references to this Protocol. The connection has been closed.
Parametersreason (type: twisted.python.failure.Failure )
def timeoutFunc(self): (source)

This method is called when the timeout is triggered.

By default it calls loseConnection. Override this if you want something else to happen.
API Documentation for Twisted, generated by pydoctor at 2011-10-27 16:02:37.