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

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

Wraps protocol instances and acts as their transport as well.
Method __init__ Undocumented
Method makeConnection Make a connection to a transport and a server.
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 connectionMade Called when a connection is made.
Method dataReceived Called whenever data is received.
Method connectionLost Called when the connection is shut down.
def __init__(self, factory, wrappedProtocol): (source)
def makeConnection(self, transport): (source)

Make a connection to a transport and a server.

This sets the 'transport' attribute of this Protocol, and calls the connectionMade() callback.
def write(self, data): (source)
def writeSequence(self, data): (source)
def loseConnection(self): (source)
def getPeer(self): (source)
def getHost(self): (source)
def registerProducer(self, producer, streaming): (source)
def unregisterProducer(self): (source)
def stopConsuming(self): (source)
def __getattr__(self, name): (source)
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.
Parametersreason (type: twisted.python.failure.Failure )
API Documentation for Twisted, generated by pydoctor at 2011-10-27 16:02:37.