class documentation

class LengthEnforcingConsumer: (source)

View In Hierarchy

An IConsumer proxy which enforces an exact length requirement on the total data written to it.
Method __init__ Undocumented
Method write Write bytes to the underlying consumer unless _noMoreWritesExpected has been called or there are/have been too many bytes.
Method _allowNoMoreWrites Indicate that no additional writes are allowed. Attempts to write after calling this method will be met with an exception.
Method _noMoreWritesExpected Called to indicate no more bytes will be written to this consumer. Check to see that the correct number have been written.
Instance Variable _consumer The consumer to which at most _length bytes will be forwarded.
Instance Variable _finished A Deferred which will be fired with a Failure if too many bytes are written to this consumer.
Instance Variable _length The number of bytes remaining to be written.
Instance Variable _producer The IBodyProducer which is writing to this consumer.
def __init__(self, producer, consumer, finished): (source)

Undocumented

def write(self, bytes): (source)
Write bytes to the underlying consumer unless _noMoreWritesExpected has been called or there are/have been too many bytes.
def _allowNoMoreWrites(self): (source)
Indicate that no additional writes are allowed. Attempts to write after calling this method will be met with an exception.
def _noMoreWritesExpected(self): (source)
Called to indicate no more bytes will be written to this consumer. Check to see that the correct number have been written.
Raises
WrongBodyLengthIf not enough bytes have been written.
_consumer = (source)
The consumer to which at most _length bytes will be forwarded.
_finished = (source)
A Deferred which will be fired with a Failure if too many bytes are written to this consumer.
_length = (source)
The number of bytes remaining to be written.
_producer = (source)
The IBodyProducer which is writing to this consumer.