t.i._._PollableWritePipe(_PollableResource) : class documentation

Part of twisted.internet._pollingfile View Source View In Hierarchy

Implements interfaces: twisted.internet.interfaces.IConsumer

No class docstring
Method __init__ Undocumented
Method close Undocumented
Method bufferFull Undocumented
Method bufferEmpty Undocumented
Method registerProducer Register to receive data from a producer.
Method unregisterProducer Stop consuming data from a producer, without disconnecting.
Method writeConnectionLost Undocumented
Method writeSequence Append a list or tuple of bytes to the output buffer.
Method write Append some bytes to the output buffer.
Method checkWork Undocumented

Inherited from _PollableResource:

Method activate Undocumented
Method deactivate Undocumented
def __init__(self, writePipe, lostCallback): (source)
Undocumented
def close(self): (source)
Undocumented
def bufferFull(self): (source)
Undocumented
def bufferEmpty(self): (source)
Undocumented
def registerProducer(self, producer, streaming): (source)
from twisted.internet.interfaces.IConsumer
Register to receive data from a producer.

This sets this selectable to be a consumer for a producer. When this selectable runs out of data on a write() call, it will ask the producer to resumeProducing(). A producer should implement the IProducer interface.

FileDescriptor provides some infrastructure for producer methods.

def unregisterProducer(self): (source)
from twisted.internet.interfaces.IConsumer
Stop consuming data from a producer, without disconnecting.
def writeConnectionLost(self): (source)
Undocumented
def writeSequence(self, seq): (source)
Append a list or tuple of bytes to the output buffer.
Parametersseqlist or tuple of str instances to be appended to the output buffer.
RaisesTypeErrorIf seq contains unicode.
def write(self, data): (source)
from twisted.internet.interfaces.IConsumer
Append some bytes to the output buffer.
Parametersdatastr to be appended to the output buffer. (type: str.)
RaisesTypeErrorIf data is unicode instead of str.
def checkWork(self): (source)
Undocumented
API Documentation for Twisted, generated by pydoctor at 2012-06-04 17:20:01.