twisted.protocols.policies.ThrottlingProtocol

class documentation

class ThrottlingProtocol(ProtocolWrapper): (source)

Protocol for ThrottlingFactory.

Method	`dataReceived`	Called whenever data is received.
Method	`registerProducer`	Undocumented
Method	`throttleReads`	Undocumented
Method	`throttleWrites`	Undocumented
Method	`unregisterProducer`	Undocumented
Method	`unthrottleReads`	Undocumented
Method	`unthrottleWrites`	Undocumented
Method	`write`	Undocumented
Method	`writeSequence`	Undocumented
Instance Variable	`producer`	Undocumented

Inherited from ProtocolWrapper:

Method	`__getattr__`	Undocumented
Method	`__init__`	Undocumented
Method	`connectionLost`	Called when the connection is shut down.
Method	`getHost`	Undocumented
Method	`getPeer`	Undocumented
Method	`logPrefix`	Use a customized log prefix mentioning both the wrapped protocol and the current one.
Method	`loseConnection`	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	`stopConsuming`	Undocumented
Instance Variable	`disconnecting`	Undocumented
Instance Variable	`factory`	The `WrappingFactory` which created this `ProtocolWrapper`.
Instance Variable	`wrappedProtocol`	An `IProtocol` provider to which `IProtocol` method calls onto this `ProtocolWrapper` will be proxied.

Method	`connectionMade`	Called when a connection is made.
Instance Variable	`connected`	Undocumented
Instance Variable	`transport`	Undocumented

def dataReceived(self, data): (source)

from twisted.internet.interfaces.IProtocol

overrides twisted.protocols.policies.ProtocolWrapper.dataReceived

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
data	a 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)

overrides twisted.protocols.policies.ProtocolWrapper.registerProducer

Undocumented

def throttleReads(self): (source)

Undocumented

def throttleWrites(self): (source)

Undocumented

def unregisterProducer(self): (source)

overrides twisted.protocols.policies.ProtocolWrapper.unregisterProducer

Undocumented

def unthrottleReads(self): (source)

Undocumented

def unthrottleWrites(self): (source)

Undocumented

def write(self, data): (source)

overrides twisted.protocols.policies.ProtocolWrapper.write

Undocumented

def writeSequence(self, seq): (source)

overrides twisted.protocols.policies.ProtocolWrapper.writeSequence

Undocumented

producer = (source)

Undocumented