twisted.internet._pollingfile._PollableWritePipe

class documentation

class _PollableWritePipe(_PollableResource): (source)

Constructor: _PollableWritePipe(writePipe, lostCallback)

Implements interfaces: twisted.internet.interfaces.IConsumer

View In Hierarchy

Undocumented

Method __init__ Undocumented
Method bufferEmpty Undocumented
Method bufferFull Undocumented
Method checkWork Undocumented
Method close Undocumented
Method registerProducer Register to receive data from a producer.
Method unregisterProducer Stop consuming data from a producer, without disconnecting.
Method write Append some bytes to the output buffer.
Method writeConnectionLost Undocumented
Method writeSequence Append a list or tuple of bytes to the output buffer.
Instance Variable disconnecting Undocumented
Instance Variable lostCallback Undocumented
Instance Variable outQueue Undocumented
Instance Variable producer Undocumented
Instance Variable producerPaused Undocumented
Instance Variable streamingProducer Undocumented
Instance Variable writePipe Undocumented

Inherited from _PollableResource:

Method activate Undocumented
Method deactivate Undocumented
Instance Variable active Undocumented
def __init__(self, writePipe, lostCallback): (source)

Undocumented

def bufferEmpty(self): (source)

Undocumented

def bufferFull(self): (source)

Undocumented

def checkWork(self): (source)

Undocumented

def close(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 write(self, data): (source)
from twisted.internet.interfaces.IConsumer

Append some bytes to the output buffer.

Parameters
data:str.str to be appended to the output buffer.
Raises
TypeErrorIf data is unicode instead of str.
def writeConnectionLost(self): (source)

Undocumented

def writeSequence(self, seq): (source)

Append a list or tuple of bytes to the output buffer.

Parameters
seqlist or tuple of str instances to be appended to the output buffer.
Raises
TypeErrorIf seq contains unicode.
disconnecting: bool = (source)

Undocumented

lostCallback = (source)

Undocumented

outQueue: list = (source)

Undocumented

producer = (source)

Undocumented

producerPaused: bool = (source)

Undocumented

streamingProducer: int = (source)

Undocumented

writePipe = (source)

Undocumented