class documentation

class ThrottlingProtocol(ProtocolWrapper): (source)

View In Hierarchy

Protocol for ThrottlingFactory.
Method data​Received Called whenever data is received.
Method register​Producer Undocumented
Method throttle​Reads Undocumented
Method throttle​Writes Undocumented
Method unregister​Producer Undocumented
Method unthrottle​Reads Undocumented
Method unthrottle​Writes Undocumented
Method write Undocumented
Method write​Sequence Undocumented
Instance Variable producer Undocumented

Inherited from ProtocolWrapper:

Method __getattr__ Undocumented
Method __init__ Undocumented
Method connection​Lost Called when the connection is shut down.
Method get​Host Undocumented
Method get​Peer Undocumented
Method log​Prefix Use a customized log prefix mentioning both the wrapped protocol and the current one.
Method lose​Connection Undocumented
Method make​Connection When a connection is made, register this wrapper with its factory, save the real transport, and connect the wrapped protocol to this ProtocolWrapper to intercept any transport calls it makes.
Method stop​Consuming Undocumented
Instance Variable disconnecting Undocumented
Instance Variable factory The WrappingFactory which created this ProtocolWrapper.
Instance Variable wrapped​Protocol An IProtocol provider to which IProtocol method calls onto this ProtocolWrapper will be proxied.

Inherited from BaseProtocol (via ProtocolWrapper, Protocol):

Method connection​Made Called when a connection is made.
Instance Variable connected Undocumented
Instance Variable transport Undocumented
def dataReceived(self, data): (source)

Called whenever data is received.

Use this method to translate to a higher-level message. Usually, some callback will be made upon the receipt of each complete protocol message.

Parameters
dataa string of indeterminate length. Please keep in mind that you will probably need to buffer some data, as partial (or multiple) protocol messages may be received! I recommend that unit tests for protocols call through to this method with differing chunk sizes, down to one byte at a time.
def registerProducer(self, producer, streaming): (source)
def throttleReads(self): (source)

Undocumented

def throttleWrites(self): (source)

Undocumented

def unregisterProducer(self): (source)
def unthrottleReads(self): (source)

Undocumented

def unthrottleWrites(self): (source)

Undocumented

def write(self, data): (source)
def writeSequence(self, seq): (source)
producer = (source)

Undocumented