B
0²ô`à$ ã @ sÀ d Z ddlmZ ddlmZ ddlmZmZ ddlmZ G dd„ dƒZ G dd „ d eƒZ
ee
ƒG d
d „ d ƒƒZ G d d
„ d
e ƒZ G dd„ de ƒZ
G dd„ dejƒZG dd„ deƒZG dd„ dƒZdS )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)Ú implementerÚ Interface)Úpcpc @ s6 e Zd ZdZdZdZdZd
dd„Zdd„ Zdd „ 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}
Nr 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 úD/home/dcms/DCMS/lib/python3.7/site-packages/twisted/protocols/htb.pyÚ__init__2 s zBucket.__init__c C sR | ¡ | jdkr|}nt|| j| j ƒ}| jdk r@| 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)ÚdripÚmaxburstÚminr r Úadd)r ÚamountZ allowabler r r
r ? s
z
Bucket.addc C sb | j dk r| j ¡ | jdkr&d| _n2tƒ }|| 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 Úrater r r
Úmax)r ÚnowZ deltaTimeZ deltaTokensr r r
r W s
z Bucket.drip)N)
Ú__name__Ú
__module__Ú __qualname__Ú__doc__r r Ú _refcountr r r r r r r
r s
r c @ s e Zd Zdd„ ZdS )Ú
IBucketFilterc O s dS )zn
Return a L{Bucket} corresponding to the provided parameters.
@returntype: L{Bucket}
Nr )Z
somethingsZsome_kwr r r
Ú getBucketForp s zIBucketFilter.getBucketForN)r r r r r r r r
r o s r c @ s: e Zd ZdZeZdZd dd„Zdd„ Zdd„ 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}
Nc C s i | _ || _tƒ | _d S )N)ÚbucketsÚ parentFilterr Ú lastSweep)r r r r r
r † s z!HierarchicalBucketFilter.__init__c O s| | j dk r$tƒ | j | j kr$| ¡ | jr@| jj| f|ž|Ž}nd}| j||Ž}| j |¡}|dkrx| |¡}|| 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)
Ú
sweepIntervalr r! Úsweepr r Ú getBucketKeyr ÚgetÚ
bucketFactory)r ÚaÚkwr ÚkeyÚbucketr r r
r ‹ s
z%HierarchicalBucketFilter.getBucketForc O s dS )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 r' r( r r r
r$ ¥ s z%HierarchicalBucketFilter.getBucketKeyc C sB x4| j ¡ D ]&\}}| ¡ }|jdkr |r | j |= q W tƒ | _dS )z'
Remove empty buckets.
r N)r Úitemsr r r r! )r r) r* Zbucket_is_emptyr r r
r# ° s
z HierarchicalBucketFilter.sweep)N) r r r r r r& r" r r r$ r# r r r r
r x s
r c @ s e Zd ZdZdZdd„ ZdS )Ú FilterByHostzF
A Hierarchical Bucket filter with a L{Bucket} for each host.
i° c C s | ¡ d S )Né )ZgetPeer)r Ú transportr r r
r$ Ã s zFilterByHost.getBucketKeyN)r r r r r" r$ r r r r
r, ¼ s r, c @ s e Zd ZdZdZdd„ ZdS )ÚFilterByServerzI
A Hierarchical Bucket filter with a L{Bucket} for each service.
Nc C s | ¡ d S )Né )ZgetHost)r r. r r r
r$ Î s zFilterByServer.getBucketKey)r r r r r" r$ r r r r
r/ Ç s r/ 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 )Nr- )r ÚProducerConsumerProxyr r* r )r Úconsumerr* r r r
r Û s zShapedConsumer.__init__c C s& | j t|ƒ¡}tj | |d |… ¡S )N)r* r Úlenr r2 Ú_writeSomeData)r Údatar r r r
r5 à s z ShapedConsumer._writeSomeDatac C s t j | ¡ | j jd8 _d S )Nr- )r r2 Ú
stopProducingr* r )r r r r
r7 è s z ShapedConsumer.stopProducingN)r r r r Ú iAmStreamingr r5 r7 r r r r
r1 Ò s
r1 c @ s e Zd ZdZdZdd„ ZdS )Ú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 )N)Úgetattrr3 )r Únamer r r
Ú __getattr__û s zShapedTransport.__getattr__N)r r r r r8 r< r r r r
r9 í s r9 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 Z
protoClassr? r r r
r s z ShapedProtocolFactory.__init__c s* ˆj ||Ž}|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 )N)r? r r9 )r. r* ZshapedTransport)ÚorigMakeConnectionr r r
ÚmakeConnection+ s
z6ShapedProtocolFactory.__call__..makeConnection)r> rA )r r' r( ÚprotorA r )r@ r r
Ú__call__ s
z ShapedProtocolFactory.__call__N)r r r r r rC r r r r
r= s r= N)r r Útypingr Zzope.interfacer r Ztwisted.protocolsr r r r r, r/ r2 r1 r9 r= r r r r
Ú s R D