twisted.protocols.policies.ThrottlingFactory

Known subclasses: twisted.test.test_policies.TestableThrottlingFactory

Throttles bandwidth and number of connections.

Write bandwidth will only be throttled if there is a producer registered.

Method	__init__	Undocumented
Method	callLater	Wrapper around `reactor.callLater` for test purpose.
Method	registerWritten	Called by protocol to tell us more bytes were written.
Method	registerRead	Called by protocol to tell us more bytes were read.
Method	checkReadBandwidth	Checks if we've passed bandwidth limits.
Method	checkWriteBandwidth	Undocumented
Method	throttleReads	Throttle reads on all protocols.
Method	unthrottleReads	Stop throttling reads on all protocols.
Method	throttleWrites	Throttle writes on all protocols.
Method	unthrottleWrites	Stop throttling writes on all protocols.
Method	buildProtocol	Create an instance of a subclass of Protocol.
Method	unregisterProtocol	Called by protocols when they go away.

Inherited from WrappingFactory:

Method	logPrefix	Generate a log prefix mentioning both the wrapped factory and this one.
Method	doStart	Make sure startFactory is called.
Method	doStop	Make sure stopFactory is called.
Method	startedConnecting	Called when a connection has been started.
Method	clientConnectionFailed	Called when a connection has failed to connect.
Method	clientConnectionLost	Called when an established connection is lost.
Method	registerProtocol	Called by protocol to register itself.

Inherited from Factory (via WrappingFactory, ClientFactory):

Class Method	forProtocol	Create a factory for the given protocol.
Method	startFactory	This will be called before I begin listening on a Port or Connector.
Method	stopFactory	This will be called before I stop listening on all Ports/Connectors.

def __init__(self, wrappedFactory, maxConnectionCount=sys.maxsize, readLimit=None, writeLimit=None):

overrides twisted.protocols.policies.WrappingFactory.__init__

overridden in twisted.test.test_policies.TestableThrottlingFactory

Undocumented

def callLater(self, period, func):

overridden in twisted.test.test_policies.TestableThrottlingFactory

Wrapper around reactor.callLater for test purpose.

def registerWritten(self, length):

Called by protocol to tell us more bytes were written.

def registerRead(self, length):

Called by protocol to tell us more bytes were read.

def checkReadBandwidth(self):

Checks if we've passed bandwidth limits.

def checkWriteBandwidth(self):

Undocumented

def throttleReads(self):

Throttle reads on all protocols.

def unthrottleReads(self):

Stop throttling reads on all protocols.

def throttleWrites(self):

Throttle writes on all protocols.

def unthrottleWrites(self):

Stop throttling writes on all protocols.

def buildProtocol(self, addr):

from twisted.internet.interfaces.IProtocolFactory

overrides twisted.protocols.policies.WrappingFactory.buildProtocol

Create an instance of a subclass of Protocol.

The returned instance will handle input on an incoming server connection, and an attribute "factory" pointing to the creating factory.

Alternatively, None may be returned to immediately close the new connection.

Override this method to alter how Protocol instances get created.

Parameters addr an object implementing twisted.internet.interfaces.IAddress

def unregisterProtocol(self, p):

overrides twisted.protocols.policies.WrappingFactory.unregisterProtocol

Called by protocols when they go away.

API Documentation for twisted, generated by pydoctor at 2020-03-25 17:34:30.