twisted.protocols.policies.ThrottlingFactory

class documentation

class ThrottlingFactory(WrappingFactory): (source)

Constructor: ThrottlingFactory(wrappedFactory, maxConnectionCount, readLimit, writeLimit)

View In Hierarchy

Throttles bandwidth and number of connections.

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

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

Inherited from WrappingFactory:

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

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.
Class Variable noisy Undocumented
Class Variable protocol Undocumented
Instance Variable numPorts Undocumented
def __init__(self, wrappedFactory, maxConnectionCount=sys.maxsize, readLimit=None, writeLimit=None): (source)
overrides twisted.protocols.policies.WrappingFactory.__init__

Undocumented

def buildProtocol(self, addr): (source)
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
addran object implementing IAddress
def callLater(self, period, func): (source)

Wrapper around reactor.callLater for test purpose.

def checkReadBandwidth(self): (source)

Checks if we've passed bandwidth limits.

def checkWriteBandwidth(self): (source)

Undocumented

def registerRead(self, length): (source)

Called by protocol to tell us more bytes were read.

def registerWritten(self, length): (source)

Called by protocol to tell us more bytes were written.

def throttleReads(self): (source)

Throttle reads on all protocols.

def throttleWrites(self): (source)

Throttle writes on all protocols.

def unregisterProtocol(self, p): (source)
overrides twisted.protocols.policies.WrappingFactory.unregisterProtocol

Called by protocols when they go away.

def unthrottleReads(self): (source)

Stop throttling reads on all protocols.

def unthrottleWrites(self): (source)

Stop throttling writes on all protocols.

checkReadBandwidthID = (source)

Undocumented

checkWriteBandwidthID = (source)

Undocumented

connectionCount: int = (source)

Undocumented

maxConnectionCount = (source)

Undocumented

readLimit = (source)

Undocumented

readThisSecond: int = (source)

Undocumented

unthrottleReadsID = (source)

Undocumented

unthrottleWritesID = (source)

Undocumented

writeLimit = (source)

Undocumented

writtenThisSecond: int = (source)

Undocumented