twisted.protocols.loopback.LoopbackRelay : API documentation

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

Undocumented

def write(self, data): (source)

from twisted.internet.interfaces.ITransport

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.

Parameters data The data to write. (type: bytes)

def writeSequence(self, iovec): (source)

from twisted.internet.interfaces.ITransport

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.

Parameters data The data to write. (type: an iterable of bytes)

def clearBuffer(self): (source)

Undocumented

def loseConnection(self): (source)

from twisted.internet.interfaces.ITransport

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)

from twisted.internet.interfaces.ITransport

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

Returns An IAddress provider.

def getPeer(self): (source)

from twisted.internet.interfaces.ITransport

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.

Returns An IAddress provider.

def registerProducer(self, producer, streaming): (source)

from twisted.internet.interfaces.IConsumer

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.

Parameters	streaming	`True` if `producer` provides `IPushProducer`, `False` if `producer` provides `IPullProducer`. (type: `bool`)
Returns	`None`
Raises	RuntimeError	If a producer is already registered.

def unregisterProducer(self): (source)

from twisted.internet.interfaces.IConsumer

Stop consuming data from a producer, without disconnecting.

def logPrefix(self): (source)

Undocumented

Method	__init__	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

twisted.protocols.loopback.LoopbackRelay class documentation

`twisted.protocols.loopback.LoopbackRelay` class documentation