twisted.internet._pollingfile._PollableWritePipe : API documentation

Method	__init__	Undocumented
Instance Variable	disconnecting	Undocumented
Instance Variable	producer	Undocumented
Instance Variable	producerPaused	Undocumented
Instance Variable	streamingProducer	Undocumented
Instance Variable	outQueue	Undocumented
Instance Variable	writePipe	Undocumented
Instance Variable	lostCallback	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:

Instance Variable	active	Undocumented
Method	activate	Undocumented
Method	deactivate	Undocumented

def __init__(self, writePipe, lostCallback): (source)

Undocumented

disconnecting = (source)

Undocumented

(type: bool)

producer = (source)

Undocumented

producerPaused = (source)

Undocumented

(type: bool)

streamingProducer = (source)

Undocumented

outQueue = (source)

Undocumented

(type: list)

writePipe = (source)

Undocumented

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

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.

Parameters	seq	`list` or `tuple` of `str` instances to be appended to the output buffer.
Raises	TypeError	If `seq` contains `unicode`.

def write(self, data): (source)

from twisted.internet.interfaces.IConsumer

Append some bytes to the output buffer.

Parameters	data	`str` to be appended to the output buffer. (type: `str`.)
Raises	TypeError	If `data` is `unicode` instead of `str`.

def checkWork(self): (source)

Undocumented