class documentation

class ThrottlingFactory(WrappingFactory): (source)

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 build​Protocol Create an instance of a subclass of Protocol.
Method call​Later Wrapper around reactor.callLater for test purpose.
Method check​Read​Bandwidth Checks if we've passed bandwidth limits.
Method check​Write​Bandwidth Undocumented
Method register​Read Called by protocol to tell us more bytes were read.
Method register​Written Called by protocol to tell us more bytes were written.
Method throttle​Reads Throttle reads on all protocols.
Method throttle​Writes Throttle writes on all protocols.
Method unregister​Protocol Called by protocols when they go away.
Method unthrottle​Reads Stop throttling reads on all protocols.
Method unthrottle​Writes Stop throttling writes on all protocols.
Instance Variable check​Read​Bandwidth​ID Undocumented
Instance Variable check​Write​Bandwidth​ID Undocumented
Instance Variable connection​Count Undocumented
Instance Variable max​Connection​Count Undocumented
Instance Variable read​Limit Undocumented
Instance Variable read​This​Second Undocumented
Instance Variable unthrottle​Reads​ID Undocumented
Instance Variable unthrottle​Writes​ID Undocumented
Instance Variable write​Limit Undocumented
Instance Variable written​This​Second Undocumented

Inherited from WrappingFactory:

Method client​Connection​Failed Called when a connection has failed to connect.
Method client​Connection​Lost Called when an established connection is lost.
Method do​Start Make sure startFactory is called.
Method do​Stop Make sure stopFactory is called.
Method log​Prefix Generate a log prefix mentioning both the wrapped factory and this one.
Method register​Protocol Called by protocol to register itself.
Method started​Connecting Called when a connection has been started.
Instance Variable protocols Undocumented
Instance Variable wrapped​Factory Undocumented

Inherited from Factory (via WrappingFactory, ClientFactory):

Class Method for​Protocol Create a factory for the given protocol.
Method start​Factory This will be called before I begin listening on a Port or Connector.
Method stop​Factory This will be called before I stop listening on all Ports/Connectors.
Class Variable noisy Undocumented
Class Variable protocol Undocumented
Instance Variable num​Ports Undocumented
def __init__(self, wrappedFactory, maxConnectionCount=sys.maxsize, readLimit=None, writeLimit=None): (source)
def buildProtocol(self, addr): (source)

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