o
b$ @ s d Z ddlmZ ddlmZ ddlmZmZ ddlmZ G dd dZ G dd d eZ
ee
G d
d d Z G d d
d
e Z G dd de Z
G dd dejZG dd deZG dd dZdS )a
Hierarchical Token Bucket traffic shaping.
Patterned after U{Martin Devera's Hierarchical Token Bucket traffic
shaper for the Linux kernel}.
@seealso: U{HTB Linux queuing discipline manual - user guide
}
@seealso: U{Token Bucket Filter in Linux Advanced Routing & Traffic Control
HOWTO}
)time)Optional) Interface implementer)pcpc @ sP e Zd ZU dZdZee ed< dZee ed< dZ d ddZ
dd Z d
d Z dS )
Bucketa
Implementation of a Token bucket.
A bucket can hold a certain number of tokens and it drains over time.
@cvar maxburst: The maximum number of tokens that the bucket can
hold at any given time. If this is L{None}, the bucket has
an infinite size.
@type maxburst: C{int}
@cvar rate: The rate at which the bucket drains, in number
of tokens per second. If the rate is L{None}, the bucket
drains instantaneously.
@type rate: C{int}
Nmaxburstrater c C s d| _ || _t | _dS )a(
Create a L{Bucket} that may have a parent L{Bucket}.
@param parentBucket: If a parent Bucket is specified,
all L{add} and L{drip} operations on this L{Bucket}
will be applied on the parent L{Bucket} as well.
@type parentBucket: L{Bucket}
r N)content parentBucketr lastDrip)selfr r 7/usr/lib/python3/dist-packages/twisted/protocols/htb.py__init__3 s zBucket.__init__c C sR | | jdu r |}n t|| j| j }| jdur | j|}| j|7 _|S )at
Adds tokens to the L{Bucket} and its C{parentBucket}.
This will add as many of the C{amount} tokens as will fit into both
this L{Bucket} and its C{parentBucket}.
@param amount: The number of tokens to try to add.
@type amount: C{int}
@returns: The number of tokens that actually fit.
@returntype: C{int}
N)dripr minr
r add)r
amount allowabler r r r @ s
z
Bucket.addc C sb | j dur
| j | jdu rd| _nt }|| j }|| j }td| j| | _|| _| jdkS )z
Let some of the bucket drain.
The L{Bucket} drains at the rate specified by the class
variable C{rate}.
@returns: C{True} if the bucket is empty after this drip.
@returntype: C{bool}
Nr )r r r r
r r max)r
now deltaTime deltaTokensr r r r X s
z Bucket.dripN)
__name__
__module__ __qualname____doc__r r int__annotations__r _refcountr r r r r r r r s
r c @ s e Zd Zdd ZdS )
IBucketFilterc O dS )zn
Return a L{Bucket} corresponding to the provided parameters.
@returntype: L{Bucket}
Nr )
somethingssome_kwr r r getBucketForq s zIBucketFilter.getBucketForN)r r r r& r r r r r" p s r" c @ sH e Zd ZU dZeZdZee e d< d ddZ
dd Z dd Z d
d Z
dS )
HierarchicalBucketFilterz
Filter things into buckets that can be nested.
@cvar bucketFactory: Class of buckets to make.
@type bucketFactory: L{Bucket}
@cvar sweepInterval: Seconds between sweeping out the bucket cache.
@type sweepInterval: C{int}
N
sweepIntervalc C s i | _ || _t | _d S r )buckets parentFilterr lastSweep)r
r* r r r r s z!HierarchicalBucketFilter.__init__c O s | j durt | j | j kr| | jr#| jj| g|R i |}nd}| j|i |}| j|}|du rA| |}|| j|< |S )z
Find or create a L{Bucket} corresponding to the provided parameters.
Any parameters are passed on to L{getBucketKey}, from them it
decides which bucket you get.
@returntype: L{Bucket}
N)
r( r r+ sweepr* r& getBucketKeyr) get
bucketFactory)r
akwr keybucketr r r r& s
z%HierarchicalBucketFilter.getBucketForc O r# )a%
Construct a key based on the input parameters to choose a L{Bucket}.
The default implementation returns the same key for all
arguments. Override this method to provide L{Bucket} selection.
@returns: Something to be used as a key in the bucket cache.
Nr )r
r0 r1 r r r r- s z%HierarchicalBucketFilter.getBucketKeyc C s> | j D ]\}}| }|jdkr|r| j |= qt | _dS )z'
Remove empty buckets.
r N)r) itemsr r! r r+ )r
r2 r3 bucket_is_emptyr r r r, s z HierarchicalBucketFilter.sweepr )r r r r r r/ r( r r r r r& r- r, r r r r r' y s
r' c @ e Zd ZdZdZdd ZdS ) FilterByHostzF
A Hierarchical Bucket filter with a L{Bucket} for each host.
i c C | d S N )getPeerr
transportr r r r- zFilterByHost.getBucketKeyNr r r r r( r- r r r r r7 r7 c @ s e Zd ZdZdZdd ZdS )FilterByServerzI
A Hierarchical Bucket filter with a L{Bucket} for each service.
Nc C r8 )N )getHostr< r r r r- r> zFilterByServer.getBucketKeyr? r r r r rA r@ rA c @ s, e Zd ZdZdZdd Zdd Zdd Zd S )
ShapedConsumerzL
Wraps a C{Consumer} and shapes the rate at which it receives data.
Fc C s( t j| | || _| j jd7 _d S r9 )r ProducerConsumerProxyr r3 r! )r
consumerr3 r r r r s zShapedConsumer.__init__c C s& | j t|}tj| |d | S r )r3 r lenr rE _writeSomeData)r
datar r r r rH s z ShapedConsumer._writeSomeDatac C s t j| | j jd8 _d S r9 )r rE
stopProducingr3 r! )r
r r r rJ s z ShapedConsumer.stopProducingN)r r r r iAmStreamingr rH rJ r r r r rD s rD c @ r6 )ShapedTransportaR
Wraps a C{Transport} and shapes the rate at which it receives data.
This is a L{ShapedConsumer} with a little bit of magic to provide for
the case where the consumer it wraps is also a C{Transport} and people
will be attempting to access attributes this does not proxy as a
C{Consumer} (e.g. C{loseConnection}).
Fc C s t | j|S r )getattrrF )r
namer r r __getattr__ s zShapedTransport.__getattr__N)r r r r rK rO r r r r rL s rL c @ s e Zd ZdZdd Zdd ZdS )ShapedProtocolFactorya
Dispense C{Protocols} with traffic shaping on their transports.
Usage::
myserver = SomeFactory()
myserver.protocol = ShapedProtocolFactory(myserver.protocol,
bucketFilter)
Where C{SomeServerFactory} is a L{twisted.internet.protocol.Factory}, and
C{bucketFilter} is an instance of L{HierarchicalBucketFilter}.
c C s || _ || _dS )a
Tell me what to wrap and where to get buckets.
@param protoClass: The class of C{Protocol} this will generate
wrapped instances of.
@type protoClass: L{Protocol}
class
@param bucketFilter: The filter which will determine how
traffic is shaped.
@type bucketFilter: L{HierarchicalBucketFilter}.
N)protocol bucketFilter)r
protoClassrR r r r r s
z ShapedProtocolFactory.__init__c s. j |i |}|j fdd}||_|S )z
Make a C{Protocol} instance with a shaped transport.
Any parameters will be passed on to the protocol's initializer.
@returns: A C{Protocol} instance with a L{ShapedTransport}.
c s j | }t| |} |S r )rR r& rL )r= r3 shapedTransportorigMakeConnectionr
r r makeConnection, s
z6ShapedProtocolFactory.__call__..makeConnection)rQ rW )r
r0 r1 protorW r rU r __call__! s
z ShapedProtocolFactory.__call__N)r r r r r rY r r r r rP s
rP N)r r typingr zope.interfacer r twisted.protocolsr r r" r' r7 rA rE rD rL rP r r r r s R C