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
Instance Variable connectionCount Undocumented
Instance Variable maxConnectionCount Undocumented
Instance Variable readLimit Undocumented
Instance Variable writeLimit Undocumented
Instance Variable readThisSecond Undocumented
Instance Variable writtenThisSecond Undocumented
Instance Variable unthrottleReadsID Undocumented
Instance Variable checkReadBandwidthID Undocumented
Instance Variable unthrottleWritesID Undocumented
Instance Variable checkWriteBandwidthID 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 Undocumented
Method unregisterProtocol Called by protocols when they go away.

Inherited from WrappingFactory:

Instance Variable wrappedFactory Undocumented
Instance Variable protocols Undocumented
Method logPrefix Generate a log prefix mentioning both the wrapped factory and this one.
Method doStart Undocumented
Method doStop Undocumented
Method startedConnecting Undocumented
Method clientConnectionFailed Undocumented
Method clientConnectionLost Undocumented
Method registerProtocol Called by protocol to register itself.
def __init__(self, wrappedFactory, maxConnectionCount=sys.maxsize, readLimit=None, writeLimit=None): (source)
overrides twisted.protocols.policies.WrappingFactory.__init__

Undocumented

connectionCount = (source)

Undocumented

(type: int)
maxConnectionCount = (source)

Undocumented

readLimit = (source)

Undocumented

writeLimit = (source)

Undocumented

readThisSecond = (source)

Undocumented

(type: int)
writtenThisSecond = (source)

Undocumented

(type: int)
unthrottleReadsID = (source)

Undocumented

checkReadBandwidthID = (source)

Undocumented

unthrottleWritesID = (source)

Undocumented

checkWriteBandwidthID = (source)

Undocumented

def callLater(self, period, func): (source)

Wrapper around reactor.callLater for test purpose.

def registerWritten(self, length): (source)

Called by protocol to tell us more bytes were written.

def registerRead(self, length): (source)

Called by protocol to tell us more bytes were read.

def checkReadBandwidth(self): (source)

Checks if we've passed bandwidth limits.

def checkWriteBandwidth(self): (source)

Undocumented

def throttleReads(self): (source)

Throttle reads on all protocols.

def unthrottleReads(self): (source)

Stop throttling reads on all protocols.

def throttleWrites(self): (source)

Throttle writes on all protocols.

def unthrottleWrites(self): (source)

Stop throttling writes on all protocols.

def buildProtocol(self, addr): (source)
overrides twisted.protocols.policies.WrappingFactory.buildProtocol

Undocumented

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

Called by protocols when they go away.

API Documentation for Twisted, generated by pydoctor 21.2.0 at 2021-02-28 21:00:42.