twisted.internet.protocol.FileWrapper : API documentation

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

def __init__(self, file): (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 _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)

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

Undocumented

def resumeProducing(self): (source)

Undocumented

def pauseProducing(self): (source)

Undocumented

def stopProducing(self): (source)

Undocumented

twisted.internet.protocol.FileWrapper class documentation

`twisted.internet.protocol.FileWrapper` class documentation