twisted.protocols.policiesView Source (View In Hierarchy)
Protocol that automatically disconnects when the connection is idle.
|Method||setTimeout||Set a timeout.|
|Method||cancelTimeout||Cancel the timeout.|
|Method||resetTimeout||Reset the timeout, usually because some activity just happened.|
|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||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
|Method||connectionMade||Called when a connection is made.|
Set a timeout.
This will cancel any existing timeouts.
|Parameters||timeoutPeriod||If not |
Cancel the timeout.
If the timeout was already cancelled, this does nothing.
Reset the timeout, usually because some activity just happened.
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.
|Parameters||data||a 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.|
Called when the connection is shut down.
Clear any circular references here, and any external references to this Protocol. The connection has been closed.
This method is called when the timeout is triggered.
By default it calls loseConnection. Override this if you want something else to happen.