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 buildProtocol Undocumented
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 Undocumented
Method clientConnectionLost Undocumented
Method doStart Undocumented
Method doStop Undocumented
Method logPrefix Generate a log prefix mentioning both the wrapped factory and this one.
Method registerProtocol Called by protocol to register itself.
Method startedConnecting Undocumented
Instance Variable protocols Undocumented
Instance Variable wrappedFactory Undocumented
def __init__(self, wrappedFactory, maxConnectionCount=sys.maxsize, readLimit=None, writeLimit=None): (source)
def buildProtocol(self, addr): (source)
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