/usr/lib/python3/dist-packages/twisted/internet/__pycache__
Edit: /usr/lib/python3/dist-packages/twisted/internet/__pycache__/protocol.cpython-310.pyc (30658B)
o
bj @ s d Z ddlZddlmZmZ ddlmZ ddlmZm Z m
Z
ddl m Z m
Z
ddlmZ ddlmZmZmZ ee
je
jG d d
d
ZG d d d eZG d
d deZG dd dZG dd deZG dd deZG dd dZ e e Z e ee
j!e
jG dd de Z"ee
j#G dd dej$Z%e&e%e
j!e
j# ee
j!G dd d ej$Z'e&e'e
j#e
j! ee
j(G d d d e Z)G d d d Z*ee
jG d!d" d"e*Z+G d#d$ d$e+Z,ee
j
G d%d& d&Z-g d'Z.dS )(z
Standard implementations of Twisted protocol-related interfaces.
Start here if you are looking to write a new protocol implementation for
Twisted. The Protocol class contains some introductory material.
N)CallableOptional) implementer)defererror
interfaces)IAddress
ITransport)
_loggerFor)
componentsfailurelogc @ sl e Zd ZU dZdZded< dZdZedd Z d d
Z
d d Z d
d Z dd Z
dd ZdeddfddZdS )Factoryz
This is a factory which produces protocols.
By default, buildProtocol will create a protocol of the class given in
self.protocol.
Nz Optional[Callable[[], Protocol]]protocolr Tc O s | |i |}||_ |S )a
Create a factory for the given protocol.
It sets the C{protocol} attribute and returns the constructed factory
instance.
@param protocol: A L{Protocol} subclass
@param args: Positional arguments for the factory.
@param kwargs: Keyword arguments for the factory.
@return: A L{Factory} instance wired up to C{protocol}.
)r )clsr argskwargsfactory r ;/usr/lib/python3/dist-packages/twisted/internet/protocol.py forProtocol& s zFactory.forProtocolc C | j jS )z9
Describe this factory for log messages.
__class____name__selfr r r logPrefix: s zFactory.logPrefixc C s6 | j s| jrt| jd| d | | j d | _ dS )zl
Make sure startFactory is called.
Users should not call this function themselves!
z Starting factory {factory!r}r N)numPortsnoisyr
info startFactoryr r r r doStart@ s
zFactory.doStartc C sH | j dkrdS | j d | _ | j s"| jr t| jd| d | dS dS )zk
Make sure stopFactory is called.
Users should not call this function themselves!
r Nr z Stopping factory {factory!r}r )r r! r
r" stopFactoryr r r r doStopL s
zFactory.doStopc C dS )ay
This will be called before I begin listening on a Port or Connector.
It will only be called once, even if the factory is connected
to multiple ports.
This can be used to perform 'unserialization' tasks that
are best put off until things are actually running, such
as connecting to a database, opening files, etcetera.
Nr r r r r r# \ zFactory.startFactoryc C r' )a
This will be called before I stop listening on all Ports/Connectors.
This can be overridden to perform 'shutdown' tasks such as disconnecting
database connections, closing files, etc.
It will be called, for example, before an application shuts down,
if it was connected to a port. User code should not call this function
directly.
Nr r r r r r% h r( zFactory.stopFactoryaddrreturnzOptional[Protocol]c C s | j dusJ | }| |_|S )a
Create an instance of a subclass of Protocol.
The returned instance will handle input on an incoming server
connection, and an attribute "factory" pointing to the creating
factory.
Alternatively, L{None} may be returned to immediately close the
new connection.
Override this method to alter how Protocol instances get created.
@param addr: an object implementing L{IAddress}
N)r r )r r) pr r r
buildProtocolt s zFactory.buildProtocol)r
__module__ __qualname____doc__r __annotations__r r! classmethodr r r$ r& r# r% r r, r r r r r s
r c @ s( e Zd ZdZdd Zdd Zdd ZdS )
ClientFactoryz}
A Protocol factory for clients.
This can be used together with the various connectXXX methods in
reactors.
c C r' )z
Called when a connection has been started.
You can call connector.stopConnecting() to stop the connection attempt.
@param connector: a Connector object.
Nr )r connectorr r r startedConnecting r( z ClientFactory.startedConnectingc C r' )z
Called when a connection has failed to connect.
It may be useful to call connector.connect() - this will reconnect.
@type reason: L{twisted.python.failure.Failure}
Nr r r3 reasonr r r clientConnectionFailed r( z$ClientFactory.clientConnectionFailedc C r' )z
Called when an established connection is lost.
It may be useful to call connector.connect() - this will reconnect.
@type reason: L{twisted.python.failure.Failure}
Nr r5 r r r clientConnectionLost r( z"ClientFactory.clientConnectionLostN)r r- r. r/ r4 r7 r8 r r r r r2 s
r2 c @ sF e Zd ZdZdZdZdd ZdefddZd d
Z d d Z
d
d Z dS )_InstanceFactoryaP
Factory used by ClientCreator.
@ivar deferred: The L{Deferred} which represents this connection attempt and
which will be fired when it succeeds or fails.
@ivar pending: After a connection attempt succeeds or fails, a delayed call
which will fire the L{Deferred} representing this connection attempt.
FNc C s || _ || _|| _d S N)reactorinstancedeferred)r r; r< r= r r r __init__ s
z_InstanceFactory.__init__r* c C s d| j dS )Nz
)r< r r r r __repr__ s z_InstanceFactory.__repr__c C s( | j d| j| jj| j| _d| _| jS )z
Return the pre-constructed protocol instance and arrange to fire the
waiting L{Deferred} to indicate success establishing the connection.
r N)r; callLaterfirer= callbackr< pending)r r) r r r r, s
z _InstanceFactory.buildProtocolc C s$ | j d| j| jj|| _d| _dS )z
Arrange to fire the waiting L{Deferred} with the given failure to
indicate the connection could not be established.
r N)r; rA rB r= errbackrD r5 r r r r7 s
z'_InstanceFactory.clientConnectionFailedc C s d| _ || dS )zo
Clear C{self.pending} to avoid a reference cycle and then invoke func
with the value.
N)rD )r funcvaluer r r rB s z_InstanceFactory.fire) r r- r. r/ r! rD r> strr@ r, r7 rB r r r r r9 s
r9 c @ s> e Zd ZdZdd Zdd Zddd Zdd d Zdd
dZdS )
ClientCreatora
Client connections that do not require a factory.
The various connect* methods create a protocol instance using the given
protocol class and arguments, and connect it, returning a Deferred of the
resulting protocol instance.
Useful for cases when we don't really need a factory. Mainly this
is when there is no shared state between protocol instances, and no need
to reconnect.
The C{connectTCP}, C{connectUNIX}, and C{connectSSL} methods each return a
L{Deferred} which will fire with an instance of the protocol class passed to
L{ClientCreator.__init__}. These Deferred can be cancelled to abort the
connection attempt (in a very unlikely case, cancelling the Deferred may not
prevent the protocol from being instantiated and connected to a transport;
if this happens, it will be disconnected immediately afterwards and the
Deferred will still errback with L{CancelledError}).
c O s || _ || _|| _|| _d S r: )r;
protocolClassr r )r r; rJ r r r r r r> s
zClientCreator.__init__c sL fdd}t |}t| j| j| ji | j|||di| |S )a0
Initiate a connection attempt.
@param method: A callable which will actually start the connection
attempt. For example, C{reactor.connectTCP}.
@param args: Positional arguments to pass to C{method}, excluding the
factory.
@param kwargs: Keyword arguments to pass to C{method}.
@return: A L{Deferred} which fires with an instance of the protocol
class passed to this L{ClientCreator}'s initializer or fails if the
connection cannot be set up for some reason.
c s$ jd urj d S d S r: )
disconnectrD cancel)r= r3 fr r
cancelConnect
s
z-ClientCreator._connect..cancelConnectr )r Deferredr9 r; rJ r r )r methodr r rO dr rM r _connect s
zClientCreator._connect Nc C s | j | jj||||dS )a
Connect to a TCP server.
The parameters are all the same as to L{IReactorTCP.connectTCP} except
that the factory parameter is omitted.
@return: A L{Deferred} which fires with an instance of the protocol
class passed to this L{ClientCreator}'s initializer or fails if the
connection cannot be set up for some reason.
)timeout bindAddress)rS r;
connectTCP)r hostportrU rV r r r rW s zClientCreator.connectTCPFc C s | j | jj|||dS )a
Connect to a Unix socket.
The parameters are all the same as to L{IReactorUNIX.connectUNIX} except
that the factory parameter is omitted.
@return: A L{Deferred} which fires with an instance of the protocol
class passed to this L{ClientCreator}'s initializer or fails if the
connection cannot be set up for some reason.
)rU checkPID)rS r; connectUNIX)r addressrU rZ r r r r[ , s zClientCreator.connectUNIXc C s | j | jj|||||dS )a
Connect to an SSL server.
The parameters are all the same as to L{IReactorSSL.connectSSL} except
that the factory parameter is omitted.
@return: A L{Deferred} which fires with an instance of the protocol
class passed to this L{ClientCreator}'s initializer or fails if the
connection cannot be set up for some reason.
)contextFactoryrU rV )rS r;
connectSSL)r rX rY r] rU rV r r r r^ ; s zClientCreator.connectSSL)rT N)rT F) r r- r. r/ r> rS rW r[ r^ r r r r rI s
rI c @ sn e Zd ZdZdZdZdZdZeZdZ dZ
dZ dZ dZ
dZd d
Zd d Zdd
dZdd Zdd Zdd ZdS )ReconnectingClientFactorya
Factory which auto-reconnects clients with an exponential back-off.
Note that clients should call my resetDelay method after they have
connected successfully.
@ivar maxDelay: Maximum number of seconds between connection attempts.
@ivar initialDelay: Delay for the first reconnection attempt.
@ivar factor: A multiplicitive factor by which the delay grows
@ivar jitter: Percentage of randomness to introduce into the delay length
to prevent stampeding.
@ivar clock: The clock used to schedule reconnection. It's mainly useful to
be parametrized in tests. If the factory is serialized, this attribute
will not be serialized, and the default value (the reactor) will be
restored when deserialized.
@type clock: L{IReactorTime}
@ivar maxRetries: Maximum number of consecutive unsuccessful connection
attempts, after which no further connection attempts will be made. If
this is not explicitly set, no maximum is applied.
i g ?giW
@g6Q؟?r Nr c C | j r || _| d S d S r: continueTryingr3 retryr5 r r r r7 ~ z0ReconnectingClientFactory.clientConnectionFailedc C r` r: ra )r r3
unused_reasonr r r r8 rd z.ReconnectingClientFactory.clientConnectionLostc s j sjrtd d dS du r!jdu r tdj jd7 _jdurBjjkrBjr@td jf dS tj j
j _ j r\t
j j j _ jritd j f fdd }jdu r~d
d lm} |_jj |_dS ) zL
Have this connector connect again, after a suitable delay.
z Abandoning z on explicit requestNzno connector to retryr z Abandoning %s after %d retries.z%s will retry in %d secondsc s d _ d S r: )_callIDconnectr r3 r r r reconnector s z4ReconnectingClientFactory.retry..reconnectorr )r; )rb r! r
msgr3
ValueErrorretries
maxRetriesmindelayfactormaxDelayjitterrandom
normalvariateclocktwisted.internetr; rA rf )r r3 ri r; r rh r rc s:
z ReconnectingClientFactory.retryc C sN | j r | j d| _ d| _| jr%z| j W dS tjy$ Y dS w dS )zE
Put a stop to any attempt to reconnect in progress.
Nr )rf rL rb r3 stopConnectingr NotConnectingErrorr r r r
stopTrying s
z$ReconnectingClientFactory.stopTryingc C s | j | _d| _d| _d| _dS )zt
Call this method after a successful connection: it resets the delay and
the retry counter.
r Nr ) initialDelayro rl rf rb r r r r
resetDelay s
z$ReconnectingClientFactory.resetDelayc C s& | j }dD ] }||v r||= q|S )a-
Remove all of the state which is mutated by connection attempts and
failures, returning just the state which describes how reconnections
should be attempted. This will make the unserialized instance
behave just as this one did when it was first instantiated.
)r3 rl ro rb rf ru __dict__copy)r statekeyr r r __getstate__ s
z&ReconnectingClientFactory.__getstate__r: )r r- r. r/ rq rz rp rr ro rl rm rf r3 ru rb r7 r8 rc ry r{ r r r r r r_ P s&
,
r_ c @ s e Zd ZdZdS )
ServerFactoryzZ
Subclass this to indicate that your protocol.Factory is only usable for servers.
N)r r- r. r/ r r r r r s r c @ s6 e Zd ZU dZdZdZee ed< dd Z dd Z
dS ) BaseProtocola
This is the abstract superclass of all protocols.
Some methods have helpful default implementations here so that they can
easily be shared, but otherwise the direct subclasses of this class are more
interesting, L{Protocol} and L{ProcessProtocol}.
r N transportc C s d| _ || _| dS )z
Make a connection to a transport and a server.
This sets the 'transport' attribute of this Protocol, and calls the
connectionMade() callback.
r N) connectedr connectionMader r r r r makeConnection s zBaseProtocol.makeConnectionc C r' )a
Called when a connection is made.
This may be considered the initializer of the protocol, because
it is called when the connection is completed. For clients,
this is called once the connection to the server has been
established; for servers, this is called after an accept() call
stops blocking and a socket has been received. If you need to
send any greeting or initial message, do it here.
Nr r r r r r r( zBaseProtocol.connectionMade) r r- r. r/ r r r r r0 r r r r r r r s
r c @ sL e Zd ZU dZdZee ed< dd Zde fddZ
e fd e j
fd
d ZdS ) Protocola
This is the base class for streaming connection-oriented protocols.
If you are going to write a new connection-oriented protocol for Twisted,
start here. Any protocol implementation, either client or server, should
be a subclass of this class.
The API is quite simple. Implement L{dataReceived} to handle both
event-based and synchronous input; output can be sent through the
'transport' attribute, which is to be an instance that implements
L{twisted.internet.interfaces.ITransport}. Override C{connectionLost} to be
notified when the connection ends.
Some subclasses exist already to help you write common types of protocols:
see the L{twisted.protocols.basic} module for a few of them.
Nr c C r z~
Return a prefix matching the class name, to identify log messages
related to this protocol instance.
r r r r r r % zProtocol.logPrefixdatac C r' )aF
Called whenever data is received.
Use this method to translate to a higher-level message. Usually, some
callback will be made upon the receipt of each complete protocol
message.
@param data: a string of indeterminate length. Please keep in mind
that you will probably need to buffer some data, as partial
(or multiple) protocol messages may be received! I recommend
that unit tests for protocols call through to this method with
differing chunk sizes, down to one byte at a time.
Nr r r r r r dataReceived, r( zProtocol.dataReceivedr6 c C r' )z
Called when the connection is shut down.
Clear any circular references here, and any external references
to this Protocol. The connection has been closed.
@type reason: L{twisted.python.failure.Failure}
Nr r r6 r r r connectionLost; r( zProtocol.connectionLost)r r- r. r/ r r r r0 r bytesr connectionDoner Failurer r r r r r s
r c @ s* e Zd ZdefddZdd Zdd ZdS ) ProtocolToConsumerAdapterr c C | j | d S r: )originalr r r r r writeH z ProtocolToConsumerAdapter.writec C d S r: r r producer streamingr r r registerProducerK z*ProtocolToConsumerAdapter.registerProducerc C r r: r r r r r unregisterProducerN r z,ProtocolToConsumerAdapter.unregisterProducerN)r r- r. r r r r r r r r r F s r c @ s: e Zd ZdefddZdejfddZdd Zd d
Z d S ) ConsumerToProtocolAdapterr c C r r: )r r r r r r r Y r z&ConsumerToProtocolAdapter.dataReceivedr6 c C r r: r r r r r r \ r z(ConsumerToProtocolAdapter.connectionLostc C r r: r r r r r r _ r z(ConsumerToProtocolAdapter.makeConnectionc C r r: r r r r r r b r z(ConsumerToProtocolAdapter.connectionMadeN)
r r- r. r r r r r r r r r r r r W s
r c @ s e Zd ZdZdedefddZdefddZdefdd Zdefd
d Z d d
Z
dd Z dd Z de
jfddZde
jfddZdS )ProcessProtocolz
Base process protocol implementation which does simple dispatching for
stdin, stdout, and stderr file descriptors.
childFDr c C s0 |dkr | | d S |dkr| | d S d S )Nr ) outReceived errReceived)r r r r r r childDataReceivedr s
z!ProcessProtocol.childDataReceivedc C r' )z5
Some data was received from stdout.
Nr r r r r r x r( zProcessProtocol.outReceivedc C r' )z5
Some data was received from stderr.
Nr r r r r r } r( zProcessProtocol.errReceivedc C s@ |dkr
| d S |dkr| d S |dkr | d S d S )Nr r r )inConnectionLostoutConnectionLosterrConnectionLost)r r r r r childConnectionLost s z#ProcessProtocol.childConnectionLostc C r' )z;
This will be called when stdin is closed.
Nr r r r r r r( z ProcessProtocol.inConnectionLostc C r' )z<
This will be called when stdout is closed.
Nr r r r r r r( z!ProcessProtocol.outConnectionLostc C r' )z<
This will be called when stderr is closed.
Nr r r r r r r( z!ProcessProtocol.errConnectionLostr6 c C r' )zy
This will be called when the subprocess exits.
@type reason: L{twisted.python.failure.Failure}
Nr r r r r
processExited r( z ProcessProtocol.processExitedc C r' )z
Called when the child process exits and all file descriptors
associated with it have been closed.
@type reason: L{twisted.python.failure.Failure}
Nr r r r r processEnded r( z ProcessProtocol.processEndedN)r r- r. r/ intr r r r r r r r r r r r r r r r r k s r c @ sZ e Zd ZdZdZdZdZdd Zdd Zd d
Z d d Z
d
d Z dd Z de
fddZdS )AbstractDatagramProtocolzZ
Abstract protocol for datagram-oriented transports, e.g. IP, ICMP, ARP,
UDP.
Nr Tc C s | j }d |d< |S )Nr r| )r rR r r r r s
z%AbstractDatagramProtocol.__getstate__c C s2 | j s| jr
td| | | j d | _ dS )z
Make sure startProtocol is called.
This will be called by makeConnection(), users should not call it.
zStarting protocol %sr N)r r! r
rj
startProtocolr r r r r$ s
z AbstractDatagramProtocol.doStartc C sJ | j dksJ | j d | _ d| _| j s#| jr td| | dS dS )zw
Make sure stopProtocol is called.
This will be called by the port, users should not call it.
r r NzStopping protocol %s)r r r! r
rj stopProtocolr r r r r& s z AbstractDatagramProtocol.doStopc C r' )z
Called when a transport is connected to this protocol.
Will only be called once, even if multiple ports are connected.
Nr r r r r r r( z&AbstractDatagramProtocol.startProtocolc C r' )z
Called when the transport is disconnected.
Will only be called once, after all ports are disconnected.
Nr r r r r r r( z%AbstractDatagramProtocol.stopProtocolc C s | j dksJ || _ | dS )z
Make a connection to a transport and a server.
This sets the 'transport' attribute of this DatagramProtocol, and calls the
doStart() callback.
N)r r$ r r r r r s z'AbstractDatagramProtocol.makeConnectiondatagramc C r' )z
Called when a datagram is received.
@param datagram: the bytes received from the transport.
@param addr: tuple of source of datagram.
Nr )r r r) r r r datagramReceived r( z)AbstractDatagramProtocol.datagramReceived)r r- r. r/ r r r! r r$ r& r r r r r r r r r r s r c @ s e Zd ZdZdd Zdd ZdS )DatagramProtocola
Protocol for datagram-oriented transport, e.g. UDP.
@type transport: L{None} or
L{IUDPTransport} provider
@ivar transport: The transport with which this protocol is associated,
if it is associated with one.
c C r r r r r r r r r zDatagramProtocol.logPrefixc C r' )z
Called due to error from write in connected mode.
Note this is a result of ICMP message generated by *previous*
write.
Nr r r r r connectionRefused r( z"DatagramProtocol.connectionRefusedN)r r- r. r/ r r r r r r r s r c @ s( e Zd ZdZdd ZdejfddZdS )ConnectedDatagramProtocolz_
Protocol for connected datagram-oriented transport.
No longer necessary for UDP.
c C r' )zw
Called when a datagram is received.
@param datagram: the string received from the transport.
Nr )r r r r r r r( z*ConnectedDatagramProtocol.datagramReceivedr c C r' )zi
Called if connecting failed.
Usually this will be due to a DNS lookup failure.
Nr )r r r r r connectionFailed r( z*ConnectedDatagramProtocol.connectionFailedN)r r- r. r/ r r r r r r r r r s r c @ s e Zd ZdZdZdZdZdZdd Zde fddZ
d d
Z d d Z d
d Z
dd Zdd Zdd Zdd Zdd Zdd Zdd Zd d Zd d ZdS )! FileWrapperz
A wrapper around a file-like object to make it behave as a Transport.
This doesn't actually stream the file to the attached protocol,
and is thus useful mainly as a utility for debugging protocols.
r Nc C s
|| _ d S r: )file)r r r r r r> 3
zFileWrapper.__init__r c C s0 z | j | W d S ty | Y d S w r: )r r
BaseExceptionhandleExceptionr r r r r 6 s
zFileWrapper.writec C s | j r
| j d S d S r: )r resumeProducingr r r r _checkProducer< s zFileWrapper._checkProducerc C s || _ || _|s| dS dS )z.
From abstract.FileDescriptor
N)r streamingProducerr r r r r r B s
z FileWrapper.registerProducerc C s
d | _ d S r: )r r r r r r K r z FileWrapper.unregisterProducerc C s | | d S r: )r loseConnectionr r r r
stopConsumingN s zFileWrapper.stopConsumingc C s | d| d S )N )r join)r iovecr r r
writeSequenceR s zFileWrapper.writeSequencec C s4 d| _ z| j W d S ty | Y d S w )Nr )closedr closeOSErrorr r r r r r U s zFileWrapper.loseConnectionc C r' )N)r r r r r r r getPeer\ zFileWrapper.getPeerc C r' )Nr r r r r r getHosta r zFileWrapper.getHostc C r r: r r r r r r f r zFileWrapper.handleExceptionc C r r: r r r r r r i zFileWrapper.resumeProducingc C r r: r r r r r pauseProducingm r zFileWrapper.pauseProducingc C s | d S r: )r r r r r
stopProducingq s zFileWrapper.stopProducing)r r- r. r/ r
disconnectingr r r> r r r r r r r r r r r r r r r r r r r % s( r ) r r2 r_ r r r r r r r r rI )/r/ rs typingr r zope.interfacer rv r r r twisted.internet.interfacesr r twisted.loggerr
twisted.pythonr r r
IProtocolFactoryILoggingContextr r2 r9 rI r_ r r r ConnectionDoner cleanFailure IProtocolr IConsumerAdapterr registerAdapterr IProcessProtocolr r r r r __all__r r r r sP p$4o $ 5
=K O