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

View In Hierarchy

Wraps protocol instances and acts as their transport as well.

Method	`__getattr__`	Undocumented
Method	`__init__`	Undocumented
Method	`connectionLost`	Undocumented
Method	`dataReceived`	Undocumented
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.

def __getattr__(self, name): (source)

Undocumented

def __init__(self, factory, wrappedProtocol): (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)

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

Undocumented

def dataReceived(self, data): (source)

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

Undocumented

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)

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)

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)

The WrappingFactory which created this ProtocolWrapper.

wrappedProtocol = (source)

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