twisted.protocols.policies.TimeoutProtocol : API documentation

class documentation

class TimeoutProtocol(ProtocolWrapper): (source)

Protocol that automatically disconnects when the connection is idle.

Method	`__init__`	Constructor.
Instance Variable	`timeoutCall`	Undocumented
Instance Variable	`timeoutPeriod`	Undocumented
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`	Undocumented
Method	`connectionLost`	Undocumented
Method	`timeoutFunc`	This method is called when the timeout is triggered.

Inherited from ProtocolWrapper:

Instance Variable	`wrappedProtocol`	An `IProtocol` provider to which `IProtocol` method calls onto this `ProtocolWrapper` will be proxied.
Instance Variable	`factory`	The `WrappingFactory` which created this `ProtocolWrapper`.
Instance Variable	`disconnecting`	Undocumented
Method	`logPrefix`	Use a customized log prefix mentioning both the wrapped protocol and the current one.
Method	`makeConnection`	When a connection is made, register this wrapper with its factory, save the real transport, and connect the wrapped protocol to this `ProtocolWrapper` to intercept any transport calls it makes.
Method	`loseConnection`	Undocumented
Method	`getPeer`	Undocumented
Method	`getHost`	Undocumented
Method	`registerProducer`	Undocumented
Method	`unregisterProducer`	Undocumented
Method	`stopConsuming`	Undocumented
Method	`__getattr__`	Undocumented

def __init__(self, factory, wrappedProtocol, timeoutPeriod): (source)

overrides twisted.protocols.policies.ProtocolWrapper.__init__

Constructor.

Parameters	factory	An `TimeoutFactory`.
	wrappedProtocol	A `Protocol` to wrapp.
	timeoutPeriod	Number of seconds to wait for activity before timing out.

timeoutCall = (source)

Undocumented

timeoutPeriod = (source)

Undocumented

def setTimeout(self, timeoutPeriod=None): (source)

Set a timeout.

This will cancel any existing timeouts.

Parameters timeoutPeriod If 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)

overrides twisted.protocols.policies.ProtocolWrapper.write

Undocumented

def writeSequence(self, seq): (source)

overrides twisted.protocols.policies.ProtocolWrapper.writeSequence

Undocumented

def dataReceived(self, data): (source)

overrides twisted.protocols.policies.ProtocolWrapper.dataReceived

Undocumented

def connectionLost(self, reason): (source)

overrides twisted.protocols.policies.ProtocolWrapper.connectionLost

Undocumented

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 21.2.0 at 2021-02-28 21:00:42.