class documentation

class twisted.protocols.policies.TimeoutMixin: (source)

Known subclasses: twisted.mail.imap4.IMAP4Client, twisted.mail.imap4.IMAP4Server, twisted.mail.pop3.AdvancedPOP3Client, twisted.mail.pop3.POP3, twisted.mail.smtp.SMTP, twisted.mail.smtp.SMTPClient, twisted.protocols.ftp.FTP, twisted.protocols.memcache.MemCacheProtocol, twisted.protocols.postfix.PostfixTCPMapServer, twisted.web._http2.H2Connection, twisted.web.http.HTTPChannel

View In Hierarchy

Mixin for protocols which wish to timeout connections.

Protocols that mix this in have a single timeout, set using setTimeout. When the timeout is hit, timeoutConnection is called, which, by default, closes the connection.

Instance Variable timeOut The number of seconds after which to timeout the connection.
Method callLater Wrapper around reactor.callLater for test purpose.
Method resetTimeout Reset the timeout count down.
Method setTimeout Change the timeout period
Method timeoutConnection Called when the connection times out.
Instance Variable __timeoutCall Undocumented
Method __timedOut Undocumented
timeOut = (source)
The number of seconds after which to timeout the connection.
__timeoutCall = (source)

Undocumented

def callLater(self, period, func): (source)

Wrapper around reactor.callLater for test purpose.

def resetTimeout(self): (source)

Reset the timeout count down.

If the connection has already timed out, then do nothing. If the timeout has been cancelled (probably using setTimeout(None)), also do nothing.

It's often a good idea to call this when the protocol has received some meaningful input from the other end of the connection. "I've got some data, they're still there, reset the timeout".

def setTimeout(self, period): (source)

Change the timeout period

ParametersperiodThe period, in seconds, to change the timeout to, or None to disable the timeout. (type: int or None)
def __timedOut(self): (source)

Undocumented

API Documentation for Twisted, generated by pydoctor 20.12.1 at 2021-02-28 19:53:36.