Part of twisted.protocols.pcp View Source View In Hierarchy
Known subclasses: twisted.protocols.htb.ShapedConsumer
ProducerConsumerProxy with a finite buffer.
When my buffer fills up, I have my parent Producer pause until my buffer has room in it again.| Method | pauseProducing | Undocumented |
| Method | resumeProducing | Undocumented |
| Method | write | The producer will write data by calling this method. |
| Method | registerProducer | Register to receive data from a producer. |
| Method | unregisterProducer | Stop consuming data from a producer, without disconnecting. |
| Method | _writeSomeData | Write as much of this data as possible. |
Inherited from BasicProducerConsumerProxy:
| Method | __init__ | Undocumented |
| Method | stopProducing | Stop producing data. |
| Method | finish | Undocumented |
| Method | __repr__ | Undocumented |
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.
IPushProducer
providers, pauseProducing will be called whenever the write
buffer fills up and resumeProducing will only be called when
it empties.
| Parameters | producer | (type: IProducer
provider
) |
| streaming | True if producer provides IPushProducer,
False if producer provides IPullProducer.
(type: bool
) | |
| Returns | None
| |
| Raises | RuntimeError | If a producer is already registered. |
| Returns | The number of bytes written. | |