/usr/lib/python3/dist-packages/twisted/internet/__pycache__
Edit: /usr/lib/python3/dist-packages/twisted/internet/__pycache__/endpoints.cpython-310.pyc (73348B)
o
b. @ sL d Z ddlZddlZddlZddlZddlmZ ddlmZm Z m
Z
ddl m Z m
Z
ddlmZ ddlmZmZmZmZmZ ddlmZmZ dd lmZmZm Z m Z dd
l m Z m Z m!Z!m"Z"m#Z# dd l$m%Z%m&Z&m'Z'm(Z( z
dd l)m*Z*m+Z+ W n
e,y dZ+dZ*Y nw dd
l-m.Z. ddl/m0Z0 ddl1m2Z2 ddl3m4Z4 ddl5m6Z6m7Z7 ddl8m9Z9m:Z: ddl;m
Z> ddl?m@Z@ ddlAmBZB ddlCmDZD ddlEmFZF ddlGmHZHmIZI z ddlJmKZL ddlMmNZNmOZOmPZPmQZQmRZRmSZS dd lTmUZV W n e,y dZUY nw eVZUg d ZWG d d d e(ZXG d d! d!e%ZYe ejZG d"d# d#Z[G d$d% d%ej\ej]ej^Z_G d&d' d'e@e_d(Z`G d)d* d*e'ZaG d+d, d,e
Zbe ejcG d-d. d.Zde ejZG d/d0 d0ZeG d1d2 d2eeZfG d3d4 d4eeZge ejcG d5d6 d6Zhe ejcG d7d8 d8Zie e G d9d: d:Zje ejcG d;d< d<Zke ejZG d=d> d>Zle ejcG d?d@ d@Zme ejZG dAdB dBZne ejcG dCdD dDZoe ejZG dEdF dFZpddIdJZqddMdNZr O G H ddPdQZse e6e#G dRdS dSZte e6e#G dTdU dUZue e6e#G dVdW dWZveqeresdXZwexdY\ZyZzdZd[ Z{d\d] Z|efelend^Z}ehemeod^Z~d_d` Zdadb Zdcdd Zdedf Zdgdh Zdidj Zdkdl Zdmdn Zdodp Zdqdr Zdsdt Zeeed^Zdudv Zdwdx Ze ejcG dydz dzZe ejZG d{d| d|Zd}d~ Z dddZe e6e"G dd dZdS )a7
Implementations of L{IStreamServerEndpoint} and L{IStreamClientEndpoint} that
wrap the L{IReactorTCP}, L{IReactorSSL}, and L{IReactorUNIX} interfaces.
This also implements an extensible mini-language for describing endpoints,
parsed by the L{clientFromString} and L{serverFromString} functions.
@since: 10.1
N) normalize)directlyProvides implementerprovider)
NamedConstantNames)Version)defererrorfdesc
interfacesthreads) isIPAddress
isIPv6Address)HostnameAddress IPv4Address IPv6Address_ProcessAddress)IHostnameResolver IReactorPluggableNameResolverIResolutionReceiver,IStreamClientEndpointStringParserWithReactor!IStreamServerEndpointStringParser)
ClientFactoryFactoryProcessProtocolProtocol) PipeAddress
StandardIO)HostResolution)Deferred) LoopingCall)Logger)IPlugin
getPlugins) deprecatelog)_matchingString iterbytes nativeString)proxyForInterface)Failure)FilePath) ListenFDs )
_idnaBytes _idnaText)Error) CertificateCertificateOptionsKeyPairPrivateCertificateoptionsForClientTLStrustRootFromCertificatesTLSMemoryBIOFactory)clientFromStringserverFromStringTCP4ServerEndpointTCP6ServerEndpointTCP4ClientEndpointTCP6ClientEndpointUNIXServerEndpointUNIXClientEndpointSSL4ServerEndpointSSL4ClientEndpointAdoptedStreamServerEndpointStandardIOEndpointProcessEndpointHostnameEndpointStandardErrorBehaviorconnectProtocol
wrapClientTLSc @ sX e Zd ZdZdd Zdd Zdd Zdd Zd
d Zd d
Z dd Z
dd Z dd Z dS )_WrappingProtocolz_
Wrap another protocol in order to notify my user when a connection has
been made.
c C s< || _ || _tjtjtjfD ]
}|| jrt| | qdS )z
@param connectedDeferred: The L{Deferred} that will callback
with the C{wrappedProtocol} when it is connected.
@param wrappedProtocol: An L{IProtocol} provider that will be
connected.
N)_connectedDeferred_wrappedProtocolr IHalfCloseableProtocolIFileDescriptorReceiverIHandshakeListener
providedByr )selfconnectedDeferredwrappedProtocoliface rV }
that is managing the current or previous connection attempt.
c C s || _ tj| jd| _dS )z
@param wrappedFactory: A provider of I{IProtocolFactory} whose
buildProtocol method will be called and whose resulting protocol
will be wrapped.
cancellerN)_wrappedFactoryr r
_canceller
_onConnection)rR wrappedFactoryrV rV rW rX s z_WrappingFactory.__init__c C
|| _ dS )z~
A connection attempt was started. Remember the connector which started
said attempt, for use later.
N)
_connector)rR connectorrV rV rW startedConnecting s
z"_WrappingFactory.startedConnectingc C s$ | t| j | j dS )a;
The outgoing connection attempt was cancelled. Fail that L{Deferred}
with an L{error.ConnectingCancelledError}.
@param deferred: The L{Deferred } that was cancelled;
should be the same as C{self._onConnection}.
@type deferred: L{Deferred }
@note: This relies on startedConnecting having been called, so it may
seem as though there's a race condition where C{_connector} may not
have been set. However, using public APIs, this condition is
impossible to catch, because a connection API
(C{connectTCP}/C{SSL}/C{UNIX}) is always invoked before a
L{_WrappingFactory}'s L{Deferred } is returned to
C{connect()}'s caller.
@return: L{None}
N)errbackr
ConnectingCancelledErrorr{ getDestinationstopConnecting)rR deferredrV rV rW rw s z_WrappingFactory._cancellerc C rk )zY
Start notifications are passed straight through to the wrapped factory.
N)rv doStartr] rV rV rW r z_WrappingFactory.doStartc C rk )zX
Stop notifications are passed straight through to the wrapped factory.
N)rv doStopr] rV rV rW r r z_WrappingFactory.doStopc C sN z| j |}|du rt W n ty | j Y dS w | | j|S )a
Proxy C{buildProtocol} to our C{self._wrappedFactory} or errback the
C{self._onConnection} L{Deferred} if the wrapped factory raises an
exception or returns L{None}.
@return: An instance of L{_WrappingProtocol} or L{None}
N)rv
buildProtocolr
NoProtocol
BaseExceptionrx r~ protocol)rR addrprotorV rV rW r s z _WrappingFactory.buildProtocolc C s | j js | j | dS dS )zi
Errback the C{self._onConnection} L{Deferred} when the
client connection fails.
N)rx calledr~ )rR r| rj rV rV rW clientConnectionFailed
s z'_WrappingFactory.clientConnectionFailedN)
r\ rp rq rr rK r rX r} rw r r r r rV rV rV rW rs s rs c @ s$ e Zd ZdZeZdd Zdd ZdS )rE z
A Standard Input/Output endpoint
@ivar _stdio: a callable, like L{stdio.StandardIO}, which takes an
L{IProtocol} provider and a C{reactor} keyword argument (interface
dependent upon your platform).
c C rz )z?
@param reactor: The reactor for the endpoint.
N)_reactorrR reactorrV rV rW rX "
zStandardIOEndpoint.__init__c C s t j| j|t | jdS )zU
Implement L{IStreamServerEndpoint.listen} to listen on stdin/stdout
)r )r execute_stdior r r )rR stdioProtocolFactoryrV rV rW listen( s
zStandardIOEndpoint.listenN)r\ rp rq rr r r rX r rV rV rV rW rE s
rE c @ e Zd ZdZdS ))_IProcessTransportWithConsumerAndProducera)
An L{_IProcessTransportWithConsumerAndProducer} combines various interfaces
to work around the issue that L{interfaces.IProcessTransport} is
incompletely defined and doesn't specify flow-control interfaces, and that
L{proxyForInterface} doesn't allow for multiple interfaces.
Nr\ rp rq rr rV rV rV rW r 3 s r c @ r )_ProcessEndpointTransportaj
An L{ITransport}, L{IProcessTransport}, L{IConsumer}, and L{IPushProducer}
provider for the L{IProtocol} instance passed to the process endpoint.
@ivar _process: An active process transport which will be used by write
methods on this object to write data to a child process.
@type _process: L{interfaces.IProcessTransport} provider
Nr rV rV rV rW r > s r _processc @ s0 e Zd ZdZdd Zdd Zdd Zdd Zd
S ) _WrapIProtocolz
An L{IProcessProtocol} provider that wraps an L{IProtocol}.
@ivar transport: A L{_ProcessEndpointTransport} provider that is hooked to
the wrapped L{IProtocol} provider.
@see: L{protocol.ProcessProtocol}
c C s || _ || _|| _dS )z
@param proto: An L{IProtocol} provider.
@param errFlag: A constant belonging to L{StandardErrorBehavior}
that determines if stderr is logged or dropped.
@param executable: The file name (full path) to spawn.
N)r errFlag
executable)rR r r r rV rV rW rX X s
z_WrapIProtocol.__init__c C s t || _| j| jS )z
Call L{IProtocol} provider's makeConnection method with an
L{ITransport} provider.
@param process: An L{IProcessTransport} provider.
)r r_ r r^ )rR processrV rV rW r^ c s
z _WrapIProtocol.makeConnectionc C sJ |dkr
| j |S |dkr!| jtjkr#tjd| j| j |d dS dS dS )z
This is called with data from the process's stdout or stderr pipes. It
checks the status of the errFlag to setermine if stderr should be
logged (default) or dropped.
r. zGProcess %(executable)r wrote stderr unhandled by %(protocol)s: %(data)s)formatr r rd N)r rc r rH LOGr& msgr )rR childFDrd rV rV rW childDataReceivedm s
z _WrapIProtocol.childDataReceivedc C s> | tjtjkr|jjdkr| jtt S | j|S )z
If the process ends with L{error.ProcessDone}, this method calls the
L{IProtocol} provider's L{connectionLost} with a
L{error.ConnectionDone}
@see: L{ProcessProtocol.processEnded}
r ) checkr
ProcessDonevaluestatusr rh r+ ConnectionDoneri rV rV rW processEnded~ s z_WrapIProtocol.processEndedN)r\ rp rq rr rX r^ r r rV rV rV rW r N s
r c @ s e Zd ZdZe Ze ZdS )rH z
Constants used in ProcessEndpoint to decide what to do with stderr.
@cvar LOG: Indicates that stderr is to be logged.
@cvar DROP: Indicates that stderr is to be dropped (and not logged).
@since: 13.1
N)r\ rp rq rr r r DROPrV rV rV rW rH s
rH c @ s4 e Zd ZdZdi dddddejfddZdd ZdS ) rF z
An endpoint for child processes
@ivar _spawnProcess: A hook used for testing the spawning of child process.
@since: 13.1
rV Nr c C sJ || _ || _|| _|| _|| _|| _|| _|| _| | _|
| _ | j j
| _ dS )z
See L{IReactorProcess.spawnProcess}.
@param errFlag: Determines if stderr should be logged.
@type errFlag: L{endpoints.StandardErrorBehavior}
N) r _executable_args_env_path_uid_gid_usePTY _childFDs_errFlag spawnProcess
_spawnProcess) rR r r argsenvpathuidgidusePTYchildFDsr rV rV rW rX s zProcessEndpoint.__init__c C sl | t }z | t|| j| j| j| j| j| j| j | j
| j | j W n
t
y0 t Y S w t|S )a3
Implement L{IStreamClientEndpoint.connect} to launch a child process
and connect it to a protocol created by C{protocolFactory}.
@param protocolFactory: A factory for an L{IProtocol} provider which
will be notified of all events related to the created process.
)r r r r r r r r r r r r r r r failsucceed)rR protocolFactoryr rV rV rW connect s"
zProcessEndpoint.connect)r\ rp rq rr rH r rX r rV rV rV rW rF s
rF c @ e Zd ZdZdd Zdd ZdS )_TCPServerEndpointz)
A TCP server endpoint interface
c C || _ || _|| _|| _dS )a+
@param reactor: An L{IReactorTCP} provider.
@param port: The port number used for listening
@type port: int
@param backlog: Size of the listen queue
@type backlog: int
@param interface: The hostname to bind to
@type interface: str
N)r _port_backlog
_interfacerR r portbacklog interfacerV rV rW rX s
z_TCPServerEndpoint.__init__c C s t j| jj| j|| j| jdS )z]
Implement L{IStreamServerEndpoint.listen} to listen on a TCP
socket
)r r )r r r listenTCPr r r rR r rV rV rW r s z_TCPServerEndpoint.listenNr\ rp rq rr rX r rV rV rV rW r s r c @ e Zd ZdZdddZdS )r< zC
Implements TCP server endpoint with an IPv4 configuration
2 c C t | |||| dS )aA
@param reactor: An L{IReactorTCP} provider.
@param port: The port number used for listening
@type port: int
@param backlog: Size of the listen queue
@type backlog: int
@param interface: The hostname to bind to, defaults to '' (all)
@type interface: str
Nr rX r rV rV rW rX
zTCP4ServerEndpoint.__init__Nr r r\ rp rq rr rX rV rV rV rW r< r< c @ r )r= zC
Implements TCP server endpoint with an IPv6 configuration
r ::c C r )aD
@param reactor: An L{IReactorTCP} provider.
@param port: The port number used for listening
@type port: int
@param backlog: Size of the listen queue
@type backlog: int
@param interface: The hostname to bind to, defaults to C{::} (all)
@type interface: str
Nr r rV rV rW rX r zTCP6ServerEndpoint.__init__Nr r r rV rV rV rW r= r r= c @ s" e Zd ZdZdddZdd ZdS ) r> z9
TCP client endpoint with an IPv4 configuration.
Nc C " || _ || _|| _|| _|| _dS )a
@param reactor: An L{IReactorTCP} provider
@param host: A hostname, used when connecting
@type host: str
@param port: The port number, used when connecting
@type port: int
@param timeout: The number of seconds to wait before assuming the
connection has failed.
@type timeout: L{float} or L{int}
@param bindAddress: A (host, port) tuple of local address to bind to,
or None.
@type bindAddress: tuple
Nr _hostr _timeout _bindAddressrR r hostr timeout bindAddressrV rV rW rX 6 s
zTCP4ClientEndpoint.__init__c C sJ zt |}| jj| j| j|| j| jd |jW S ty$ t
Y S w )zP
Implement L{IStreamClientEndpoint.connect} to connect via TCP.
r r ) rs r
connectTCPr r r r rx r r r rR r wfrV rV rW r N s zTCP4ClientEndpoint.connectr Nr\ rp rq rr rX r rV rV rV rW r> 0 s
r> c @ sN e Zd ZdZeejZeej Z
dZ dZ dddZ
dd Zd
d Zd d
ZdS )r? a
TCP client endpoint with an IPv6 configuration.
@ivar _getaddrinfo: A hook used for testing name resolution.
@ivar _deferToThread: A hook used for testing deferToThread.
@ivar _GAI_ADDRESS: Index of the address portion in result of
getaddrinfo to be used.
@ivar _GAI_ADDRESS_HOST: Index of the actual host-address in the
5-tuple L{_GAI_ADDRESS}.
r r Nc C r )z
@param host: An IPv6 address literal or a hostname with an
IPv6 address
@see: L{twisted.internet.interfaces.IReactorTCP.connectTCP}
Nr r rV rV rW rX u s
zTCP6ClientEndpoint.__init__c sL t jr j|}|S j}| fdd | j| |S )z~
Implement L{IStreamClientEndpoint.connect} to connect via TCP,
once the hostname resolution is done.
c s | d j j S )Nr ) _GAI_ADDRESS_GAI_ADDRESS_HOSTresultr] rV rW s z,TCP6ClientEndpoint.connect..)r r _resolvedHostConnect_nameResolution addCallback)rR r drV r] rW r s
zTCP6ClientEndpoint.connectc C s | | j|dtjS )zd
Resolve the hostname string into a tuple containing the host
IPv6 address.
r )_deferToThread _getaddrinfosocketAF_INET6rR r rV rV rW r s z"TCP6ClientEndpoint._nameResolutionc C sH zt |}| jj|| j|| j| jd |jW S ty# t Y S w )zD
Connect to the server using the resolved hostname.
r )
rs r r r r r rx r r r )rR resolvedHostr r rV rV rW r s z'TCP6ClientEndpoint._resolvedHostConnectr )r\ rp rq rr staticmethodr getaddrinfor r
deferToThreadr r r rX r r r rV rV rV rW r? ` s
r? c @ s. e Zd ZdZe Zdd Z d ddZdS )
_SimpleHostnameResolvera^
An L{IHostnameResolver} provider that invokes a provided callable
to resolve hostnames.
@ivar _nameResolution: the callable L{resolveHostName} invokes to
resolve hostnames.
@type _nameResolution: A L{callable} that accepts two arguments:
the host to resolve and the port number to include in the
result.
c C rz )z?
Create a L{_SimpleHostnameResolver} instance.
N)r )rR nameResolutionrV rV rW rX r z _SimpleHostnameResolver.__init__r NTCPc s^ t |}fdd} fdd}|| || |fdd S )a
Initiate a hostname resolution.
@param resolutionReceiver: an object that will receive each resolved
address as it arrives.
@type resolutionReceiver: L{IResolutionReceiver}
@param hostName: see interface
@param portNumber: see interface
@param addressTypes: Ignored in this implementation.
@param transportSemantics: Ignored in this implementation.
@return: The resolution in progress.
@rtype: L{IResolutionReceiver}
c sZ | D ](\}}}}}|t jkr tdg|R q|t jkr* tdg|R qd S )Nr )r r addressResolvedr AF_INETr ) gairesultfamilysocktyper canonnamesockaddrresolutionReceiverrV rW cbDeliver s
z:_SimpleHostnameResolver.resolveHostName..cbDeliverc s j jd| jd d S )Nz'while looking up {name} with {callable})namecallable)_logfailurer )r
)hostNamerR rV rW ebLog s
z6_SimpleHostnameResolver.resolveHostName..ebLogc s S N)resolutionCompleteignoredr rV rW r s z9_SimpleHostnameResolver.resolveHostName..)resolutionBeganr r r
addErrbackaddBoth) rR r r
portNumber addressTypestransportSemanticsr r r rV )r r rR rW resolveHostName s
z'_SimpleHostnameResolver.resolveHostName)r Nr )r\ rp rq rr r" r rX r rV rV rV rW r s
r c @ sf e Zd ZdZeejZeej Z
dZ dddZ de
fdd Zd
d Zed d
Zdd Zdd ZdS )rG aB
A name-based endpoint that connects to the fastest amongst the resolved
host addresses.
@cvar _DEFAULT_ATTEMPT_DELAY: The default time to use between attempts, in
seconds, when no C{attemptDelay} is given to
L{HostnameEndpoint.__init__}.
@ivar _hostText: the textual representation of the hostname passed to the
constructor. Used to pass to the reactor's hostname resolver.
@type _hostText: L{unicode}
@ivar _hostBytes: the encoded bytes-representation of the hostname passed
to the constructor. Used to construct the L{HostnameAddress}
associated with this endpoint.
@type _hostBytes: L{bytes}
@ivar _hostStr: the native-string representation of the hostname passed to
the constructor, used for exception construction
@type _hostStr: native L{str}
@ivar _badHostname: a flag - hopefully false! - indicating that an invalid
hostname was passed to the constructor. This might be a textual
hostname that isn't valid IDNA, or non-ASCII bytes.
@type _badHostname: L{bool}
g333333?r Nc C sh || _ | || _| |\| _| _| _ttu r| jn| j| _ || _
|| _ || _ |du r/| j
}|| _dS )a
Create a L{HostnameEndpoint}.
@param reactor: The reactor to use for connections and delayed calls.
@type reactor: provider of L{IReactorTCP}, L{IReactorTime} and either
L{IReactorPluggableNameResolver} or L{IReactorPluggableResolver}.
@param host: A hostname to connect to.
@type host: L{bytes} or L{unicode}
@param port: The port number to connect to.
@type port: L{int}
@param timeout: For each individual connection attempt, the number of
seconds to wait before assuming the connection has failed.
@type timeout: L{float} or L{int}
@param bindAddress: the local address of the network interface to make
the connections from.
@type bindAddress: L{bytes}
@param attemptDelay: The number of seconds to delay between connection
attempts.
@type attemptDelay: L{float}
@see: L{twisted.internet.interfaces.IReactorTCP.connectTCP}
N)r _getNameResolverAndMaybeWarn
_nameResolver_hostAsBytesAndText _badHostname
_hostBytes _hostTextbytesstr_hostStrr r r _DEFAULT_ATTEMPT_DELAY
_attemptDelay)rR r r r r r attemptDelayrV rV rW rX s
zHostnameEndpoint.__init__returnc C sL | j r| j}nt| jrd| j d}nt| j}dd|dt| jdgS )zh
Produce a string representation of the L{HostnameEndpoint}.
@return: A L{str}
[]r z)r r# r r) r joinr" r r rV rV rW __repr__> s
zHostnameEndpoint.__repr__c C sH t |s!tj|jtddddddd}tj|tdd t | j
S |j S )
a
Retrieve a C{nameResolver} callable and warn the caller's
caller that using a reactor which doesn't provide
L{IReactorPluggableNameResolver} is deprecated.
@param reactor: The reactor to check.
@return: A L{IHostnameResolver} provider.
Twisted r zPassing HostnameEndpoint a reactor that does not provide IReactorPluggableNameResolver (%(fqpn)s) was deprecated in %(version)sz5a reactor that provides IReactorPluggableNameResolver)r replacement )
stacklevel) r rQ r% getDeprecationWarningStringr[ r warningswarnDeprecationWarningr _fallbackNameResolution nameResolver)rR r
warningStringrV rV rW r R s
z-HostnameEndpoint._getNameResolverAndMaybeWarnc C s t | tr,t| s
t| rd| | dfS zd| t| fW S ty+ | d} Y n(w td| } t| s9t| rAd| d| fS zdt | | fW S tyR Y nw | dd}d||dfS )a
For various reasons (documented in the C{@ivar}'s in the class
docstring) we need both a textual and a binary representation of the
hostname given to the constructor. For compatibility and convenience,
we accept both textual and binary representations of the hostname, save
the form that was passed, and convert into the other form. This is
mostly just because L{HostnameAddress} chose somewhat poorly to define
its attribute as bytes; hopefully we can find a compatible way to clean
this up in the future and just operate in terms of text internally.
@param host: A hostname to convert.
@type host: L{bytes} or C{str}
@return: a 3-tuple of C{(invalid, bytes, text)} where C{invalid} is a
boolean indicating the validity of the hostname, C{bytes} is a
binary representation of C{host}, and C{text} is a textual
representation of C{host}.
FasciicharmapNFCbackslashreplaceT)
isinstancer! r r decoder0 UnicodeErrorr encoder/ )r
asciibytesrV rV rW r m s$
z$HostnameEndpoint._hostAsBytesAndTextc s j rttdj S t g ttG fddd}jj |j
j d fdd j
fdd}
t fd d
j
fd d }S )
a
Attempts a connection to each resolved address, and returns a
connection which is established first.
@param protocolFactory: The protocol factory whose protocol
will be connected.
@type protocolFactory:
L{IProtocolFactory}
@return: A L{Deferred} that fires with the connected protocol
or fails a connection-related error.
zinvalid hostname: c s: e Zd Zedd Ze fddZe fddZdS )z2HostnameEndpoint.connect..EndpointReceiverc S s d S r rV )resolutionInProgressrV rV rW r s zBHostnameEndpoint.connect..EndpointReceiver.resolutionBeganc | d S r append)address) addressesrV rW r zBHostnameEndpoint.connect..EndpointReceiver.addressResolvedc s d S r r` rV rI r rV rW r rJ zEHostnameEndpoint.connect..EndpointReceiver.resolutionCompleteN)r\ rp rq r r r r rV rL rV rW EndpointReceiver s
rM )r c s t td j dS )Nz Couldn't find the hostname '')r r r
DNSLookupErrorr# r r] rV rW r s z*HostnameEndpoint.connect..c 3 s\ | D ](}t |trt j|j|j j jV t |tr+t j|j|j j jV qd S r )
r? r r? r r r r r r r> )rI eachAddressr] rV rW resolvedAddressesToEndpoints s(
z>HostnameEndpoint.connect..resolvedAddressesToEndpointsc s | tt j j d S r )r~ r
r r r r )r r] rV rW rw s
z,HostnameEndpoint.connect.._cancellerc s | s t dj t| g g tjd fdd d _d _t fddj _
j j
fd d
}S ) aQ
Given a sequence of endpoints obtained via name resolution, start
connecting to a new one every C{self._attemptDelay} seconds until
one of the connections succeeds, all of them fail, or the attempt
is cancelled.
@param endpoints: a list of all the endpoints we might try to
connect to, as determined by name resolution.
@type endpoints: L{list} of L{IStreamServerEndpoint}
@return: a Deferred that fires with the result of the
C{endpoint.connect} method that completes the fastest, or fails
with the first connection error it encountered if none of them
succeed.
@rtype: L{Deferred} failing with L{error.ConnectingCancelledError}
or firing with L{IProtocol}
z no results for hostname lookup: rt c s& s j s jr
d S d S r ) completed
endpointsLeftr~ poprV ) checkDonefailurespendingwinnerrV rW rU s zLHostnameEndpoint.connect..startConnectionAttempts..checkDoneFTc st t d } | d u rd_ d S | j fdd} jfdd} jfdd}d S )NFc s | S r )remover ) eachAttemptrW rV rW noLongerPending s
zkHostnameEndpoint.connect..startConnectionAttempts..iterateEndpoint..noLongerPendingc rE r rK r )rX rV rW succeeded rJ zeHostnameEndpoint.connect..startConnectionAttempts..iterateEndpoint..succeededc s | d S r rF )rj )rU rV rV rW failed! s
zbHostnameEndpoint.connect..startConnectionAttempts..iterateEndpoint..failed)nextrS r rG r r r )endpointr[ r\ r] )rU rV
iterEndpointsrW r rX )rZ rW iterateEndpoint s
zRHostnameEndpoint.connect..startConnectionAttempts..iterateEndpointc s2 d _ d d D ]}| q jr | S NT)rR cancelrunningstop)r remaining)rU ra rW rV rW cancelRemainingPending) s
zYHostnameEndpoint.connect..startConnectionAttempts..cancelRemainingPending)r
rO r# iterr r rR rS r! r clockstartr% r ) endpointsrg )rw r rR )rU rV r` ra rW rX rW startConnectionAttempts s$
z9HostnameEndpoint.connect..startConnectionAttempts)r r r
ValueErrorr# r r r r r r r r r list)rR r rM rQ rl rV )rw rI r r rR rW r s&
KzHostnameEndpoint.connectc C s | | j||dtjS )a
Resolve the hostname string into a tuple containing the host
address. This is method is only used when the reactor does
not provide L{IReactorPluggableNameResolver}.
@param host: A unicode hostname to resolve.
@param port: The port to include in the resolution.
@return: A L{Deferred} that fires with L{_getaddrinfo}'s
return value.
r )r r r SOCK_STREAM)rR r r rV rV rW r8 6 r z(HostnameEndpoint._fallbackNameResolution)r NN)r\ rp rq rr r r r r r
r r r$ rX r" r- r r r r8 rV rV rV rW rG s
,
, rG c @ " e Zd ZdZd ddZdd ZdS )
rB zE
SSL secured TCP server endpoint with an IPv4 configuration.
r r c C r )a
@param reactor: An L{IReactorSSL} provider.
@param port: The port number used for listening
@type port: int
@param sslContextFactory: An instance of
L{interfaces.IOpenSSLContextFactory}.
@param backlog: Size of the listen queue
@type backlog: int
@param interface: The hostname to bind to, defaults to '' (all)
@type interface: str
N)r r _sslContextFactoryr r )rR r r sslContextFactoryr r rV rV rW rX L s
zSSL4ServerEndpoint.__init__c C " t j| jj| j|| j| j| jdS )zf
Implement L{IStreamServerEndpoint.listen} to listen for SSL on a
TCP socket.
)contextFactoryr r )r r r listenSSLr rq r r r rV rV rW r b s zSSL4ServerEndpoint.listenNr r rV rV rV rW rB F s
rB c @ s$ e Zd ZdZ dddZdd ZdS ) rC zD
SSL secured TCP client endpoint with an IPv4 configuration
r Nc C s( || _ || _|| _|| _|| _|| _dS )ao
@param reactor: An L{IReactorSSL} provider.
@param host: A hostname, used when connecting
@type host: str
@param port: The port number, used when connecting
@type port: int
@param sslContextFactory: SSL Configuration information as an instance
of L{interfaces.IOpenSSLContextFactory}.
@param timeout: Number of seconds to wait before assuming the
connection has failed.
@type timeout: int
@param bindAddress: A (host, port) tuple of local address to bind to,
or None.
@type bindAddress: tuple
N)r r r rq r r )rR r r r rr r r rV rV rW rX w s
zSSL4ClientEndpoint.__init__c C sN zt |}| jj| j| j|| j| j| jd |jW S t y& t
Y S w )zb
Implement L{IStreamClientEndpoint.connect} to connect with SSL over
TCP.
r ) rs r
connectSSLr r rq r r rx r r r r rV rV rW r s zSSL4ClientEndpoint.connectr r rV rV rV rW rC q s
rC c @ s" e Zd ZdZd
ddZdd Zd S ) r@ z%
UnixSocket server endpoint.
r r c C r )a
@param reactor: An L{IReactorUNIX} provider.
@param address: The path to the Unix socket file, used when listening
@param backlog: number of connections to allow in backlog.
@param mode: mode to set on the unix socket. This parameter is
deprecated. Permissions should be set on the directory which
contains the UNIX socket.
@param wantPID: If True, create a pidfile for the socket.
N)r _addressr _mode_wantPID)rR r rH r modewantPIDrV rV rW rX s
zUNIXServerEndpoint.__init__c C rs )zW
Implement L{IStreamServerEndpoint.listen} to listen on a UNIX socket.
)r r{ r| )r r r
listenUNIXrx r ry rz r rV rV rW r s zUNIXServerEndpoint.listenN)r rw r r rV rV rV rW r@ s
r@ c @ rp )
rA z%
UnixSocket client endpoint.
r r c C r )a
@param reactor: An L{IReactorUNIX} provider.
@param path: The path to the Unix socket file, used when connecting
@type path: str
@param timeout: Number of seconds to wait before assuming the
connection has failed.
@type timeout: int
@param checkPID: If True, check for a pid file to verify that a server
is listening.
@type checkPID: bool
N)r r r _checkPID)rR r r r checkPIDrV rV rW rX s
zUNIXClientEndpoint.__init__c C sF zt |}| jj| j|| j| jd |jW S ty" t Y S w )za
Implement L{IStreamClientEndpoint.connect} to connect via a
UNIX Socket
)r r )
rs r connectUNIXr r r~ rx r r r r rV rV rW r s zUNIXClientEndpoint.connectN)r r r rV rV rV rW rA s
rA c @ s0 e Zd ZdZejZeej Z
dd Z dd Z dS )rD z
An endpoint for listening on a file descriptor initialized outside of
Twisted.
@ivar _used: A C{bool} indicating whether this endpoint has been used to
listen with a factory yet. C{True} if so.
c C s || _ || _|| _d| _dS )a
@param reactor: An L{IReactorSocket} provider.
@param fileno: An integer file descriptor corresponding to a listening
I{SOCK_STREAM} socket.
@param addressFamily: The address family of the socket given by
C{fileno}.
FN)r fileno
addressFamily_used)rR r r r rV rV rW rX s
z$AdoptedStreamServerEndpoint.__init__c C sp | j r
tt S d| _ z| | j | j| j| j |}|
| j W n
t y2 t Y S w t |S )z{
Implement L{IStreamServerEndpoint.listen} to start listening on, and
then close, C{self._fileno}.
T)
r r r r
AlreadyListened_setNonBlockingr r adoptStreamPortr _closer r )rR factoryr rV rV rW r s
z"AdoptedStreamServerEndpoint.listenN)
r\ rp rq rr oscloser r r setNonBlockingr rX r rV rV rV rW rD s
rD r r c C s t || f|t |dfS )a
Internal parser function for L{_parseServer} to convert the string
arguments for a TCP(IPv4) stream endpoint into the structured arguments.
@param factory: the protocol factory being parsed, or L{None}. (This was a
leftover argument from when this code was in C{strports}, and is now
mostly None and unused.)
@type factory: L{IProtocolFactory} or L{None}
@param port: the integer port number to bind
@type port: C{str}
@param interface: the interface IP to listen on
@param backlog: the length of the listen queue
@type backlog: C{str}
@return: a 2-tuple of (args, kwargs), describing the parameters to
L{IReactorTCP.listenTCP} (or, modulo argument 2, the factory, arguments
to L{TCP4ServerEndpoint}.
r r )int)r r r r rV rV rW _parseTCP& s r 666Tc C s& || ft |dt |tt |dfS )a
Internal parser function for L{_parseServer} to convert the string
arguments for a UNIX (AF_UNIX/SOCK_STREAM) stream endpoint into the
structured arguments.
@param factory: the protocol factory being parsed, or L{None}. (This was a
leftover argument from when this code was in C{strports}, and is now
mostly None and unused.)
@type factory: L{IProtocolFactory} or L{None}
@param address: the pathname of the unix socket
@type address: C{str}
@param backlog: the length of the listen queue
@type backlog: C{str}
@param lockfile: A string '0' or '1', mapping to True and False
respectively. See the C{wantPID} argument to C{listenUNIX}
@return: a 2-tuple of (args, kwargs), describing the parameters to
L{twisted.internet.interfaces.IReactorUNIX.listenUNIX} (or,
modulo argument 2, the factory, arguments to L{UNIXServerEndpoint}.
)r{ r r| )r bool)r rH r{ r lockfilerV rV rW
_parseUNIX? s r
server.pemc s ddl m |du r |}i } |durt j|| d< t| }
t| } j|
d | } |durVtj dt
t| tj d}
fdd |
D }|sUt d
|f nd}|durd j
t|} jd
| jj| j||d | }t|| |f|t|d fS )a
Internal parser function for L{_parseServer} to convert the string
arguments for an SSL (over TCP/IPv4) stream endpoint into the structured
arguments.
@param factory: the protocol factory being parsed, or L{None}. (This was a
leftover argument from when this code was in C{strports}, and is now
mostly None and unused.)
@type factory: L{IProtocolFactory} or L{None}
@param port: the integer port number to bind
@type port: C{str}
@param interface: the interface IP to listen on
@param backlog: the length of the listen queue
@type backlog: C{str}
@param privateKey: The file name of a PEM format private key file.
@type privateKey: C{str}
@param certKey: The file name of a PEM format certificate file.
@type certKey: C{str}
@param sslmethod: The string name of an SSL method, based on the name of a
constant in C{OpenSSL.SSL}. Must be one of: "SSLv23_METHOD",
"SSLv2_METHOD", "SSLv3_METHOD", "TLSv1_METHOD".
@type sslmethod: C{str}
@param extraCertChain: The path of a file containing one or more
certificates in PEM format that establish the chain from a root CA to
the CA that signed your C{certKey}.
@type extraCertChain: L{str}
@param dhParameters: The file name of a file containing parameters that are
required for Diffie-Hellman key exchange. If this is not specified,
the forward secret C{DHE} ciphers aren't available for servers.
@type dhParameters: L{str}
@return: a 2-tuple of (args, kwargs), describing the parameters to
L{IReactorSSL.listenSSL} (or, modulo argument 2, the factory, arguments
to L{SSL4ServerEndpoint}.
r sslNmethod
z=(-----BEGIN CERTIFICATE-----\n.+?\n-----END CERTIFICATE-----))flagsc s g | ] } j |jqS rV )r2 loadPEMoriginal).0 chainCertPEMr rV rW
s z _parseSSL..zOSpecified chain file '%s' doesn't contain any valid certificates in PEM format.)
privateKey certificateextraCertChain dhParametersr rV )twisted.internetr getattrSSLr,
getContentr5 r refindallr) DOTALLrm DiffieHellmanParametersfromFiler3 r r r )r r r certKey sslmethodr r r r kwcertPEMkeyPEMprivateCertificatematcheschainCertificatescfrV r rW _parseSSL^ sN 5
r c @ s$ e Zd ZdZdZdd Zdd ZdS )_StandardIOParserz
Stream server endpoint string parser for the Standard I/O type.
@ivar prefix: See L{IStreamServerEndpointStringParser.prefix}.
stdioc C s t |S )z
Internal parser function for L{_parseServer} to convert the string
arguments into structured arguments for the L{StandardIOEndpoint}
@param reactor: Reactor for the endpoint
)rE r rV rV rW _parseServer s z _StandardIOParser._parseServerc O s
| |S r r rR r r kwargsrV rV rW parseStreamServer s
z#_StandardIOParser.parseStreamServerNr\ rp rq rr prefixr r rV rV rV rW r s
r c @ s, e Zd ZdZe ZdZdd Zdd Z dS )_SystemdParsera
Stream server endpoint string parser for the I{systemd} endpoint type.
@ivar prefix: See L{IStreamServerEndpointStringParser.prefix}.
@ivar _sddaemon: A L{ListenFDs} instance used to translate an index into an
actual file descriptor.
systemdc C s0 t |}| j | }ttd| }t|||S )a|
Internal parser function for L{_parseServer} to convert the string
arguments for a systemd server endpoint into structured arguments for
L{AdoptedStreamServerEndpoint}.
@param reactor: An L{IReactorSocket} provider.
@param domain: The domain (or address family) of the socket inherited
from systemd. This is a string like C{"INET"} or C{"UNIX"}, ie the
name of an address family from the L{socket} module, without the
C{"AF_"} prefix.
@type domain: C{str}
@param index: An offset into the list of file descriptors inherited from
systemd.
@type index: C{str}
@return: A two-tuple of parsed positional arguments and parsed keyword
arguments (a tuple and a dictionary). These can be used to
construct an L{AdoptedStreamServerEndpoint}.
AF_)r _sddaemoninheritedDescriptorsr r rD )rR r domainindexr r rV rV rW r s z_SystemdParser._parseServerc O | j |g|R i |S r r r rV rV rW r s z _SystemdParser.parseStreamServerN)
r\ rp rq rr r- fromEnvironmentr r r r rV rV rV rW r s r c @ s& e Zd ZdZdZd
ddZdd Zd S ) _TCP6ServerParserz
Stream server endpoint string parser for the TCP6ServerEndpoint type.
@ivar prefix: See L{IStreamServerEndpointStringParser.prefix}.
tcp6r r c C s t |}t |}t||||S )a
Internal parser function for L{_parseServer} to convert the string
arguments into structured arguments for the L{TCP6ServerEndpoint}
@param reactor: An L{IReactorTCP} provider.
@param port: The port number used for listening
@type port: int
@param backlog: Size of the listen queue
@type backlog: int
@param interface: The hostname to bind to
@type interface: str
)r r= r rV rV rW r s z _TCP6ServerParser._parseServerc O r r r r rV rV rW r & s z#_TCP6ServerParser.parseStreamServerNr r rV rV rV rW r s
r )tcpunixr r c
c s t d| }t d| }t d| }t d| }|}|| }||| ||i}tt| }|D ](} | t|v rDt|fV t| fV |}|| }q+| |krO|t|7 }q+|| 7 }q+t|fV dS )a
Tokenize a strports string and yield each token.
@param description: a string as described by L{serverFromString} or
L{clientFromString}.
@type description: L{str} or L{bytes}
@return: an iterable of 2-tuples of (C{_OP} or C{_STRING}, string). Tuples
starting with C{_OP} will contain a second element of either ':' (i.e.
'next parameter') or '=' (i.e. 'assign parameter value'). For example,
the string 'hello:greeting=world' would result in a generator yielding
these values::
_STRING, 'hello'
_OP, ':'
_STRING, 'greet=ing'
_OP, '='
_STRING, 'world'
r r* =\N)r' rh r( _STRING_OPr^ )
descriptionemptycolonequals backslashcurrentopsnextOpsiterdescnrV rV rW _tokenize5 s&
r c sp g i t d| } fdd}d}t| D ]\}}|tu r%||f7 }q||kr/|| d}q|| fS )a
Convert a description string into a list of positional and keyword
parameters, using logic vaguely like what Python does.
@param description: a string as described by L{serverFromString} or
L{clientFromString}.
@return: a 2-tuple of C{(args, kwargs)}, where 'args' is a list of all
':'-separated C{str}s not containing an '=' and 'kwargs' is a map of
all C{str}s which do contain an '='. For example, the result of
C{_parse('a:b:d=1:c')} would be C{(['a', 'b', 'c'], {'d': '1'})}.
r* c s6 t | dkr | d d S | d t| d < d S )Nr. r )lenrG r) )sofarr r rV rW addo s z_parse..addrV )r' r r )r r r r typer rV r rW _parse_ s
r )r r UNIXc C sn t | \}}|d }t|}|du r#ttt|}||dd |fS | f||g|dd R i | S )a
Parse a strports description into a 2-tuple of arguments and keyword
values.
@param description: A description in the format explained by
L{serverFromString}.
@type description: C{str}
@param factory: A 'factory' argument; this is left-over from
twisted.application.strports, it's not really used.
@type factory: L{IProtocolFactory} or L{None}
@return: a 3-tuple of (plugin or name, arguments, keyword arguments)
r Nr. )r _serverParsersget_matchPluginToPrefixr$ r upper)r r r r endpointTypeparserpluginrV rV rW r s
(r c C s> | }| D ]}t|j ||kr| S qtd| d)z!
Match plugin to prefix.
zUnknown endpoint type: 'rN )lowerr' r rm )pluginsr r rV rV rW r s r c C sn t |d\}}}t|tur |}|j| g|R i |S |}|dd |dd }t| | g|R i |S )a_
Construct a stream server endpoint from an endpoint description string.
The format for server endpoint descriptions is a simple byte string. It is
a prefix naming the type of endpoint, then a colon, then the arguments for
that endpoint.
For example, you can call it like this to create an endpoint that will
listen on TCP port 80::
serverFromString(reactor, "tcp:80")
Additional arguments may be specified as keywords, separated with colons.
For example, you can specify the interface for a TCP server endpoint to
bind to like this::
serverFromString(reactor, "tcp:80:interface=127.0.0.1")
SSL server endpoints may be specified with the 'ssl' prefix, and the
private key and certificate files may be specified by the C{privateKey} and
C{certKey} arguments::
serverFromString(
reactor, "ssl:443:privateKey=key.pem:certKey=crt.pem")
If a private key file name (C{privateKey}) isn't provided, a "server.pem"
file is assumed to exist which contains the private key. If the certificate
file name (C{certKey}) isn't provided, the private key file is assumed to
contain the certificate as well.
You may escape colons in arguments with a backslash, which you will need to
use if you want to specify a full pathname argument on Windows::
serverFromString(reactor,
"ssl:443:privateKey=C\:/key.pem:certKey=C\:/cert.pem")
finally, the 'unix' prefix may be used to specify a filesystem UNIX socket,
optionally with a 'mode' argument to specify the mode of the socket file
created by C{listen}::
serverFromString(reactor, "unix:/var/run/finger")
serverFromString(reactor, "unix:/var/run/finger:mode=660")
This function is also extensible; new endpoint types may be registered as
L{IStreamServerEndpointStringParser} plugins. See that interface for more
information.
@param reactor: The server endpoint will be constructed with this reactor.
@param description: The strports description to parse.
@type description: L{str}
@return: A new endpoint which can be used to listen with the parameters
given by C{description}.
@rtype: L{IStreamServerEndpoint}
@raise ValueError: when the 'description' string cannot be parsed.
@since: 10.2
Nr. r )r r r" r _endpointServerFactories)r r nameOrPluginr r r r
rV rV rW r; s > r; c C s* d\}}||fD ]
}| ||| } q| S )a
Quote an argument to L{serverFromString} and L{clientFromString}. Since
arguments are separated with colons and colons are escaped with
backslashes, some care is necessary if, for example, you have a pathname,
you may be tempted to interpolate into a string like this::
serverFromString(reactor, "ssl:443:privateKey=%s" % (myPathName,))
This may appear to work, but will have portability issues (Windows
pathnames, for example). Usually you should just construct the appropriate
endpoint type rather than interpolating strings, which in this case would
be L{SSL4ServerEndpoint}. There are some use-cases where you may need to
generate such a string, though; for example, a tool to manipulate a
configuration file which has strports descriptions in it. To be correct in
those cases, do this instead::
serverFromString(reactor, "ssl:443:privateKey=%s" %
(quoteStringArgument(myPathName),))
@param argument: The part of the endpoint description string you want to
pass through.
@type argument: C{str}
@return: The quoted argument.
@rtype: C{str}
z\:)replace)argumentr r crV rV rW quoteStringArgument s r c O s t | dkrt| d |d< | d |d< nt | dkr.d|v r(t| d |d< n| d |d< z
t|d |d< W n tyA Y nw z
t|d |d< W n tyU Y nw z |d df|d< W |S tyk Y |S w )a$
Perform any argument value coercion necessary for TCP client parameters.
Valid positional arguments to this function are host and port.
Valid keyword arguments to this function are all L{IReactorTCP.connectTCP}
arguments.
@return: The coerced values as a C{dict}.
r r. r r r r r )r r KeyErrorr r rV rV rW _parseClientTCP! s0 r c C s i }| D ]9}| dd dksqz| }W n ty' Y qw zt|}W n t y8 Y qw |||
< qt | S )z
Load certificate-authority certificate objects in a given directory.
@param directoryPath: a L{unicode} or L{bytes} pointing at a directory to
load .pem files from, or L{None}.
@return: an L{IOpenSSLTrustRoot} provider.
.pem)
children
asTextModebasenamesplitr r OSErrorr2 r SSLErrordigestr7 values)
directoryPathcaCertschildrd theCertrV rV rW _loadCAsFromDirH s r c C s | du rdS t t| S )z
Parse a string referring to a directory full of certificate authorities
into a trust root.
@param pathName: path name
@type pathName: L{unicode} or L{bytes} or L{None}
@return: L{None} or L{IOpenSSLTrustRoot}
N)r r, )pathNamerV rV rW _parseTrustRootPathd s
r c C sL | du rdS t | }|du rt|S tt|tt | dS )ax
Parse a certificate path and key path, either or both of which might be
L{None}, into a certificate object.
@param certificatePath: the certificate path
@type certificatePath: L{bytes} or L{unicode} or L{None}
@param keyPath: the private key path
@type keyPath: L{bytes} or L{unicode} or L{None}
@return: a L{PrivateCertificate} or L{None}
Nr. )r, r r5 r fromCertificateAndKeyPairr2 r4 load)certificatePathkeyPath certBytesrV rV rW _privateCertFromPathss s
r c C s | dd}t| dd| dd}t| dd}|dur)tt|||d}n|dur5|jj}|j}nd}d}t|||d}|| d< | S ) a
Parse common arguments for SSL endpoints, creating an L{CertificateOptions}
instance.
@param kwargs: A dict of keyword arguments to be parsed, potentially
containing keys C{certKey}, C{privateKey}, C{caCertsDir}, and
C{hostname}. See L{_parseClientSSL}.
@type kwargs: L{dict}
@return: The remaining arguments, including a new key C{sslContextFactory}.
hostnameNr r
caCertsDir trustRootclientCertificate)r r r rr )rT r r r6 r0 r r r3 )r r r r
configurationprivateKeyOpenSSLcertificateOpenSSLrV rV rW _parseClientSSLOptions s. r c O s t | i |}t|S )a
Perform any argument value coercion necessary for SSL client parameters.
Valid keyword arguments to this function are all L{IReactorSSL.connectSSL}
arguments except for C{contextFactory}. Instead, C{certKey} (the path name
of the certificate file) C{privateKey} (the path name of the private key
associated with the certificate) are accepted and used to construct a
context factory.
Valid positional arguments to this function are host and port.
@keyword caCertsDir: The one parameter which is not part of
L{IReactorSSL.connectSSL}'s signature, this is a path name used to
construct a list of certificate authority certificates. The directory
will be scanned for files ending in C{.pem}, all of which will be
considered valid certificate authorities for this connection.
@type caCertsDir: L{str}
@keyword hostname: The hostname to use for validating the server's
certificate.
@type hostname: L{unicode}
@return: The coerced values as a L{dict}.
)r r r rV rV rW _parseClientSSL s r c O sr t | dkr | d |d< z
tt|d|d< W n ty" Y nw z t|d |d< W |S ty8 Y |S w )a
Perform any argument value coercion necessary for UNIX client parameters.
Valid keyword arguments to this function are all L{IReactorUNIX.connectUNIX}
keyword arguments except for C{checkPID}. Instead, C{lockfile} is accepted
and has the same meaning. Also C{path} is used instead of C{address}.
Valid positional arguments to this function are C{path}.
@return: The coerced values as a C{dict}.
r. r r r r r )r r r rT r r rV rV rW _parseClientUNIX s r c C sr t |\}}|d}| }|tvr&ttt|}|j| g|R i |S t| |i |}t| | fi |S )a
Construct a client endpoint from a description string.
Client description strings are much like server description strings,
although they take all of their arguments as keywords, aside from host and
port.
You can create a TCP client endpoint with the 'host' and 'port' arguments,
like so::
clientFromString(reactor, "tcp:host=www.example.com:port=80")
or, without specifying host and port keywords::
clientFromString(reactor, "tcp:www.example.com:80")
Or you can specify only one or the other, as in the following 2 examples::
clientFromString(reactor, "tcp:host=www.example.com:80")
clientFromString(reactor, "tcp:www.example.com:port=80")
or an SSL client endpoint with those arguments, plus the arguments used by
the server SSL, for a client certificate::
clientFromString(reactor, "ssl:web.example.com:443:"
"privateKey=foo.pem:certKey=foo.pem")
to specify your certificate trust roots, you can identify a directory with
PEM files in it with the C{caCertsDir} argument::
clientFromString(reactor, "ssl:host=web.example.com:port=443:"
"caCertsDir=/etc/ssl/certs")
Both TCP and SSL client endpoint description strings can include a
'bindAddress' keyword argument, whose value should be a local IPv4
address. This fixes the client socket to that IP address::
clientFromString(reactor, "tcp:www.example.com:80:"
"bindAddress=192.0.2.100")
NB: Fixed client ports are not currently supported in TCP or SSL
client endpoints. The client socket will always use an ephemeral
port assigned by the operating system
You can create a UNIX client endpoint with the 'path' argument and optional
'lockfile' and 'timeout' arguments::
clientFromString(
reactor, b"unix:path=/var/foo/bar:lockfile=1:timeout=9")
or, with the path as a positional argument with or without optional
arguments as in the following 2 examples::
clientFromString(reactor, "unix:/var/foo/bar")
clientFromString(reactor, "unix:/var/foo/bar:lockfile=1:timeout=9")
This function is also extensible; new endpoint types may be registered as
L{IStreamClientEndpointStringParserWithReactor} plugins. See that
interface for more information.
@param reactor: The client endpoint will be constructed with this reactor.
@param description: The strports description to parse.
@type description: L{str}
@return: A new endpoint which can be used to connect with the parameters
given by C{description}.
@rtype: L{IStreamClientEndpoint}
@since: 10.2
r ) r rT r _clientParsersr r$ r parseStreamClient_endpointClientFactories)r r r r anamer
r rV rV rW r: s H
r: c s G fdddt }| | S )a
Connect a protocol instance to an endpoint.
This allows using a client endpoint without having to create a factory.
@param endpoint: A client endpoint to connect to.
@param protocol: A protocol instance.
@return: The result of calling C{connect} on the endpoint, i.e. a
L{Deferred} that will fire with the protocol when connected, or an
appropriate error.
@since: 13.1
c s e Zd Z fddZdS )z'connectProtocol..OneShotFactoryc s S r rV )rR r r rV rW r X s z5connectProtocol..OneShotFactory.buildProtocolN)r\ rp rq r rV r rV rW OneShotFactoryW s r )r r )r_ r r rV r rW rI F s rI c @ r )_WrapperEndpointz2
An endpoint that wraps another endpoint.
c C || _ || _dS )z2
Construct a L{_WrapperEndpoint}.
N_wrappedEndpoint_wrapperFactoryrR wrappedEndpointwrapperFactoryrV rV rW rX d
z_WrapperEndpoint.__init__c C s | j | |dd S )K
Connect the given protocol factory and unwrap its result.
c S s | j S r )rT r rV rV rW r q s z*_WrapperEndpoint.connect..)r r r! r r rV rV rW r k s
z_WrapperEndpoint.connectNr rV rV rV rW r ^ r c @ r )_WrapperServerEndpointz?
A server endpoint that wraps another server endpoint.
c C r )z8
Construct a L{_WrapperServerEndpoint}.
Nr r" rV rV rW rX z r% z _WrapperServerEndpoint.__init__c C s | j | |S )r& )r r r! r rV rV rW r s z _WrapperServerEndpoint.listenNr rV rV rV rW r( t r' r( c s" t du rtdt| fddS )a
Wrap an endpoint which upgrades to TLS as soon as the connection is
established.
@since: 16.0
@param connectionCreator: The TLS options to use when connecting; see
L{twisted.internet.ssl.optionsForClientTLS} for how to construct this.
@type connectionCreator:
L{twisted.internet.interfaces.IOpenSSLClientConnectionCreator}
@param wrappedEndpoint: The endpoint to wrap.
@type wrappedEndpoint: An L{IStreamClientEndpoint} provider.
@return: an endpoint that provides transport level encryption layered on
top of C{wrappedEndpoint}
@rtype: L{twisted.internet.interfaces.IStreamClientEndpoint}
Nz6OpenSSL not available. Try `pip install twisted[tls]`.c s t d| S rb r8 )r connectionCreatorrV rW r s z wrapClientTLS..)r9 NotImplementedErrorr )r* r# rV r) rW rJ s
rJ 30c
K s | r t dt| t|tr|n|d}t|ts |du r"|n|d}t|}t|}tt|t |t
||d|durEt | |S t | t
||||S )a
Internal method to construct an endpoint from string parameters.
@param reactor: The reactor passed to L{clientFromString}.
@param host: The hostname to connect to.
@type host: L{bytes} or L{unicode}
@param port: The port to connect to.
@type port: L{bytes} or L{unicode}
@param timeout: For each individual connection attempt, the number of
seconds to wait before assuming the connection has failed.
@type timeout: L{bytes} or L{unicode}
@param bindAddress: The address to which to bind outgoing connections.
@type bindAddress: L{bytes} or L{unicode}
@param certificate: a string representing a filesystem path to a
PEM-encoded certificate.
@type certificate: L{bytes} or L{unicode}
@param privateKey: a string representing a filesystem path to a PEM-encoded
certificate.
@type privateKey: L{bytes} or L{unicode}
@param endpoint: an optional string endpoint description of an endpoint to
wrap; if this is passed then C{host} is used only for certificate
verification.
@type endpoint: L{bytes} or L{unicode}
@return: a client TLS endpoint
@rtype: L{IStreamClientEndpoint}
z&unrecognized keyword arguments presentzutf-8Nr ) TypeErrorrn keysr? r" r@ r rJ r6 r r r: rG r/ )
r r r r r r r
trustRootsr_ r rV rV rW _parseClientTLS s, .r0 c @ s e Zd ZdZdZedd ZdS )_TLSClientEndpointParserz
Stream client endpoint string parser for L{wrapClientTLS} with
L{HostnameEndpoint}.
@ivar prefix: See
L{IStreamClientEndpointStringParserWithReactor.prefix}.
tlsc O s t | g|R i |S )a
Redirects to another function L{_parseClientTLS}; tricks zope.interface
into believing the interface is correctly implemented, since the
signature is (C{reactor}, C{*args}, C{**kwargs}). See
L{_parseClientTLS} for the specific signature description for this
endpoint parser.
@param reactor: The reactor passed to L{clientFromString}.
@param args: The positional arguments in the endpoint description.
@type args: L{tuple}
@param kwargs: The named arguments in the endpoint description.
@type kwargs: L{dict}
@return: a client TLS endpoint
@rtype: L{IStreamClientEndpoint}
)r0 )r r r rV rV rW r s z*_TLSClientEndpointParser.parseStreamClientN)r\ rp rq rr r r r rV rV rV rW r1 s
r1 )r r )r r T)r NNr r NN)r, NNNNN)rr r r r r5 unicodedatar zope.interfacer r r
constantlyr r incrementalr r r r
r r r
twisted.internet.abstractr r twisted.internet.addressr r r r twisted.internet.interfacesr r r r r twisted.internet.protocolr r r r twisted.internet.stdior r ImportErrortwisted.internet._resolverr twisted.internet.deferr twisted.internet.taskr! twisted.loggerr" twisted.pluginr# r$ twisted.pythonr% r& twisted.python.compatr' r( r) twisted.python.componentsr* twisted.python.failurer+ twisted.python.filepathr, twisted.python.systemdr- _idnar/ r0 OpenSSL.SSLr1 r twisted.internet.sslr2 r3 r4 r5 r6 r7 twisted.protocols.tlsr9 _TLSMemoryBIOFactory__all__rK rs IStreamServerEndpointrE IProcessTransport IConsumer
IPushProducerr r r rH IStreamClientEndpointrF r r< r= r> r? r rG rB rC r@ rA rD r r r r r r r ranger r r r r r r r r; r r r r r r r r r r: rI r r( rJ r0 r1 rV rV rV rW s Q_
@C%/IF V*7#(
/
"
^0& *# I#' ( T#
D