class documentation

class ProtocolWrapper(Protocol): (source)

Known subclasses: twisted.protocols.haproxy._wrapper.HAProxyProtocolWrapper, twisted.protocols.policies.SpewingProtocol, twisted.protocols.policies.ThrottlingProtocol, twisted.protocols.policies.TimeoutProtocol, twisted.protocols.policies.TrafficLoggingProtocol, twisted.protocols.tls.TLSMemoryBIOProtocol, twisted.protocols.loopback._FireOnClose

View In Hierarchy

Wraps protocol instances and acts as their transport as well.
Method __getattr__ Undocumented
Method __init__ Undocumented
Method connection​Lost Called when the connection is shut down.
Method data​Received Called whenever data is received.
Method get​Host Undocumented
Method get​Peer Undocumented
Method log​Prefix Use a customized log prefix mentioning both the wrapped protocol and the current one.
Method lose​Connection Undocumented
Method make​Connection 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​Producer Undocumented
Method stop​Consuming Undocumented
Method unregister​Producer Undocumented
Method write Undocumented
Method write​Sequence Undocumented
Instance Variable disconnecting Undocumented
Instance Variable factory The WrappingFactory which created this ProtocolWrapper.
Instance Variable wrapped​Protocol An IProtocol provider to which IProtocol method calls onto this ProtocolWrapper will be proxied.

Inherited from BaseProtocol (via Protocol):

Method connection​Made Called when a connection is made.
Instance Variable connected Undocumented
Instance Variable transport Undocumented
def __getattr__(self, name): (source)

Undocumented

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.

Parameters
reason:twisted.python.failure.FailureUndocumented
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.

Parameters
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 logPrefix(self): (source)
Use a customized log prefix mentioning both the wrapped protocol and the current one.
def makeConnection(self, transport): (source)
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.
def registerProducer(self, producer, streaming): (source)
def stopConsuming(self): (source)

Undocumented

disconnecting: int = (source)

Undocumented

wrappedProtocol = (source)
An IProtocol provider to which IProtocol method calls onto this ProtocolWrapper will be proxied.