twisted.protocols.policies.ThrottlingProtocol(ProtocolWrapper) class documentationtwisted.protocols.policies
View Source
(View In Hierarchy)
Protocol for ThrottlingFactory.
| Method | write | Undocumented |
| Method | writeSequence | Undocumented |
| Method | dataReceived | Called whenever data is received. |
| Method | registerProducer | Undocumented |
| Instance Variable | producer | Undocumented |
| Method | unregisterProducer | Undocumented |
| Method | throttleReads | Undocumented |
| Method | unthrottleReads | Undocumented |
| Method | throttleWrites | Undocumented |
| Method | unthrottleWrites | Undocumented |
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 | __init__ | 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 | stopConsuming | Undocumented |
| Method | __getattr__ | Undocumented |
| Method | connectionLost | Called when the connection is shut down. |
Inherited from BaseProtocol (via ProtocolWrapper, Protocol):
| Instance Variable | connected | Undocumented |
| Instance Variable | transport | Undocumented |
| Method | connectionMade | Called when a connection is made. |
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. |