class documentation

class twisted.internet.protocol.FileWrapper: (source)

Implements interfaces: twisted.internet.interfaces.ITransport

View In Hierarchy

A wrapper around a file-like object to make it behave as a Transport.

This doesn't actually stream the file to the attached protocol, and is thus useful mainly as a utility for debugging protocols.

Instance Variable closed Undocumented
Class Variable disconnecting Undocumented
Instance Variable producer Undocumented
Instance Variable streamingProducer Undocumented
Method __init__ Undocumented
Instance Variable file Undocumented
Method write Write some data to the physical connection, in sequence, in a non-blocking fashion.
Method registerProducer From abstract.FileDescriptor
Method unregisterProducer Undocumented
Method stopConsuming Undocumented
Method writeSequence Write an iterable of byte strings to the physical connection.
Method loseConnection Close my connection, after writing all pending data.
Method getPeer Get the remote address of this connection.
Method getHost Similar to getPeer, but returns an address describing this side of the connection.
Method handleException Undocumented
Method resumeProducing Undocumented
Method pauseProducing Undocumented
Method stopProducing Undocumented
Method _checkProducer Undocumented
closed = (source)

Undocumented

(type: int)
disconnecting = (source)

Undocumented

(type: int)
producer = (source)

Undocumented

streamingProducer = (source)

Undocumented

def __init__(self, file): (source)

Undocumented

file = (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. (type: bytes)
def _checkProducer(self): (source)

Undocumented

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

From abstract.FileDescriptor

def unregisterProducer(self): (source)

Undocumented

def stopConsuming(self): (source)

Undocumented

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 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 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 getHost(self): (source)

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

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

Undocumented

def resumeProducing(self): (source)

Undocumented

def pauseProducing(self): (source)

Undocumented

def stopProducing(self): (source)

Undocumented

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