class TrafficLoggingProtocol(ProtocolWrapper): (source)
Constructor: TrafficLoggingProtocol(factory, wrappedProtocol, logfile, lengthLimit, number)
Undocumented
| Method | __init__ |
No summary |
| Method | connection |
Called when the connection is shut down. |
| Method | connection |
Called when a connection is made. |
| Method | data |
Called whenever data is received. |
| Method | lose |
Undocumented |
| Method | write |
Undocumented |
| Method | write |
Undocumented |
| Instance Variable | length |
Undocumented |
| Instance Variable | logfile |
Undocumented |
| Method | _log |
Undocumented |
| Method | _munge |
Undocumented |
| Instance Variable | _number |
Undocumented |
Inherited from ProtocolWrapper:
| Method | __getattr__ |
Undocumented |
| Method | get |
Undocumented |
| Method | get |
Undocumented |
| Method | log |
Use a customized log prefix mentioning both the wrapped protocol and the current one. |
| Method | make |
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 | register |
Undocumented |
| Method | stop |
Undocumented |
| Method | unregister |
Undocumented |
| Instance Variable | disconnecting |
Undocumented |
| Instance Variable | factory |
The WrappingFactory which created this ProtocolWrapper. |
| Instance Variable | wrapped |
An IProtocol provider to which IProtocol method calls onto this ProtocolWrapper will be proxied. |
Inherited from BaseProtocol (via ProtocolWrapper, Protocol):
| Instance Variable | connected |
Undocumented |
| Instance Variable | transport |
Undocumented |
| Parameters | |
factory:protocol.Factory. | factory which created this protocol. |
| wrapped | the underlying protocol. |
| logfile:file | file opened for writing used to write log messages. |
| length | maximum size of the datareceived logged. |
| number:int. | identifier of the connection. |
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:twisted.python.failure.Failure | Undocumented |
Called when a connection is made.
This may be considered the initializer of the protocol, because it is called when the connection is completed. For clients, this is called once the connection to the server has been established; for servers, this is called after an accept() call stops blocking and a socket has been received. If you need to send any greeting or initial message, do it here.
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. |