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 Make a connection to a transport and a server.
Method loseConnection Undocumented
Method getPeer Undocumented
Method getHost Undocumented
Method stopConsuming Undocumented
Method __getattr__ Undocumented
Method connectionMade Called when a connection is made.
Method connectionLost Called when the connection is shut down.
def write(self, data): (source)
Undocumented
def writeSequence(self, seq): (source)
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.
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)
Undocumented
def unregisterProducer(self): (source)
Undocumented
def throttleReads(self): (source)
Undocumented
def unthrottleReads(self): (source)
Undocumented
def throttleWrites(self): (source)
Undocumented
def unthrottleWrites(self): (source)
Undocumented
API Documentation for Twisted, generated by pydoctor at 2011-10-27 15:57:47.