class documentation


Method __init__ No summary
Method connectionLost Called when the connection is shut down.
Method connectionMade Called when a connection is made.
Method dataReceived Called whenever data is received.
Method loseConnection Undocumented
Method write Undocumented
Method writeSequence Undocumented
Instance Variable lengthLimit Undocumented
Instance Variable logfile Undocumented
Method _log Undocumented
Method _mungeData Undocumented
Instance Variable _number Undocumented

Inherited from ProtocolWrapper:

Method __getattr__ Undocumented
Method getHost Undocumented
Method getPeer 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 registerProducer Undocumented
Method stopConsuming Undocumented
Method unregisterProducer Undocumented
Instance Variable disconnecting Undocumented
Instance Variable factory The WrappingFactory which created this ProtocolWrapper.
Instance Variable wrappedProtocol 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
def __init__(self, factory, wrappedProtocol, logfile, lengthLimit=None, number=0): (source)
factory:protocol.Factory.factory which created this protocol.
wrappedProtocol:protocol.Protocol.the underlying protocol.
logfile:filefile opened for writing used to write log messages.
lengthLimit:intmaximum size of the datareceived logged.
number:int.identifier of the connection.
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 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.

dataa 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 write(self, data): (source)
def writeSequence(self, iovec): (source)
lengthLimit = (source)



def _log(self, line): (source)


def _mungeData(self, data): (source)