twisted.protocols.amp.IBoxReceiver

interface documentation

class IBoxReceiver(Interface):

Known implementations: twisted.protocols.amp.BoxDispatcher

View In Hierarchy

An application object which can receive AmpBox objects and dispatch them appropriately.

Method ampBoxReceived A box was received from the transport; dispatch it appropriately.
Method startReceivingBoxes The IBoxReceiver.ampBoxReceived method will start being called; boxes may be responded to by responding to the given IBoxSender.
Method stopReceivingBoxes No further boxes will be received on this connection.
def ampBoxReceived(box):

A box was received from the transport; dispatch it appropriately.

def startReceivingBoxes(boxSender):

The IBoxReceiver.ampBoxReceived method will start being called; boxes may be responded to by responding to the given IBoxSender.

Parameters
boxSenderan IBoxSender provider.
def stopReceivingBoxes(reason):

No further boxes will be received on this connection.

Parameters
reason:FailureUndocumented