t.p.p.TrafficLoggingProtocol(ProtocolWrapper) : class documentation

Part of twisted.protocols.policies View Source View In Hierarchy

No class docstring
Method __init__ No summary
Method connectionMade Called when a connection is made.
Method dataReceived Called whenever data is received.
Method connectionLost Called when the connection is shut down.
Method write Undocumented
Method writeSequence Undocumented
Method loseConnection Undocumented
Method _log Undocumented
Method _mungeData 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.
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 getPeer Undocumented
Method getHost Undocumented
Method registerProducer Undocumented
Method unregisterProducer Undocumented
Method stopConsuming Undocumented
Method __getattr__ Undocumented
def __init__(self, factory, wrappedProtocol, logfile, lengthLimit=None, number=0): (source)
Parametersfactoryfactory which created this protocol. (type: protocol.Factory.)
wrappedProtocolthe underlying protocol. (type: protocol.Protocol.)
logfilefile opened for writing used to write log messages. (type: file)
lengthLimitmaximum size of the datareceived logged. (type: int)
numberidentifier of the connection. (type: int.)
def _log(self, line): (source)
Undocumented
def _mungeData(self, data): (source)
Undocumented
def connectionMade(self): (source)
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.

def dataReceived(self, data): (source)
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.

Parametersdataa 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.
def connectionLost(self, reason): (source)
Called when the connection is shut down.

Clear any circular references here, and any external references to this Protocol. The connection has been closed.

def write(self, data): (source)
Undocumented
def writeSequence(self, iovec): (source)
Undocumented
def loseConnection(self): (source)
Undocumented
API Documentation for Twisted, generated by pydoctor at 2012-09-01 11:44:56.