twisted.protocols.pcp.BasicProducerConsumerProxy

class documentation

class BasicProducerConsumerProxy: (source)

Known subclasses: twisted.protocols.pcp.ProducerConsumerProxy

Implements interfaces: twisted.internet.interfaces.IConsumer, twisted.internet.interfaces.IProducer

View In Hierarchy

I can act as a man in the middle between any Producer and Consumer.
Method __init__ Undocumented
Method __repr__ Undocumented
Method finish Undocumented
Method pause​Producing Undocumented
Method register​Producer Register to receive data from a producer.
Method resume​Producing Undocumented
Method stop​Producing Stop producing data.
Method unregister​Producer Stop consuming data from a producer, without disconnecting.
Method write The producer will write data by calling this method.
Class Variable i​Am​Streaming Undocumented
Class Variable outstanding​Pull Undocumented
Class Variable stopped Undocumented
Instance Variable consumer the Consumer I publish to.
Instance Variable paused As a Producer, am I paused?
Instance Variable producer the Producer I subscribe to.
Instance Variable producer​Is​Streaming Undocumented
Instance Variable _buffer Undocumented
def __init__(self, consumer): (source)
overridden in twisted.protocols.htb.ShapedConsumer

Undocumented

def __repr__(self): (source)

Undocumented

Returns
strUndocumented
def finish(self): (source)

Undocumented

def pauseProducing(self): (source)
overridden in twisted.protocols.pcp.ProducerConsumerProxy

Undocumented

def registerProducer(self, producer, streaming): (source)
from twisted.internet.interfaces.IConsumer
overridden in twisted.protocols.pcp.ProducerConsumerProxy

Register to receive data from a producer.

This sets self to be a consumer for a producer. When this object runs out of data (as when a send(2) call on a socket succeeds in moving the last data from a userspace buffer into a kernelspace buffer), it will ask the producer to resumeProducing().

For IPullProducer providers, resumeProducing will be called once each time data is required.

For IPushProducer providers, pauseProducing will be called whenever the write buffer fills up and resumeProducing will only be called when it empties. The consumer will only call resumeProducing to balance a previous pauseProducing call; the producer is assumed to start in an un-paused state.

Parameters
producerUndocumented
streamingTrue if producer provides IPushProducer, False if producer provides IPullProducer.
Raises
RuntimeErrorIf a producer is already registered.
def resumeProducing(self): (source)
overridden in twisted.protocols.pcp.ProducerConsumerProxy

Undocumented

def stopProducing(self): (source)
from twisted.internet.interfaces.IProducer
overridden in twisted.protocols.htb.ShapedConsumer

Stop producing data.

This tells a producer that its consumer has died, so it must stop producing data for good.

def unregisterProducer(self): (source)
from twisted.internet.interfaces.IConsumer
overridden in twisted.protocols.pcp.ProducerConsumerProxy
Stop consuming data from a producer, without disconnecting.
def write(self, data): (source)
from twisted.internet.interfaces.IConsumer
overridden in twisted.protocols.pcp.ProducerConsumerProxy

The producer will write data by calling this method.

The implementation must be non-blocking and perform whatever buffering is necessary. If the producer has provided enough data for now and it is a IPushProducer, the consumer may call its pauseProducing method.

iAmStreaming: bool = (source)
overridden in twisted.protocols.htb.ShapedConsumer

Undocumented

outstandingPull: bool = (source)
overridden in twisted.protocols.pcp.ProducerConsumerProxy

Undocumented

stopped: bool = (source)

Undocumented

consumer: IConsumer = (source)
the Consumer I publish to.
paused: bool = (source)
overridden in twisted.protocols.pcp.ProducerConsumerProxy
As a Producer, am I paused?
producer: IProducer = (source)
the Producer I subscribe to.
producerIsStreaming = (source)

Undocumented

_buffer: list = (source)

Undocumented