/usr/lib/python3/dist-packages/twisted/protocols/__pycache__
Edit: /usr/lib/python3/dist-packages/twisted/protocols/__pycache__/policies.cpython-310.pyc (23849B)
o
b{S @ sB d Z ddlZddlmZmZ ddlmZmZ ddlm Z m
Z
ddl m Z ddl
mZmZmZ ddlmZ d d
ZG d d d eZG d
d deZG dd deZG dd deZG dd deZG dd deZG dd deZG dd deZG dd d eZ G d d d eZ G d d d eZ G d!d" d"eZ G d#d$ d$Z dS )%z]
Resource limiting policies.
@seealso: See also L{twisted.protocols.htb} for rate limiting.
N)OptionalType)directlyProvides
providedBy)error
interfaces)ILoggingContext)
ClientFactoryProtocol
ServerFactory)logc C s0 t |r
| }n|jj}| d| jj dS )zY
Compute a log prefix for a wrapper and the object it wraps.
@rtype: C{str}
z ())r r logPrefix __class____name__)wrapperwrappedr r }
provider to which L{IProtocol
}
method calls onto this L{ProtocolWrapper} will be proxied.
@ivar factory: The L{WrappingFactory} which created this
L{ProtocolWrapper}.
r factoryWrappingFactorywrappedProtocolc C s || _ || _d S N)r r )selfr r r r r __init__5 s
zProtocolWrapper.__init__c C t | | jS )zo
Use a customized log prefix mentioning both the wrapped protocol and
the current one.
)r r r r r r r ; s zProtocolWrapper.logPrefixc C s6 t | t| t| | | j| | j| dS )z
When a connection is made, register this wrapper with its factory,
save the real transport, and connect the wrapped protocol to this
L{ProtocolWrapper} to intercept any transport calls it makes.
N)r r r
makeConnectionr registerProtocolr )r transportr r r r B s z ProtocolWrapper.makeConnectionc C | j | d S r )r! writer datar r r r# O zProtocolWrapper.writec C r" r )r!
writeSequencer$ r r r r' R r& z ProtocolWrapper.writeSequencec C s d| _ | j d S N )
disconnectingr! loseConnectionr r r r r+ U s z ProtocolWrapper.loseConnectionc C
| j S r )r! getPeerr r r r r- Y
zProtocolWrapper.getPeerc C r, r )r! getHostr r r r r/ \ r. zProtocolWrapper.getHostc C | j || d S r )r! registerProducerr producer streamingr r r r1 _ z ProtocolWrapper.registerProducerc C | j d S r )r! unregisterProducerr r r r r7 b z"ProtocolWrapper.unregisterProducerc C r6 r )r!
stopConsumingr r r r r9 e r8 z ProtocolWrapper.stopConsumingc C s t | j|S r )getattrr! r namer r r __getattr__h s zProtocolWrapper.__getattr__c C r" r )r dataReceivedr$ r r r r> m r& z ProtocolWrapper.dataReceivedc C s" | j | | j| d | _d S r )r unregisterProtocolr connectionLostr reasonr r r r@ p s
z ProtocolWrapper.connectionLostN)r
__module__ __qualname____doc__r* r IProtocolr r r r# r' r+ r- r/ r1 r7 r9 r= r> r@ r r r r r ' s*
r c @ sr e Zd ZU dZeZee ed< dd Z dd Z
dd Z d d
Z d d Z
d
d Zdd Zdd Zdd Zdd ZdS )r zE
Wraps a factory and its protocols, and keeps track of them.
protocolc C s || _ i | _d S r )wrappedFactory protocols)r rH r r r r s
zWrappingFactory.__init__c C r )zY
Generate a log prefix mentioning both the wrapped factory and this one.
)r rH r r r r r zWrappingFactory.logPrefixc C | j t| d S r )rH doStartr r r r r rL
zWrappingFactory.doStartc C rK r )rH doStopr r r r r rN rM zWrappingFactory.doStopc C r" r )rH startedConnecting)r connectorr r r rO r& z!WrappingFactory.startedConnectingc C r0 r )rH clientConnectionFailedr rP rB r r r rQ r5 z&WrappingFactory.clientConnectionFailedc C r0 r )rH clientConnectionLostrR r r r rS r5 z$WrappingFactory.clientConnectionLostc C s | | | j|S r )rG rH
buildProtocolr addrr r r rT s z WrappingFactory.buildProtocolc C s d| j |< dS )z8
Called by protocol to register itself.
r) NrI r pr r r r s z WrappingFactory.registerProtocolc C s | j |= dS )z8
Called by protocols when they go away.
NrW rX r r r r? rJ z"WrappingFactory.unregisterProtocolN)r rC rD rE r rG r r
__annotations__r r rL rN rO rQ rS rT r r? r r r r r x s
r c @ sX e Zd ZdZdd Zdd Zdd Zdd Zd
d Zd d
Z dd Z
dd Z dd Z dS )ThrottlingProtocolz,
Protocol for L{ThrottlingFactory}.
c C | j t| t| | d S r )r registerWrittenlenr r# r$ r r r r# zThrottlingProtocol.writec C s& | j ttt| t| | d S r )r r] summapr^ r r' r seqr r r r' s z ThrottlingProtocol.writeSequencec C r\ r )r registerReadr^ r r> r$ r r r r> r_ z ThrottlingProtocol.dataReceivedc C s || _ t| || d S r )r3 r r1 r2 r r r r1 s z#ThrottlingProtocol.registerProducerc C s | ` t| d S r )r3 r r7 r r r r r7 s z%ThrottlingProtocol.unregisterProducerc C r6 r )r! pauseProducingr r r r
throttleReads r8 z ThrottlingProtocol.throttleReadsc C r6 r )r! resumeProducingr r r r unthrottleReads r8 z"ThrottlingProtocol.unthrottleReadsc C t | dr | j d S d S Nr3 )hasattrr3 re r r r r throttleWrites
z!ThrottlingProtocol.throttleWritesc C ri rj )rk r3 rg r r r r unthrottleWrites rm z#ThrottlingProtocol.unthrottleWritesN)
r rC rD rE r# r' r> r1 r7 rf rh rl rn r r r r r[ s r[ c @ s~ e Zd ZdZeZejddfddZdd Z dd Z
d d
Z d d Z d
d Z
dd Zdd Zdd Zdd Zdd Zdd ZdS )ThrottlingFactoryz
Throttles bandwidth and number of connections.
Write bandwidth will only be throttled if there is a producer
registered.
Nc C sL t | | d| _|| _|| _|| _d| _d| _d | _d | _ d | _
d | _ d S Nr ) r r connectionCountmaxConnectionCount readLimit
writeLimitreadThisSecondwrittenThisSecondunthrottleReadsIDcheckReadBandwidthIDunthrottleWritesIDcheckWriteBandwidthID)r rH rr rs rt r r r r s
zThrottlingFactory.__init__c C ddl m} |||S z
Wrapper around
L{reactor.callLater}
for test purpose.
r )reactortwisted.internetr} callLaterr periodfuncr} r r r r zThrottlingFactory.callLaterc C | j |7 _ dS )zH
Called by protocol to tell us more bytes were written.
N)rv r lengthr r r r] z!ThrottlingFactory.registerWrittenc C r )zE
Called by protocol to tell us more bytes were read.
N)ru r r r r rd r z ThrottlingFactory.registerReadc C sR | j | jkr | t| j | j d }| || j| _d| _ | d| j| _dS )z:
Checks if we've passed bandwidth limits.
?r r) N) ru rs rf floatr rh rw checkReadBandwidthrx r throttleTimer r r r s z$ThrottlingFactory.checkReadBandwidthc C sR | j | jkr | t| j | j d }| || j| _d| _ | d| j| _d S )Nr r r) ) rv rt rl r r rn ry checkWriteBandwidthrz r r r r r s z%ThrottlingFactory.checkWriteBandwidthc C * t d| | j D ]}| q dS )z2
Throttle reads on all protocols.
zThrottling reads on %sN)r msgrI keysrf rX r r r rf
z ThrottlingFactory.throttleReadsc C 0 d| _ td| | j D ]}| qdS )z9
Stop throttling reads on all protocols.
Nz Stopped throttling reads on %s)rw r r rI r rh rX r r r rh %
z!ThrottlingFactory.unthrottleReadsc C r )z3
Throttle writes on all protocols.
zThrottling writes on %sN)r r rI r rl rX r r r rl . r z ThrottlingFactory.throttleWritesc C r )z:
Stop throttling writes on all protocols.
Nz Stopped throttling writes on %s)ry r r rI r rn rX r r r rn 6 r z"ThrottlingFactory.unthrottleWritesc C sb | j dkr| jd ur| | jd ur| | j | jk r*| j d7 _ t| |S t d d S )Nr r) z Max connection count reached!)
rq rs r rt r rr r rT r r rU r r r rT ? s
z ThrottlingFactory.buildProtocolc C s t | | | jd8 _| jdkr<| jd ur | j | jd ur&| j | jd ur0| j | jd ur>| j d S d S d S Nr) r )r r? rq rw cancelrx ry rz rX r r r r? M s
z$ThrottlingFactory.unregisterProtocol)r rC rD rE r[ rG sysmaxsizer r r] rd r r rf rh rl rn rT r? r r r r ro s$
ro c @ s e Zd Zdd Zdd ZdS )SpewingProtocolc C t d| t| | d S )Nz Received: %r)r r r r> r$ r r r r> \ z SpewingProtocol.dataReceivedc C r )Nz Sending: %r)r r r r# r$ r r r r# ` r zSpewingProtocol.writeN)r rC rD r> r# r r r r r [ s r c @ s e Zd ZeZdS )SpewingFactoryN)r rC rD r rG r r r r r e s r c @ s( e Zd ZdZdd Zdd Zdd ZdS ) LimitConnectionsByPeer c C s
i | _ d S r )peerConnectionsr r r r startFactorym r. z#LimitConnectionsByPeer.startFactoryc C s> |d }| j |d}|| jkrd S |d | j |< t| |S )Nr r) )r getmaxConnectionsPerPeerr rT )r rV peerHostrq r r r rT p s
z$LimitConnectionsByPeer.buildProtocolc C s< | d }| j| d8 < | j| dkr | j|= d S d S r )r- r )r rY r r r r r? x s
z)LimitConnectionsByPeer.unregisterProtocolN)r rC rD r r rT r? r r r r r i s
r c @ sF e Zd ZU dZdZdZdZeee e
d< dd Z dd Z d d
Z
dS ) LimitTotalConnectionsFactorya
Factory that limits the number of simultaneous connections.
@type connectionCount: C{int}
@ivar connectionCount: number of current connections.
@type connectionLimit: C{int} or L{None}
@cvar connectionLimit: maximum number of connections.
@type overflowProtocol: L{Protocol} or L{None}
@cvar overflowProtocol: Protocol to use for new connections when
connectionLimit is exceeded. If L{None} (the default value), excess
connections will be closed immediately.
r NoverflowProtocolc C sX | j d u s | j| j k r| }n | jd u rd S | }| |_t| |}| jd7 _|S r( )connectionLimitrq rG r r r )r rV r rG r r r rT s
z*LimitTotalConnectionsFactory.buildProtocolc C s d S r r rX r r r r s z-LimitTotalConnectionsFactory.registerProtocolc C s | j d8 _ d S r( )rq rX r r r r? r5 z/LimitTotalConnectionsFactory.unregisterProtocol)r rC rD rE rq r r r r r
rZ rT r r? r r r r r s
r c @ sZ e Zd ZdZdd ZdddZdd Zd d
Zd d Zd
d Z dd Z
dd Z dd Z dS )TimeoutProtocolzN
Protocol that automatically disconnects when the connection is idle.
c C s( t | || d| _d| _| | dS )z
Constructor.
@param factory: An L{TimeoutFactory}.
@param wrappedProtocol: A L{Protocol} to wrapp.
@param timeoutPeriod: Number of seconds to wait for activity before
timing out.
N)r r timeoutCall
timeoutPeriod
setTimeout)r r r r r r r r s zTimeoutProtocol.__init__Nc C s2 | || _|dur| j| j| j| _dS dS )z
Set a timeout.
This will cancel any existing timeouts.
@param timeoutPeriod: If not L{None}, change the timeout period.
Otherwise, use the existing value.
N)
cancelTimeoutr r r timeoutFuncr )r r r r r r s
zTimeoutProtocol.setTimeoutc C sD d| _ | jr z| j W n
tjtjfy Y nw d| _dS dS )zg
Cancel the timeout.
If the timeout was already cancelled, this does nothing.
N)r r r r
AlreadyCalledAlreadyCancelledr r r r r s
z TimeoutProtocol.cancelTimeoutc C s | j r | j | j dS dS )zQ
Reset the timeout, usually because some activity just happened.
N)r resetr r r r r resetTimeout s z TimeoutProtocol.resetTimeoutc C | t| | d S r )r r r# r$ r r r r# zTimeoutProtocol.writec C r r )r r r' rb r r r r' r z TimeoutProtocol.writeSequencec C r r )r r r> r$ r r r r> r z TimeoutProtocol.dataReceivedc C r r )r r r@ rA r r r r@ r z TimeoutProtocol.connectionLostc C s | dS )z
This method is called when the timeout is triggered.
By default it calls I{loseConnection}. Override this if you want
something else to happen.
N)r+ r r r r r s zTimeoutProtocol.timeoutFuncr )
r rC rD rE r r r r r# r' r> r@ r r r r r r s
r c @ s. e Zd ZdZeZd
ddZdd Zdd Zd S ) TimeoutFactoryz%
Factory for TimeoutWrapper.
c C s || _ t| | d S r )r r r )r rH r r r r r s zTimeoutFactory.__init__c C s | j | | j|| jdS )N)r )rG rH rT r rU r r r rT s
z TimeoutFactory.buildProtocolc C r{ r| r~ r r r r r r zTimeoutFactory.callLaterN)r ) r rC rD rE r rG r rT r r r r r r s
r c @ sV e Zd ZdddZdd Zdd Zd d
Zd d Zd
d Zdd Z dd Z
dd Z dS )TrafficLoggingProtocolNr c C s$ t | || || _|| _|| _dS )a
@param factory: factory which created this protocol.
@type factory: L{protocol.Factory}.
@param wrappedProtocol: the underlying protocol.
@type wrappedProtocol: C{protocol.Protocol}.
@param logfile: file opened for writing used to write log messages.
@type logfile: C{file}
@param lengthLimit: maximum size of the datareceived logged.
@type lengthLimit: C{int}
@param number: identifier of the connection.
@type number: C{int}.
N)r r logfile lengthLimit_number)r r r r r numberr r r r s
z TrafficLoggingProtocol.__init__c C s | j |d | j d S )N
)r r# flush)r liner r r _log* s zTrafficLoggingProtocol._logc C s. | j rt|| j kr|d | j d d }|S )N z <... elided>)r r^ r$ r r r
_mungeData. s z!TrafficLoggingProtocol._mungeDatac C s | d t| S )N*)r r connectionMader r r r r 4 s
z%TrafficLoggingProtocol.connectionMadec C & | d| j| |f t| |S NzC %d: %r)r r r r r> r$ r r r r> 8 z#TrafficLoggingProtocol.dataReceivedc C s | d| j|f t| |S r )r r r r@ rA r r r r@ < s z%TrafficLoggingProtocol.connectionLostc C r )NzS %d: %r)r r r r r# r$ r r r r# A r z TrafficLoggingProtocol.writec s. d j fdd|D f t |S )Nz SV %d: %rc s g | ]} |qS r )r ).0dr r r
F s z8TrafficLoggingProtocol.writeSequence..)r r r r' )r iovecr r r r' E s " z$TrafficLoggingProtocol.writeSequencec C s | d| jf t| S )NzS %d: *)r r r r+ r r r r r+ I s
z%TrafficLoggingProtocol.loseConnectionrp ) r rC rD r r r r r> r@ r# r' r+ r r r r r s
r c @ s6 e Zd ZeZdZd ddZdd Zdd Zd d
Z dS ) TrafficLoggingFactoryr Nc C s || _ || _t| | d S r )
logfilePrefixr r r )r rH r r r r r r S s z TrafficLoggingFactory.__init__c C s
t |dS )Nw)openr; r r r r X r. zTrafficLoggingFactory.openc C sF | j d7 _ | | jd t| j }| | | j||| j| j S )Nr) -)_counterr r strrG rH rT r )r rV r r r r rT [ s
z#TrafficLoggingFactory.buildProtocolc C s
d| _ dS )zN
Reset the value of the counter used to identify connections.
r N)r r r r r resetCounterf s
z"TrafficLoggingFactory.resetCounterr )
r rC rD r rG r r r rT r r r r r r N s
r c @ sN e Zd ZU dZdZee ed< dZdd Z dd Z
dd Z d
d Z d d
Z
dS ) TimeoutMixinaL
Mixin for protocols which wish to timeout connections.
Protocols that mix this in have a single timeout, set using L{setTimeout}.
When the timeout is hit, L{timeoutConnection} is called, which, by
default, closes the connection.
@cvar timeOut: The number of seconds after which to timeout the connection.
NtimeOutc C r{ r| r~ r r r r r | r zTimeoutMixin.callLaterc C s. | j dur| jdur| j | j dS dS dS )a
Reset the timeout count down.
If the connection has already timed out, then do nothing. If the
timeout has been cancelled (probably using C{setTimeout(None)}), also
do nothing.
It's often a good idea to call this when the protocol has received
some meaningful input from the other end of the connection. "I've got
some data, they're still there, reset the timeout".
N)_TimeoutMixin__timeoutCallr r r r r r r s zTimeoutMixin.resetTimeoutc C s~ | j }|| _ | jdur1|du r)z| j W n
tjtjfy# Y nw d| _|S | j| |S |dur=| || j| _|S )z
Change the timeout period
@type period: C{int} or L{None}
@param period: The period, in seconds, to change the timeout to, or
L{None} to disable the timeout.
N) r r r r r r r r _TimeoutMixin__timedOut)r r prevr r r r s
zTimeoutMixin.setTimeoutc C s d | _ | d S r )r timeoutConnectionr r r r
__timedOut s zTimeoutMixin.__timedOutc C s | j dS )z
Called when the connection times out.
Override to define behavior other than dropping the connection.
N)r! r+ r r r r r s z TimeoutMixin.timeoutConnection)r rC rD rE r r intrZ r r r r r r r r r r r m s
r )!rE r typingr r zope.interfacer r r r r twisted.internet.interfacesr twisted.internet.protocolr r
r twisted.pythonr r r r r[ ro r r r r r r r r r r r r r s.
Q2*
)R 7