t.m.m._MaildirMailboxAppendMessageTask : class documentation

Part of twisted.mail.maildir View Source View In Hierarchy

Implements interfaces: twisted.internet.interfaces.IConsumer

Undocumented
Method __init__ Undocumented
Method startUp Undocumented
Method registerProducer Register to receive data from a producer.
Method prodProducer Undocumented
Method unregisterProducer Stop consuming data from a producer, without disconnecting.
Method write The producer will write data by calling this method.
Method fail Undocumented
Method moveFileToNew Undocumented
Method createTempFile Undocumented
def __init__(self, mbox, msg): (source)
Undocumented
def startUp(self): (source)
Undocumented
def registerProducer(self, producer, streaming): (source)
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.

ParametersstreamingTrue if producer provides IPushProducer, False if producer provides IPullProducer. (type: bool)
ReturnsNone
RaisesRuntimeErrorIf a producer is already registered.
def prodProducer(self): (source)
Undocumented
def unregisterProducer(self): (source)
Stop consuming data from a producer, without disconnecting.
def write(self, data): (source)
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.

def fail(self, err=None): (source)
Undocumented
def moveFileToNew(self): (source)
Undocumented
def createTempFile(self): (source)
Undocumented
API Documentation for Twisted, generated by pydoctor at 2012-06-04 17:20:01.