class documentation

class twisted.protocols.loopback.LoopbackRelay: (source)

Implements interfaces: twisted.internet.interfaces.IConsumer, twisted.internet.interfaces.ITransport

View In Hierarchy

Undocumented

Instance Variable buffer Undocumented
Instance Variable shouldLose Undocumented
Class Variable disconnecting Undocumented
Instance Variable producer Undocumented
Method __init__ Undocumented
Instance Variable target Undocumented
Instance Variable logFile Undocumented
Method write Write some data to the physical connection, in sequence, in a non-blocking fashion.
Method writeSequence Write an iterable of byte strings to the physical connection.
Method clearBuffer Undocumented
Method loseConnection Close my connection, after writing all pending data.
Method getHost Similar to getPeer, but returns an address describing this side of the connection.
Method getPeer Get the remote address of this connection.
Method registerProducer Register to receive data from a producer.
Method unregisterProducer Stop consuming data from a producer, without disconnecting.
Method logPrefix Undocumented
buffer = (source)

Undocumented

(type: bytes)
shouldLose = (source)

Undocumented

(type: int)
disconnecting = (source)

Undocumented

(type: int)
producer = (source)

Undocumented

def __init__(self, target, logFile=None): (source)

Undocumented

target = (source)

Undocumented

logFile = (source)

Undocumented

def write(self, data): (source)

Write some data to the physical connection, in sequence, in a non-blocking fashion.

If possible, make sure that it is all written. No data will ever be lost, although (obviously) the connection may be closed before it all gets through.

ParametersdataThe data to write.
def writeSequence(self, iovec): (source)

Write an iterable of byte strings to the physical connection.

If possible, make sure that all of the data is written to the socket at once, without first copying it all into a single byte string.

ParametersiovecUndocumented
dataThe data to write.
def clearBuffer(self): (source)

Undocumented

def loseConnection(self): (source)

Close my connection, after writing all pending data.

Note that if there is a registered producer on a transport it will not be closed until the producer has been unregistered.

def getHost(self): (source)

Similar to getPeer, but returns an address describing this side of the connection.

ReturnsAn IAddress provider.
def getPeer(self): (source)

Get the remote address of this connection.

Treat this method with caution. It is the unfortunate result of the CGI and Jabber standards, but should not be considered reliable for the usual host of reasons; port forwarding, proxying, firewalls, IP masquerading, etc.

ReturnsAn IAddress provider.
def registerProducer(self, producer, streaming): (source)

Register to receive data from a producer.

This sets self to be a consumer for a producer. When this object runs out of data (as when a send(2) call on a socket succeeds in moving the last data from a userspace buffer into a kernelspace buffer), it will ask the producer to resumeProducing().

For IPullProducer providers, resumeProducing will be called once each time data is required.

For IPushProducer providers, pauseProducing will be called whenever the write buffer fills up and resumeProducing will only be called when it empties. The consumer will only call resumeProducing to balance a previous pauseProducing call; the producer is assumed to start in an un-paused state.

ParametersproducerUndocumented
streamingTrue if producer provides IPushProducer, False if producer provides IPullProducer.
RaisesRuntimeErrorIf a producer is already registered.
def unregisterProducer(self): (source)

Stop consuming data from a producer, without disconnecting.

def logPrefix(self): (source)

Undocumented

API Documentation for Twisted, generated by pydoctor 20.12.1 at 2021-02-28 19:53:36.