t.p.p.ThrottlingProtocol(ProtocolWrapper) : class documentation

Part of twisted.protocols.policies View Source View In Hierarchy

Protocol for ThrottlingFactory.
Method write Undocumented
Method writeSequence Undocumented
Method dataReceived Called whenever data is received.
Method registerProducer Undocumented
Method unregisterProducer Undocumented
Method throttleReads Undocumented
Method unthrottleReads Undocumented
Method throttleWrites Undocumented
Method unthrottleWrites Undocumented

Inherited from ProtocolWrapper:

Method __init__ Undocumented
Method makeConnection 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 loseConnection Undocumented
Method getPeer Undocumented
Method getHost Undocumented
Method stopConsuming Undocumented
Method __getattr__ Undocumented
Method connectionLost Called when the connection is shut down.

Inherited from BaseProtocol (via ProtocolWrapper, Protocol):

Method connectionMade Called when a connection is made.
def write(self, data): (source)
def writeSequence(self, seq): (source)
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.
Parametersdataa 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 unregisterProducer(self): (source)
def throttleReads(self): (source)
def unthrottleReads(self): (source)
def throttleWrites(self): (source)
def unthrottleWrites(self): (source)
API Documentation for Twisted, generated by pydoctor at 2011-10-27 16:12:41.