twisted.protocols.policies.ProtocolWrapper

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

Constructor: ProtocolWrapper(factory, wrappedProtocol)

View In Hierarchy

Wraps protocol instances and acts as their transport as well.

Method	`__getattr__`	Undocumented
Method	`__init__`	Undocumented
Method	`connectionLost`	Called when the connection is shut down.
Method	`dataReceived`	Called whenever data is received.
Method	`getHost`	Undocumented
Method	`getPeer`	Undocumented
Method	`logPrefix`	Use a customized log prefix mentioning both the wrapped protocol and the current one.
Method	`loseConnection`	Undocumented
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
Method	`write`	Undocumented
Method	`writeSequence`	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 Protocol):

Method	`connectionMade`	Called when a connection is made.
Instance Variable	`connected`	Undocumented
Instance Variable	`transport`	Undocumented

def __getattr__(self, name): (source) ¶

Undocumented

def __init__(self, factory: WrappingFactory, wrappedProtocol: interfaces.IProtocol): (source) ¶

overridden in twisted.protocols.haproxy._wrapper.HAProxyProtocolWrapper, twisted.protocols.policies.TimeoutProtocol, twisted.protocols.policies.TrafficLoggingProtocol, twisted.protocols.tls.TLSMemoryBIOProtocol, twisted.protocols.loopback._FireOnClose

Undocumented

def connectionLost(self, reason): (source) ¶

from twisted.internet.interfaces.IProtocol

overrides twisted.internet.protocol.Protocol.connectionLost

overridden in twisted.protocols.policies.TimeoutProtocol, twisted.protocols.policies.TrafficLoggingProtocol, twisted.protocols.tls.TLSMemoryBIOProtocol, twisted.protocols.loopback._FireOnClose

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

def dataReceived(self, data): (source) ¶

from twisted.internet.interfaces.IProtocol

overrides twisted.internet.protocol.Protocol.dataReceived

overridden in 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

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.

def getHost(self): (source) ¶

overridden in twisted.protocols.haproxy._wrapper.HAProxyProtocolWrapper

Undocumented

def getPeer(self): (source) ¶

overridden in twisted.protocols.haproxy._wrapper.HAProxyProtocolWrapper

Undocumented

def logPrefix(self): (source) ¶

from twisted.internet.interfaces.ILoggingContext

overrides twisted.internet.protocol.Protocol.logPrefix

Use a customized log prefix mentioning both the wrapped protocol and the current one.

def loseConnection(self): (source) ¶

overridden in twisted.protocols.policies.TrafficLoggingProtocol, twisted.protocols.tls.TLSMemoryBIOProtocol

Undocumented

def makeConnection(self, transport): (source) ¶

from twisted.internet.interfaces.IProtocol

overrides twisted.internet.protocol.BaseProtocol.makeConnection

overridden in twisted.protocols.tls.TLSMemoryBIOProtocol

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) ¶

overridden in twisted.protocols.policies.ThrottlingProtocol, twisted.protocols.tls.TLSMemoryBIOProtocol

Undocumented

def stopConsuming(self): (source) ¶

Undocumented

def unregisterProducer(self): (source) ¶

overridden in twisted.protocols.policies.ThrottlingProtocol, twisted.protocols.tls.TLSMemoryBIOProtocol

Undocumented

def write(self, data): (source) ¶

overridden in twisted.protocols.policies.SpewingProtocol, twisted.protocols.policies.ThrottlingProtocol, twisted.protocols.policies.TimeoutProtocol, twisted.protocols.policies.TrafficLoggingProtocol, twisted.protocols.tls.TLSMemoryBIOProtocol

Undocumented

def writeSequence(self, data): (source) ¶

overridden in twisted.protocols.policies.ThrottlingProtocol, twisted.protocols.policies.TimeoutProtocol, twisted.protocols.policies.TrafficLoggingProtocol, twisted.protocols.tls.TLSMemoryBIOProtocol

Undocumented

disconnecting: int = (source) ¶

overridden in twisted.protocols.tls.TLSMemoryBIOProtocol

Undocumented

factory = (source) ¶

overrides twisted.internet.protocol.Protocol.factory

The WrappingFactory which created this ProtocolWrapper.

wrappedProtocol = (source) ¶

An IProtocol provider to which IProtocol method calls onto this ProtocolWrapper will be proxied.