Part of twisted.protocols.policies View Source View In Hierarchy
Known subclasses: twisted.manhole._inspectro.LoggingProtocol, twisted.protocols.loopback._FireOnClose, twisted.protocols.policies.SpewingProtocol, twisted.protocols.policies.ThrottlingProtocol, twisted.protocols.policies.TimeoutProtocol, twisted.protocols.policies.TrafficLoggingProtocol, twisted.protocols.tls.TLSMemoryBIOProtocol
| Instance Variables | wrappedProtocol | An IProtocol provider to which IProtocol
method calls onto this ProtocolWrapper
will be proxied.
|
| factory | The WrappingFactory
which created this ProtocolWrapper.
|
| Method | __init__ | Undocumented |
| 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 | write | Undocumented |
| Method | writeSequence | Undocumented |
| Method | loseConnection | Undocumented |
| Method | getPeer | Undocumented |
| Method | getHost | Undocumented |
| Method | registerProducer | Undocumented |
| Method | unregisterProducer | Undocumented |
| Method | stopConsuming | Undocumented |
| Method | __getattr__ | Undocumented |
| Method | dataReceived | Called whenever data is received. |
| Method | connectionLost | Called when the connection is shut down. |
Inherited from BaseProtocol (via Protocol):
| Method | connectionMade | Called when a connection is made. |
ProtocolWrapper
to intercept any transport calls it makes.
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.| Parameters | reason | (type: twisted.python.failure.Failure
) |