twisted.protocols.policies.ThrottlingFactory

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 Undocumented
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 Undocumented
Method client​Connection​Lost Undocumented
Method do​Start Undocumented
Method do​Stop Undocumented
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 Undocumented
Instance Variable protocols Undocumented
Instance Variable wrapped​Factory 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)
overrides twisted.protocols.policies.WrappingFactory.buildProtocol

Undocumented

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