0x1949 Team - FAZEMRX - MANAGER
Edit File: interfaces.cpython-310.pyc
o �b � @ sb d Z ddlmZmZmZmZmZmZmZm Z m Z m Z m Z ddl mZmZ ddlmZ er�ddlmZ z ddlmZmZ W n eyI e ZZY nw ddlm Z ddl m Z m Z m Z dd l!m"Z" dd l#m$Z$m%Z%m&Z&m'Z'm(Z( dd l)m*Z* dd l+m,Z,m-Z- dd l.m/Z/ ddl0m1Z1 e1�2� r�ddl3m4Z4 neZ4G dd� de�Z5G dd� de�Z6G dd� de�Z7G dd� de�Z8G dd� de�Z9G dd� de�Z:G d d � d e7�Z;G d d � d e�Z<G d d!� d!e�Z=G d"d#� d#e�Z>G d$d%� d%e�Z?G d&d'� d'e�Z@G d(d)� d)e�ZAG d*d+� d+e�ZBG d,d-� d-e�ZCG d.d/� d/e�ZDG d0d1� d1e�ZEG d2d3� d3e�ZFG d4d5� d5e�ZGG d6d7� d7e�ZHG d8d9� d9eGeH�ZIG d:d;� d;e�ZJG d<d=� d=e�ZKG d>d?� d?e�ZLG d@dA� dAe�ZMG dBdC� dCe�ZNG dDdE� dEe�ZOG dFdG� dGe�ZPG dHdI� dIeP�ZQG dJdK� dKeQ�ZRG dLdM� dMeQ�ZSG dNdO� dOeReS�ZTG dPdQ� dQe�ZUG dRdS� dSe�ZVG dTdU� dUe�ZWG dVdW� dWe�ZXG dXdY� dYeX�ZYG dZd[� d[eX�ZZG d\d]� d]e�Z[G d^d_� d_e�Z\G d`da� dae�Z]G dbdc� dce�Z^G ddde� dee�Z_G dfdg� dge�Z`G dhdi� die�ZaG djdk� dkea�ZbG dldm� dmea�ZcG dndo� doe�ZdG dpdq� dqe�ZeG drds� dse�ZfG dtdu� due�ZgG dvdw� dweb�ZhG dxdy� dyeb�ZiG dzd{� d{ei�ZjG d|d}� d}e�ZkG d~d� de�ZlG d�d�� d�ea�ZmG d�d�� d�e�ZnG d�d�� d�e�ZoG d�d�� d�e�ZpG d�d�� d�e�ZqG d�d�� d�e�ZrG d�d�� d�e�ZsG d�d�� d�e�ZtG d�d�� d�e�ZuG d�d�� d�e�ZvG d�d�� d�e�Zwd�S )�z> Interface documentation. Maintainer: Itamar Shtull-Trauring � ) � TYPE_CHECKING�Any�AnyStr�Callable�Iterable�List�Mapping�Optional�Sequence�Tuple�Union)� Attribute� Interface)�Failure)� AddressFamily)� Connection�Context)�FileDescriptor)� IPv4Address� IPv6Address� UNIXAddress)�Deferred)� ClientFactory�ConnectedDatagramProtocol�DatagramProtocol�Factory� ServerFactory)�ClientContextFactory)�Query�RRHeader)�TLSMemoryBIOProtocol)�platform)� ThreadPoolc @ � e Zd ZdZdS )�IAddresszr An address, e.g. a TCP C{(host, port)}. Default implementations are in L{twisted.internet.address}. N��__name__� __module__� __qualname__�__doc__� r* r* �=/usr/lib/python3/dist-packages/twisted/internet/interfaces.pyr$ < � r$ c @ s< e Zd ZdZd dd�Zd dd�Zd dd �Zdefd d �ZdS ) � IConnectorzu Object used to interface between connections and protocols. Each L{IConnector} manages one connection. �returnNc C � dS )z- Stop attempting to connect. Nr* r* r* r* r+ �stopConnectingN � zIConnector.stopConnectingc C r/ )z� Disconnect regardless of the connection state. If we are connected, disconnect, if we are trying to connect, stop trying. Nr* r* r* r* r+ � disconnectS r1 zIConnector.disconnectc C r/ )z3 Try to connect to remote address. Nr* r* r* r* r+ �connect[ r1 zIConnector.connectc C r/ )zy Return destination this will try to connect to. @return: An object which provides L{IAddress}. Nr* r* r* r* r+ �getDestination` r1 zIConnector.getDestination�r. N) r& r' r( r) r0 r2 r3 r$ r4 r* r* r* r+ r- G s r- c @ s& e Zd Zdedee ddfdd�ZdS )�IResolverSimple�name�timeoutr. � Deferred[str]c C r/ )a� Resolve the domain name C{name} into an IP address. @param name: DNS name to resolve. @param timeout: Number of seconds after which to reissue the query. When the last timeout expires, the query is considered failed. @return: The callback of the Deferred that is returned will be passed a string that represents the IP address of the specified name, or the errback will be called if the lookup times out. If multiple types of address records are associated with the name, A6 records will be returned in preference to AAAA records, which will be returned in preference to A records. If there are multiple records of the type to be returned, one will be selected at random. @raise twisted.internet.defer.TimeoutError: Raised (asynchronously) if the name cannot be resolved within the specified timeout period. Nr* �r7 r8 r* r* r+ � getHostByNamei r1 z IResolverSimple.getHostByNameN)r& r' r( �strr �intr; r* r* r* r+ r6 h s r6 c @ s" e Zd ZdZed�Zddd�ZdS )�IHostResolutionz� An L{IHostResolution} represents represents an in-progress recursive query for a DNS name. @since: Twisted 17.1.0 zB L{unicode}; the name of the host being resolved. r. Nc C r/ )z; Stop the hostname resolution in progress. Nr* r* r* r* r+ �cancel� r1 zIHostResolution.cancelr5 )r& r' r( r) r r7 r? r* r* r* r+ r> � s �r> c @ s> e Zd ZdZdeddfdd�Zdeddfdd �Zd d d �ZdS ) �IResolutionReceiverz� An L{IResolutionReceiver} receives the results of a hostname resolution in progress, initiated by an L{IHostnameResolver}. @since: Twisted 17.1.0 �resolutionInProgressr. Nc C r/ )zk A hostname resolution began. @param resolutionInProgress: an L{IHostResolution}. Nr* )rA r* r* r+ �resolutionBegan� r1 z#IResolutionReceiver.resolutionBegan�addressc C r/ )a� An internet address. This is called when an address for the given name is discovered. In the current implementation this practically means L{IPv4Address} or L{IPv6Address}, but implementations of this interface should be lenient to other types being passed to this interface as well, for future-proofing. @param address: An address object. Nr* )rC r* r* r+ �addressResolved� r1 z#IResolutionReceiver.addressResolvedc C r/ )z� Resolution has completed; no further addresses will be relayed to L{IResolutionReceiver.addressResolved}. Nr* r* r* r* r+ �resolutionComplete� r1 z&IResolutionReceiver.resolutionCompleter5 ) r& r' r( r) r> rB r$ rD rE r* r* r* r+ r@ � s r@ c @ s6 e Zd ZdZdedededee dedef dd �Z d S ) �IHostnameResolverz� An L{IHostnameResolver} can resolve a host name and port number into a series of L{IAddress} objects. @since: Twisted 17.1.0 �resolutionReceiver�hostName� portNumber� addressTypes�transportSemanticsr. c C r/ )a� Initiate a hostname resolution. @param resolutionReceiver: an object that will receive each resolved address as it arrives. @param hostName: The name of the host to resolve. If this contains non-ASCII code points, they will be converted to IDNA first. @param portNumber: The port number that the returned addresses should include. @param addressTypes: An iterable of implementors of L{IAddress} that are acceptable values for C{resolutionReceiver} to receive to its L{addressResolved <IResolutionReceiver.addressResolved>}. In practice, this means an iterable containing L{twisted.internet.address.IPv4Address}, L{twisted.internet.address.IPv6Address}, both, or neither. @param transportSemantics: A string describing the semantics of the transport; either C{'TCP'} for stream-oriented transports or C{'UDP'} for datagram-oriented; see L{twisted.internet.address.IPv6Address.type} and L{twisted.internet.address.IPv4Address.type}. @return: The resolution in progress. Nr* )rG rH rI rJ rK r* r* r+ �resolveHostName� r1 z!IHostnameResolver.resolveHostNameN) r& r' r( r) r@ r< r= r r$ rL r* r* r* r+ rF � s ������rF c @ s| e Zd Zdddee ddfdd�Zdedee ddfd d �Zdedee ddfd d �Zdedee ddfd d�Z dedee ddfdd�Z dedee ddfdd�Z dedee ddfdd�Z dedee ddfdd�Z dedee ddfdd�Zdedee ddfdd�Zdedee ddfdd �Zdedee ddfd d �Zdedee ddfd d �Zdedee ddfd!d"�Zdedee ddfd#d$�Zdedee ddfd%d&�Zdedee ddfd'd(�Zdedee ddfd)d*�Zdedee ddfd+d,�Zdedee ddfd-d.�Zdedee ddfd/d0�Zdedee ddfd1d2�Zdedee ddfd3d4�Z dedee ddfd5d6�Z d7S )8� IResolver�queryr r8 r. z-Deferred[Tuple[RRHeader, RRHeader, RRHeader]]c C r/ )a& Dispatch C{query} to the method which can handle its type. @param query: The DNS query being issued, to which a response is to be generated. @param timeout: Number of seconds after which to reissue the query. When the last timeout expires, the query is considered failed. @return: A L{Deferred} which fires with a three-tuple of lists of L{twisted.names.dns.RRHeader} instances. The first element of the tuple gives answers. The second element of the tuple gives authorities. The third element of the tuple gives additional information. The L{Deferred} may instead fail with one of the exceptions defined in L{twisted.names.error} or with C{NotImplementedError}. Nr* )rN r8 r* r* r+ rN � r1 zIResolver.queryr7 c C r/ )a� Perform an A record lookup. @param name: DNS name to resolve. @param timeout: Number of seconds after which to reissue the query. When the last timeout expires, the query is considered failed. @return: A L{Deferred} which fires with a three-tuple of lists of L{twisted.names.dns.RRHeader} instances. The first element of the tuple gives answers. The second element of the tuple gives authorities. The third element of the tuple gives additional information. The L{Deferred} may instead fail with one of the exceptions defined in L{twisted.names.error} or with C{NotImplementedError}. Nr* r: r* r* r+ � lookupAddress� r1 zIResolver.lookupAddressc C r/ )a� Perform an A6 record lookup. @param name: DNS name to resolve. @param timeout: Number of seconds after which to reissue the query. When the last timeout expires, the query is considered failed. @return: A L{Deferred} which fires with a three-tuple of lists of L{twisted.names.dns.RRHeader} instances. The first element of the tuple gives answers. The second element of the tuple gives authorities. The third element of the tuple gives additional information. The L{Deferred} may instead fail with one of the exceptions defined in L{twisted.names.error} or with C{NotImplementedError}. Nr* r: r* r* r+ �lookupAddress6 r1 zIResolver.lookupAddress6c C r/ )a� Perform an AAAA record lookup. @param name: DNS name to resolve. @param timeout: Number of seconds after which to reissue the query. When the last timeout expires, the query is considered failed. @return: A L{Deferred} which fires with a three-tuple of lists of L{twisted.names.dns.RRHeader} instances. The first element of the tuple gives answers. The second element of the tuple gives authorities. The third element of the tuple gives additional information. The L{Deferred} may instead fail with one of the exceptions defined in L{twisted.names.error} or with C{NotImplementedError}. Nr* r: r* r* r+ �lookupIPV6Address r1 zIResolver.lookupIPV6Addressc C r/ )a� Perform an MX record lookup. @param name: DNS name to resolve. @param timeout: Number of seconds after which to reissue the query. When the last timeout expires, the query is considered failed. @return: A L{Deferred} which fires with a three-tuple of lists of L{twisted.names.dns.RRHeader} instances. The first element of the tuple gives answers. The second element of the tuple gives authorities. The third element of the tuple gives additional information. The L{Deferred} may instead fail with one of the exceptions defined in L{twisted.names.error} or with C{NotImplementedError}. Nr* r: r* r* r+ �lookupMailExchange+ r1 z IResolver.lookupMailExchangec C r/ )a� Perform an NS record lookup. @param name: DNS name to resolve. @param timeout: Number of seconds after which to reissue the query. When the last timeout expires, the query is considered failed. @return: A L{Deferred} which fires with a three-tuple of lists of L{twisted.names.dns.RRHeader} instances. The first element of the tuple gives answers. The second element of the tuple gives authorities. The third element of the tuple gives additional information. The L{Deferred} may instead fail with one of the exceptions defined in L{twisted.names.error} or with C{NotImplementedError}. Nr* r: r* r* r+ �lookupNameservers> r1 zIResolver.lookupNameserversc C r/ )a� Perform a CNAME record lookup. @param name: DNS name to resolve. @param timeout: Number of seconds after which to reissue the query. When the last timeout expires, the query is considered failed. @return: A L{Deferred} which fires with a three-tuple of lists of L{twisted.names.dns.RRHeader} instances. The first element of the tuple gives answers. The second element of the tuple gives authorities. The third element of the tuple gives additional information. The L{Deferred} may instead fail with one of the exceptions defined in L{twisted.names.error} or with C{NotImplementedError}. Nr* r: r* r* r+ �lookupCanonicalNameQ r1 z IResolver.lookupCanonicalNamec C r/ )a� Perform an MB record lookup. @param name: DNS name to resolve. @param timeout: Number of seconds after which to reissue the query. When the last timeout expires, the query is considered failed. @return: A L{Deferred} which fires with a three-tuple of lists of L{twisted.names.dns.RRHeader} instances. The first element of the tuple gives answers. The second element of the tuple gives authorities. The third element of the tuple gives additional information. The L{Deferred} may instead fail with one of the exceptions defined in L{twisted.names.error} or with C{NotImplementedError}. Nr* r: r* r* r+ � lookupMailBoxd r1 zIResolver.lookupMailBoxc C r/ )a� Perform an MG record lookup. @param name: DNS name to resolve. @param timeout: Number of seconds after which to reissue the query. When the last timeout expires, the query is considered failed. @return: A L{Deferred} which fires with a three-tuple of lists of L{twisted.names.dns.RRHeader} instances. The first element of the tuple gives answers. The second element of the tuple gives authorities. The third element of the tuple gives additional information. The L{Deferred} may instead fail with one of the exceptions defined in L{twisted.names.error} or with C{NotImplementedError}. Nr* r: r* r* r+ �lookupMailGroupw r1 zIResolver.lookupMailGroupc C r/ )a� Perform an MR record lookup. @param name: DNS name to resolve. @param timeout: Number of seconds after which to reissue the query. When the last timeout expires, the query is considered failed. @return: A L{Deferred} which fires with a three-tuple of lists of L{twisted.names.dns.RRHeader} instances. The first element of the tuple gives answers. The second element of the tuple gives authorities. The third element of the tuple gives additional information. The L{Deferred} may instead fail with one of the exceptions defined in L{twisted.names.error} or with C{NotImplementedError}. Nr* r: r* r* r+ �lookupMailRename� r1 zIResolver.lookupMailRenamec C r/ )a� Perform a PTR record lookup. @param name: DNS name to resolve. @param timeout: Number of seconds after which to reissue the query. When the last timeout expires, the query is considered failed. @return: A L{Deferred} which fires with a three-tuple of lists of L{twisted.names.dns.RRHeader} instances. The first element of the tuple gives answers. The second element of the tuple gives authorities. The third element of the tuple gives additional information. The L{Deferred} may instead fail with one of the exceptions defined in L{twisted.names.error} or with C{NotImplementedError}. Nr* r: r* r* r+ � lookupPointer� r1 zIResolver.lookupPointerc C r/ )a� Perform an SOA record lookup. @param name: DNS name to resolve. @param timeout: Number of seconds after which to reissue the query. When the last timeout expires, the query is considered failed. @return: A L{Deferred} which fires with a three-tuple of lists of L{twisted.names.dns.RRHeader} instances. The first element of the tuple gives answers. The second element of the tuple gives authorities. The third element of the tuple gives additional information. The L{Deferred} may instead fail with one of the exceptions defined in L{twisted.names.error} or with C{NotImplementedError}. Nr* r: r* r* r+ �lookupAuthority� r1 zIResolver.lookupAuthorityc C r/ )a� Perform a NULL record lookup. @param name: DNS name to resolve. @param timeout: Number of seconds after which to reissue the query. When the last timeout expires, the query is considered failed. @return: A L{Deferred} which fires with a three-tuple of lists of L{twisted.names.dns.RRHeader} instances. The first element of the tuple gives answers. The second element of the tuple gives authorities. The third element of the tuple gives additional information. The L{Deferred} may instead fail with one of the exceptions defined in L{twisted.names.error} or with C{NotImplementedError}. Nr* r: r* r* r+ � lookupNull� r1 zIResolver.lookupNullc C r/ )a� Perform a WKS record lookup. @param name: DNS name to resolve. @param timeout: Number of seconds after which to reissue the query. When the last timeout expires, the query is considered failed. @return: A L{Deferred} which fires with a three-tuple of lists of L{twisted.names.dns.RRHeader} instances. The first element of the tuple gives answers. The second element of the tuple gives authorities. The third element of the tuple gives additional information. The L{Deferred} may instead fail with one of the exceptions defined in L{twisted.names.error} or with C{NotImplementedError}. Nr* r: r* r* r+ �lookupWellKnownServices� r1 z!IResolver.lookupWellKnownServicesc C r/ )a� Perform a HINFO record lookup. @param name: DNS name to resolve. @param timeout: Number of seconds after which to reissue the query. When the last timeout expires, the query is considered failed. @return: A L{Deferred} which fires with a three-tuple of lists of L{twisted.names.dns.RRHeader} instances. The first element of the tuple gives answers. The second element of the tuple gives authorities. The third element of the tuple gives additional information. The L{Deferred} may instead fail with one of the exceptions defined in L{twisted.names.error} or with C{NotImplementedError}. Nr* r: r* r* r+ �lookupHostInfo� r1 zIResolver.lookupHostInfoc C r/ )a� Perform an MINFO record lookup. @param name: DNS name to resolve. @param timeout: Number of seconds after which to reissue the query. When the last timeout expires, the query is considered failed. @return: A L{Deferred} which fires with a three-tuple of lists of L{twisted.names.dns.RRHeader} instances. The first element of the tuple gives answers. The second element of the tuple gives authorities. The third element of the tuple gives additional information. The L{Deferred} may instead fail with one of the exceptions defined in L{twisted.names.error} or with C{NotImplementedError}. Nr* r: r* r* r+ �lookupMailboxInfo� r1 zIResolver.lookupMailboxInfoc C r/ )a� Perform a TXT record lookup. @param name: DNS name to resolve. @param timeout: Number of seconds after which to reissue the query. When the last timeout expires, the query is considered failed. @return: A L{Deferred} which fires with a three-tuple of lists of L{twisted.names.dns.RRHeader} instances. The first element of the tuple gives answers. The second element of the tuple gives authorities. The third element of the tuple gives additional information. The L{Deferred} may instead fail with one of the exceptions defined in L{twisted.names.error} or with C{NotImplementedError}. Nr* r: r* r* r+ � lookupText r1 zIResolver.lookupTextc C r/ )a� Perform an RP record lookup. @param name: DNS name to resolve. @param timeout: Number of seconds after which to reissue the query. When the last timeout expires, the query is considered failed. @return: A L{Deferred} which fires with a three-tuple of lists of L{twisted.names.dns.RRHeader} instances. The first element of the tuple gives answers. The second element of the tuple gives authorities. The third element of the tuple gives additional information. The L{Deferred} may instead fail with one of the exceptions defined in L{twisted.names.error} or with C{NotImplementedError}. Nr* r: r* r* r+ �lookupResponsibility" r1 z IResolver.lookupResponsibilityc C r/ )a� Perform an AFSDB record lookup. @param name: DNS name to resolve. @param timeout: Number of seconds after which to reissue the query. When the last timeout expires, the query is considered failed. @return: A L{Deferred} which fires with a three-tuple of lists of L{twisted.names.dns.RRHeader} instances. The first element of the tuple gives answers. The second element of the tuple gives authorities. The third element of the tuple gives additional information. The L{Deferred} may instead fail with one of the exceptions defined in L{twisted.names.error} or with C{NotImplementedError}. Nr* r: r* r* r+ �lookupAFSDatabase5 r1 zIResolver.lookupAFSDatabasec C r/ )a� Perform an SRV record lookup. @param name: DNS name to resolve. @param timeout: Number of seconds after which to reissue the query. When the last timeout expires, the query is considered failed. @return: A L{Deferred} which fires with a three-tuple of lists of L{twisted.names.dns.RRHeader} instances. The first element of the tuple gives answers. The second element of the tuple gives authorities. The third element of the tuple gives additional information. The L{Deferred} may instead fail with one of the exceptions defined in L{twisted.names.error} or with C{NotImplementedError}. Nr* r: r* r* r+ � lookupServiceH r1 zIResolver.lookupServicec C r/ )a� Perform an ALL_RECORD lookup. @param name: DNS name to resolve. @param timeout: Number of seconds after which to reissue the query. When the last timeout expires, the query is considered failed. @return: A L{Deferred} which fires with a three-tuple of lists of L{twisted.names.dns.RRHeader} instances. The first element of the tuple gives answers. The second element of the tuple gives authorities. The third element of the tuple gives additional information. The L{Deferred} may instead fail with one of the exceptions defined in L{twisted.names.error} or with C{NotImplementedError}. Nr* r: r* r* r+ �lookupAllRecords[ r1 zIResolver.lookupAllRecordsc C r/ )a� Perform a SPF record lookup. @param name: DNS name to resolve. @param timeout: Number of seconds after which to reissue the query. When the last timeout expires, the query is considered failed. @return: A L{Deferred} which fires with a three-tuple of lists of L{twisted.names.dns.RRHeader} instances. The first element of the tuple gives answers. The second element of the tuple gives authorities. The third element of the tuple gives additional information. The L{Deferred} may instead fail with one of the exceptions defined in L{twisted.names.error} or with C{NotImplementedError}. Nr* r: r* r* r+ �lookupSenderPolicyn r1 z IResolver.lookupSenderPolicyc C r/ )a� Perform a NAPTR record lookup. @param name: DNS name to resolve. @param timeout: Number of seconds after which to reissue the query. When the last timeout expires, the query is considered failed. @return: A L{Deferred} which fires with a three-tuple of lists of L{twisted.names.dns.RRHeader} instances. The first element of the tuple gives answers. The second element of the tuple gives authorities. The third element of the tuple gives additional information. The L{Deferred} may instead fail with one of the exceptions defined in L{twisted.names.error} or with C{NotImplementedError}. Nr* r: r* r* r+ � lookupNamingAuthorityPointer� r1 z&IResolver.lookupNamingAuthorityPointerc C r/ )aT Perform an AXFR record lookup. NB This is quite different from other DNS requests. See U{http://cr.yp.to/djbdns/axfr-notes.html} for more information. NB Unlike other C{lookup*} methods, the timeout here is not a list of ints, it is a single int. @param name: DNS name to resolve. @param timeout: When this timeout expires, the query is considered failed. @return: A L{Deferred} which fires with a three-tuple of lists of L{twisted.names.dns.RRHeader} instances. The first element of the tuple gives answers. The second and third elements are always empty. The L{Deferred} may instead fail with one of the exceptions defined in L{twisted.names.error} or with C{NotImplementedError}. Nr* r: r* r* r+ � lookupZone� r1 zIResolver.lookupZoneN) r& r' r( r r= rN r< rO rP rQ rR rS rT rU rV rW rX rY rZ r[ r\ r] r^ r_ r` ra rb rc rd re r* r* r* r+ rM � sR �� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ����rM c @ sX e Zd Zdedddededdf dd �Zd ededd d ed eeeef de f dd�Z dS )� IReactorTCP�port�factoryr �backlog� interfacer. �IListeningPortc C r/ )a6 Connects a given protocol factory to the given numeric TCP/IP port. @param port: a port number on which to listen @param factory: a L{twisted.internet.protocol.ServerFactory} instance @param backlog: size of the listen queue @param interface: The local IPv4 or IPv6 address to which to bind; defaults to '', ie all IPv4 addresses. To bind to all IPv4 and IPv6 addresses, you must call this method twice. @return: an object that provides L{IListeningPort}. @raise CannotListenError: as defined here L{twisted.internet.error.CannotListenError}, if it cannot listen on this port (e.g., it cannot bind to the required port number) Nr* )rg rh ri rj r* r* r+ � listenTCP� r1 zIReactorTCP.listenTCP�hostr r8 � bindAddressc C r/ )a� Connect a TCP client. @param host: A hostname or an IPv4 or IPv6 address literal. @param port: a port number @param factory: a L{twisted.internet.protocol.ClientFactory} instance @param timeout: number of seconds to wait before assuming the connection has failed. @param bindAddress: a (host, port) tuple of local address to bind to, or None. @return: An object which provides L{IConnector}. This connector will call various callbacks on the factory when a connection is made, failed, or lost - see L{ClientFactory<twisted.internet.protocol.ClientFactory>} docs for details. Nr* )rm rg rh r8 rn r* r* r+ � connectTCP� r1 zIReactorTCP.connectTCPN) r& r' r( r= r< rl �floatr r r- ro r* r* r* r+ rf � s2 ���� �������rf c @ s` e Zd Zdededddddedeeeef d efd d �Z dedd dd deded ef dd�Z dS )� IReactorSSLrm rg rh r �contextFactoryr r8 rn r. c C r/ )aQ Connect a client Protocol to a remote SSL socket. @param host: a host name @param port: a port number @param factory: a L{twisted.internet.protocol.ClientFactory} instance @param contextFactory: a L{twisted.internet.ssl.ClientContextFactory} object. @param timeout: number of seconds to wait before assuming the connection has failed. @param bindAddress: a (host, port) tuple of local address to bind to, or L{None}. @return: An object which provides L{IConnector}. Nr* )rm rg rh rr r8 rn r* r* r+ � connectSSL� r1 zIReactorSSL.connectSSLr �IOpenSSLContextFactoryri rj c C r/ )a� Connects a given protocol factory to the given numeric TCP/IP port. The connection is a SSL one, using contexts created by the context factory. @param port: a port number on which to listen @param factory: a L{twisted.internet.protocol.ServerFactory} instance @param contextFactory: an implementor of L{IOpenSSLContextFactory} @param backlog: size of the listen queue @param interface: the hostname to bind to, defaults to '' (all) Nr* )rg rh rr ri rj r* r* r+ � listenSSL� r1 zIReactorSSL.listenSSLN) r& r' r( r< r= rp r r r- rs ru r* r* r* r+ rq � s: ������ �������rq c @ sP e Zd ZdZdedddededef dd �Zdedd d e d e d eddf dd�Z dS )� IReactorUNIXz UNIX socket methods. rC rh r r8 �checkPIDr. c C r/ )a1 Connect a client protocol to a UNIX socket. @param address: a path to a unix socket on the filesystem. @param factory: a L{twisted.internet.protocol.ClientFactory} instance @param timeout: number of seconds to wait before assuming the connection has failed. @param checkPID: if True, check for a pid file to verify that a server is listening. If C{address} is a Linux abstract namespace path, this must be C{False}. @return: An object which provides L{IConnector}. Nr* )rC rh r8 rw r* r* r+ � connectUNIX r1 zIReactorUNIX.connectUNIXr ri �mode�wantPIDrk c C r/ )a� Listen on a UNIX socket. @param address: a path to a unix socket on the filesystem. @param factory: a L{twisted.internet.protocol.Factory} instance. @param backlog: number of connections to allow in backlog. @param mode: The mode (B{not} umask) to set on the unix socket. See platform specific documentation for information about how this might affect connection attempts. @param wantPID: if True, create a pidfile for the socket. If C{address} is a Linux abstract namespace path, this must be C{False}. @return: An object which provides L{IListeningPort}. Nr* )rC rh ri ry rz r* r* r+ � listenUNIX! r1 zIReactorUNIX.listenUNIXN) r& r' r( r) r< rp �boolr- rx r= r{ r* r* r* r+ rv s4 ���� �������rv c @ s\ e Zd ZdZdedddededeeeef def d d �Z dedd dededd f d d�Z dS )�IReactorUNIXDatagramz' Datagram UNIX socket methods. rC �protocolr � maxPacketSizery rn r. c C r/ )aQ Connect a client protocol to a datagram UNIX socket. @param address: a path to a unix socket on the filesystem. @param protocol: a L{twisted.internet.protocol.ConnectedDatagramProtocol} instance @param maxPacketSize: maximum packet size to accept @param mode: The mode (B{not} umask) to set on the unix socket. See platform specific documentation for information about how this might affect connection attempts. @param bindAddress: address to bind to @return: An object which provides L{IConnector}. Nr* )rC r~ r ry rn r* r* r+ �connectUNIXDatagram9 r1 z(IReactorUNIXDatagram.connectUNIXDatagramr rk c C r/ )a Listen on a datagram UNIX socket. @param address: a path to a unix socket on the filesystem. @param protocol: a L{twisted.internet.protocol.DatagramProtocol} instance. @param maxPacketSize: maximum packet size to accept @param mode: The mode (B{not} umask) to set on the unix socket. See platform specific documentation for information about how this might affect connection attempts. @return: An object which provides L{IListeningPort}. Nr* )rC r~ r ry r* r* r+ �listenUNIXDatagramO r1 z'IReactorUNIXDatagram.listenUNIXDatagramN) r& r' r( r) r< r= r r r- r� r� r* r* r* r+ r} 4 s4 ����� ������r} c @ s< e Zd ZdZdedddeddfdd �Zdeddfd d �ZdS ) �IReactorWin32Eventsz3 Win32 Event API methods @since: 10.2 �event�fdr �actionr. Nc C r/ )al Add a new win32 event to the event loop. @param event: a Win32 event object created using win32event.CreateEvent() @param fd: an instance of L{twisted.internet.abstract.FileDescriptor} @param action: a string that is a method name of the fd instance. This method is called in response to the event. Nr* )r� r� r� r* r* r+ �addEventg r1 z IReactorWin32Events.addEventc C r/ )z� Remove an event. @param event: a Win32 event object added using L{IReactorWin32Events.addEvent} @return: None Nr* )r� r* r* r+ � removeEventq r1 z IReactorWin32Events.removeEvent)r& r' r( r) �objectr< r� r� r* r* r* r+ r� ` s r� c @ s. e Zd ZdZdedddededdf d d �Zd S ) � IReactorUDPz UDP socket methods. rg r~ r rj r r. rk c C r/ )a� Connects a given L{DatagramProtocol} to the given numeric UDP port. @param port: A port number on which to listen. @param protocol: A L{DatagramProtocol} instance which will be connected to the given C{port}. @param interface: The local IPv4 or IPv6 address to which to bind; defaults to '', ie all IPv4 addresses. @param maxPacketSize: The maximum packet size to accept. @return: object which provides L{IListeningPort}. Nr* )rg r~ rj r r* r* r+ � listenUDP� r1 zIReactorUDP.listenUDPN)r& r' r( r) r= r< r� r* r* r* r+ r� { s �����r� c @ s2 e Zd ZdZdedddedededd f d d �Zd S ) �IReactorMulticastz� UDP socket methods that support multicast. IMPORTANT: This is an experimental new interface. It may change without backwards compatibility. Suggestions are welcome. rg r~ r rj r �listenMultipler. rk c C r/ )a� Connects a given L{DatagramProtocol<twisted.internet.protocol.DatagramProtocol>} to the given numeric UDP port. @param listenMultiple: If set to True, allows multiple sockets to bind to the same address and port number at the same time. @returns: An object which provides L{IListeningPort}. @see: L{twisted.internet.interfaces.IMulticastTransport} @see: U{http://twistedmatrix.com/documents/current/core/howto/udp.html} Nr* )rg r~ rj r r� r* r* r+ �listenMulticast� r1 z!IReactorMulticast.listenMulticastN)r& r' r( r) r= r< r| r� r* r* r* r+ r� � s ������r� c @ sb e Zd ZdZdeddddddfd d �Zdedddddd fd d �Zdedddddeddf dd�Zd S )�IReactorSocketa Methods which allow a reactor to use externally created sockets. For example, to use C{adoptStreamPort} to implement behavior equivalent to that of L{IReactorTCP.listenTCP}, you might write code like this:: from socket import SOMAXCONN, AF_INET, SOCK_STREAM, socket portSocket = socket(AF_INET, SOCK_STREAM) # Set FD_CLOEXEC on port, left as an exercise. Then make it into a # non-blocking listening port: portSocket.setblocking(False) portSocket.bind(('192.168.1.2', 12345)) portSocket.listen(SOMAXCONN) # Now have the reactor use it as a TCP port port = reactor.adoptStreamPort( portSocket.fileno(), AF_INET, YourFactory()) # portSocket itself is no longer necessary, and needs to be cleaned # up by us. portSocket.close() # Whenever the server is no longer needed, stop it as usual. stoppedDeferred = port.stopListening() Another potential use is to inherit a listening descriptor from a parent process (for example, systemd or launchd), or to receive one over a UNIX domain socket. Some plans for extending this interface exist. See: - U{http://twistedmatrix.com/trac/ticket/6594}: AF_UNIX SOCK_DGRAM ports �fileDescriptor� addressFamilyr rh r r. rk c C r/ )a Add an existing listening I{SOCK_STREAM} socket to the reactor to monitor for new connections to accept and handle. @param fileDescriptor: A file descriptor associated with a socket which is already bound to an address and marked as listening. The socket must be set non-blocking. Any additional flags (for example, close-on-exec) must also be set by application code. Application code is responsible for closing the file descriptor, which may be done as soon as C{adoptStreamPort} returns. @param addressFamily: The address family (or I{domain}) of the socket. For example, L{socket.AF_INET6}. @param factory: A L{ServerFactory} instance to use to create new protocols to handle connections accepted via this socket. @return: An object providing L{IListeningPort}. @raise twisted.internet.error.UnsupportedAddressFamily: If the given address family is not supported by this reactor, or not supported with the given socket type. @raise twisted.internet.error.UnsupportedSocketType: If the given socket type is not supported by this reactor, or not supported with the given socket type. Nr* �r� r� rh r* r* r+ �adoptStreamPort� r1 z IReactorSocket.adoptStreamPortNc C r/ )a Add an existing connected I{SOCK_STREAM} socket to the reactor to monitor for data. Note that the given factory won't have its C{startFactory} and C{stopFactory} methods called, as there is no sensible time to call them in this situation. @param fileDescriptor: A file descriptor associated with a socket which is already connected. The socket must be set non-blocking. Any additional flags (for example, close-on-exec) must also be set by application code. Application code is responsible for closing the file descriptor, which may be done as soon as C{adoptStreamConnection} returns. @param addressFamily: The address family (or I{domain}) of the socket. For example, L{socket.AF_INET6}. @param factory: A L{ServerFactory} instance to use to create a new protocol to handle the connection via this socket. @raise UnsupportedAddressFamily: If the given address family is not supported by this reactor, or not supported with the given socket type. @raise UnsupportedSocketType: If the given socket type is not supported by this reactor, or not supported with the given socket type. Nr* r� r* r* r+ �adoptStreamConnection� r1 z$IReactorSocket.adoptStreamConnectionr~ r r c C r/ )a� Add an existing listening I{SOCK_DGRAM} socket to the reactor to monitor for read and write readiness. @param fileDescriptor: A file descriptor associated with a socket which is already bound to an address and marked as listening. The socket must be set non-blocking. Any additional flags (for example, close-on-exec) must also be set by application code. Application code is responsible for closing the file descriptor, which may be done as soon as C{adoptDatagramPort} returns. @param addressFamily: The address family or I{domain} of the socket. For example, L{socket.AF_INET6}. @param protocol: A L{DatagramProtocol} instance to connect to a UDP transport. @param maxPacketSize: The maximum packet size to accept. @return: An object providing L{IListeningPort}. @raise UnsupportedAddressFamily: If the given address family is not supported by this reactor, or not supported with the given socket type. @raise UnsupportedSocketType: If the given socket type is not supported by this reactor, or not supported with the given socket type. Nr* )r� r� r~ r r* r* r+ �adoptDatagramPort r1 z IReactorSocket.adoptDatagramPort)r& r' r( r) r= r� r� r� r* r* r* r+ r� � s> "��� � ��� � �����r� c @ sv e Zd Zdddeeef deeeef deee e f deeef de de d e d ee ee ef f d d fd d�Z dS )�IReactorProcess�processProtocol�IProcessProtocol� executable�args�env�path�uid�gid�usePTY�childFDsr. �IProcessTransportc C r/ )aJ Spawn a process, with a process protocol. Arguments given to this function that are listed as L{bytes} or L{unicode} may be encoded or decoded depending on the platform and the argument type given. On UNIX systems (Linux, FreeBSD, macOS) and Python 2 on Windows, L{unicode} arguments will be encoded down to L{bytes} using the encoding given by L{sys.getfilesystemencoding}, to be used with the "narrow" OS APIs. On Python 3 on Windows, L{bytes} arguments will be decoded up to L{unicode} using the encoding given by L{sys.getfilesystemencoding} (C{mbcs} before Python 3.6, C{utf8} thereafter) and given to Windows's native "wide" APIs. @param processProtocol: An object which will be notified of all events related to the created process. @param executable: the file name to spawn - the full path should be used. @param args: the command line arguments to pass to the process; a sequence of strings. The first string should be the executable's name. @param env: the environment variables to pass to the child process. The resulting behavior varies between platforms. If: - C{env} is not set: - On POSIX: pass an empty environment. - On Windows: pass L{os.environ}. - C{env} is L{None}: - On POSIX: pass L{os.environ}. - On Windows: pass L{os.environ}. - C{env} is a L{dict}: - On POSIX: pass the key/value pairs in C{env} as the complete environment. - On Windows: update L{os.environ} with the key/value pairs in the L{dict} before passing it. As a consequence of U{bug #1640 <http://twistedmatrix.com/trac/ticket/1640>}, passing keys with empty values in an effort to unset environment variables I{won't} unset them. @param path: the path to run the subprocess in - defaults to the current directory. @param uid: user ID to run the subprocess as. (Only available on POSIX systems.) @param gid: group ID to run the subprocess as. (Only available on POSIX systems.) @param usePTY: if true, run this process in a pseudo-terminal. optionally a tuple of C{(masterfd, slavefd, ttyname)}, in which case use those file descriptors. (Not available on all systems.) @param childFDs: A dictionary mapping file descriptors in the new child process to an integer or to the string 'r' or 'w'. If the value is an integer, it specifies a file descriptor in the parent process which will be mapped to a file descriptor (specified by the key) in the child process. This is useful for things like inetd and shell-like file redirection. If it is the string 'r', a pipe will be created and attached to the child at that file descriptor: the child will be able to write to that file descriptor and the parent will receive read notification via the L{IProcessProtocol.childDataReceived} callback. This is useful for the child's stdout and stderr. If it is the string 'w', similar setup to the previous case will occur, with the pipe being readable by the child instead of writeable. The parent process can write to that file descriptor using L{IProcessTransport.writeToChild}. This is useful for the child's stdin. If childFDs is not passed, the default behaviour is to use a mapping that opens the usual stdin/stdout/stderr pipes. @see: L{twisted.internet.protocol.ProcessProtocol} @return: An object which provides L{IProcessTransport}. @raise OSError: Raised with errno C{EAGAIN} or C{ENOMEM} if there are insufficient system resources to create a new process. Nr* ) r� r� r� r� r� r� r� r� r� r* r* r+ � spawnProcess, r1 z IReactorProcess.spawnProcessN) r& r' r( r �bytesr< r r r r r= r| r� r* r* r* r+ r� + s, � ��� ���� � �r� c @ sV e Zd ZdZdefdd�Zdededef ded edd f d d �Z de d fd d�Z dS )� IReactorTimez7 Time methods that a Reactor should implement. r. c C r/ )zg Get the current time in seconds. @return: A number-like object of some sort. Nr* r* r* r* r+ �seconds� r1 zIReactorTime.seconds�delay�callable.r� �kwargs� IDelayedCallc O r/ )a Call a function later. @param delay: the number of seconds to wait. @param callable: the callable object to call later. @param args: the arguments to call it with. @param kwargs: the keyword arguments to call it with. @return: An object which provides L{IDelayedCall} and can be used to cancel the scheduled call, by calling its C{cancel()} method. It also may be rescheduled by calling its C{delay()} or C{reset()} methods. Nr* )r� r� r� r� r* r* r+ � callLater� r1 zIReactorTime.callLaterc C r/ )zQ See L{twisted.internet.interfaces.IReactorTime.getDelayedCalls} Nr* r* r* r* r+ �getDelayedCalls� r1 z IReactorTime.getDelayedCallsN) r& r' r( r) rp r� r r r� r� r r� r* r* r* r+ r� � s � ��� �r� c @ sZ e Zd ZdZdefdd�Zddd�Zdeddfd d �Zd eddfd d �Zde fdd�Z dS )r� z� A scheduled call. There are probably other useful methods we can add to this interface; suggestions are welcome. r. c C r/ )zr Get time when delayed call will happen. @return: time in seconds since epoch (a float). Nr* r* r* r* r+ �getTime� r1 zIDelayedCall.getTimeNc C r/ )z� Cancel the scheduled call. @raises twisted.internet.error.AlreadyCalled: if the call has already happened. @raises twisted.internet.error.AlreadyCancelled: if the call has already been cancelled. Nr* r* r* r* r+ r? � r1 zIDelayedCall.cancel� secondsLaterc C r/ )aR Delay the scheduled call. @param secondsLater: how many seconds from its current firing time to delay @raises twisted.internet.error.AlreadyCalled: if the call has already happened. @raises twisted.internet.error.AlreadyCancelled: if the call has already been cancelled. Nr* )r� r* r* r+ r� � r1 zIDelayedCall.delay�secondsFromNowc C r/ )a� Reset the scheduled call's timer. @param secondsFromNow: how many seconds from now it should fire, equivalent to C{.cancel()} and then doing another C{reactor.callLater(secondsLater, ...)} @raises twisted.internet.error.AlreadyCalled: if the call has already happened. @raises twisted.internet.error.AlreadyCancelled: if the call has already been cancelled. Nr* )r� r* r* r+ �reset� r1 zIDelayedCall.resetc C r/ )zx @return: True if this call is still active, False if it has been called or cancelled. Nr* r* r* r* r+ �active� r1 zIDelayedCall.activer5 ) r& r' r( r) rp r� r? r� r� r| r� r* r* r* r+ r� � s r� c @ �2 e Zd ZdZdedef dededdfdd �ZdS ) �IReactorFromThreadsz� This interface is the set of thread-safe methods which may be invoked on the reactor from other threads. @since: 15.4 r� .r� r� r. Nc O r/ )a� Cause a function to be executed by the reactor thread. Use this method when you want to run a function in the reactor's thread from another thread. Calling L{callFromThread} should wake up the main thread (where L{reactor.run() <IReactorCore.run>} is executing) and run the given callable in that thread. If you're writing a multi-threaded application the C{callable} may need to be thread safe, but this method doesn't require it as such. If you want to call a function in the next mainloop iteration, but you're in the same thread, use L{callLater} with a delay of 0. Nr* �r� r� r� r* r* r+ �callFromThread� r1 z"IReactorFromThreads.callFromThread)r& r' r( r) r r r� r� r* r* r* r+ r� � � ����r� c @ r� ) �IReactorInThreadsz� This interface contains the methods exposed by a reactor which will let you run functions in another thread. @since: 15.4 r� .r� r� r. Nc O r/ )z} Run the given callable object in a separate thread, with the given arguments and keyword arguments. Nr* r� r* r* r+ � callInThread r1 z IReactorInThreads.callInThread)r& r' r( r) r r r� r� r* r* r* r+ r� r� r� c @ s, e Zd ZdZd dd�Zdeddfdd �ZdS ) �IReactorThreadsz} Dispatch methods to be run in threads. Internally, this should use a thread pool and dispatch methods to them. r. r" c C r/ )zx Return the threadpool used by L{IReactorInThreads.callInThread}. Create it first if necessary. Nr* r* r* r* r+ � getThreadPool r1 z IReactorThreads.getThreadPool�sizeNc C r/ )z� Suggest the size of the internal threadpool used to dispatch functions passed to L{IReactorInThreads.callInThread}. Nr* )r� r* r* r+ �suggestThreadPoolSize# r1 z%IReactorThreads.suggestThreadPoolSize)r. r" )r& r' r( r) r� r= r� r* r* r* r+ r� s r� c @ s� e Zd ZdZed�Zdedee ddfdd�Z d"d d �Z d"d d �Z d"dd�Z de dd fdd�Zdedd fdd�Zdedededef dededef dd �Zd edd fd d �Zdedef dededee fd d!�Zd S )#� IReactorCorez5 Core methods that a Reactor must implement. zjA C{bool} which is C{True} from I{during startup} to I{during shutdown} and C{False} the rest of the time.r7 r8 r. r9 c C r/ )zc Return a L{twisted.internet.defer.Deferred} that will resolve a hostname. Nr* r: r* r* r+ �resolve4 r1 zIReactorCore.resolveNc C r/ )z� Fire 'startup' System Events, move the reactor to the 'running' state, then run the main loop until it is stopped with C{stop()} or C{crash()}. Nr* r* r* r* r+ �run: r1 zIReactorCore.runc C r/ )z� Fire 'shutdown' System Events, which will move the reactor to the 'stopped' state and cause C{reactor.run()} to exit. Nr* r* r* r* r+ �stopA r1 zIReactorCore.stopc C r/ )as Stop the main loop *immediately*, without firing any system events. This is named as it is because this is an extremely "rude" thing to do; it is possible to lose data and put your system in an inconsistent state by calling this. However, it is necessary, as sometimes a system can become wedged in a pre-shutdown call. Nr* r* r* r* r+ �crashG r1 zIReactorCore.crashr� c C r/ )ap Run the main loop's I/O polling function for a period of time. This is most useful in applications where the UI is being drawn "as fast as possible", such as games. All pending L{IDelayedCall}s will be called. The reactor must have been started (via the C{run()} method) prior to any invocations of this method. It must also be stopped manually after the last call to this method (via the C{stop()} method). This method is not re-entrant: you must not call it recursively; in particular, you must not call it while the reactor is running. Nr* )r� r* r* r+ �iterateQ r1 zIReactorCore.iterate� eventTypec C r/ )z� Fire a system-wide event. System-wide events are things like 'startup', 'shutdown', and 'persist'. Nr* )r� r* r* r+ �fireSystemEvent` r1 z IReactorCore.fireSystemEvent�phaser� .r� r� c O r/ )a% Add a function to be called when a system event occurs. Each "system event" in Twisted, such as 'startup', 'shutdown', and 'persist', has 3 phases: 'before', 'during', and 'after' (in that order, of course). These events will be fired internally by the Reactor. An implementor of this interface must only implement those events described here. Callbacks registered for the "before" phase may return either None or a Deferred. The "during" phase will not execute until all of the Deferreds from the "before" phase have fired. Once the "during" phase is running, all of the remaining triggers must execute; their return values must be ignored. @param phase: a time to call the event -- either the string 'before', 'after', or 'during', describing when to call it relative to the event's execution. @param eventType: this is a string describing the type of event. @param callable: the object to call before shutdown. @param args: the arguments to call it with. @param kwargs: the keyword arguments to call it with. @return: an ID that can be used to remove this call with removeSystemEventTrigger. Nr* )r� r� r� r� r� r* r* r+ �addSystemEventTriggerh r1 z"IReactorCore.addSystemEventTrigger� triggerIDc C r/ )a� Removes a trigger added with addSystemEventTrigger. @param triggerID: a value returned from addSystemEventTrigger. @raise KeyError: If there is no system event trigger for the given C{triggerID}. @raise ValueError: If there is no system event trigger for the given C{triggerID}. @raise TypeError: If there is no system event trigger for the given C{triggerID}. Nr* )r� r* r* r+ �removeSystemEventTrigger� r1 z%IReactorCore.removeSystemEventTriggerc O r/ )a Call a function when the reactor is running. If the reactor has not started, the callable will be scheduled to run when it does start. Otherwise, the callable will be invoked immediately. @param callable: the callable object to call later. @param args: the arguments to call it with. @param kwargs: the keyword arguments to call it with. @return: None if the callable was invoked, otherwise a system event id for the scheduled call. Nr* r� r* r* r+ �callWhenRunning� r1 z IReactorCore.callWhenRunningr5 )r& r' r( r) r �runningr< r r= r� r� r� r� rp r� r� r r r� r� r� r r� r* r* r* r+ r� * sD � �� ��� �% ����r� c @ s" e Zd ZdZdedefdd�ZdS )�IReactorPluggableResolvera An L{IReactorPluggableResolver} is a reactor which can be customized with an L{IResolverSimple}. This is a fairly limited interface, that supports only IPv4; you should use L{IReactorPluggableNameResolver} instead. @see: L{IReactorPluggableNameResolver} �resolverr. c C r/ )z� Set the internal resolver to use to for name lookups. @param resolver: The new resolver to use. @return: The previously installed resolver. Nr* �r� r* r* r+ �installResolver� r1 z)IReactorPluggableResolver.installResolverN)r& r' r( r) r6 r� r* r* r* r+ r� � s r� c @ s* e Zd ZdZed�Zdedefdd�ZdS )� IReactorPluggableNameResolverzx An L{IReactorPluggableNameResolver} is a reactor whose name resolver can be set to a user-supplied object. zw Read-only attribute; the resolver installed with L{installResolver}. An L{IHostnameResolver}. r� r. c C r/ )z� Set the internal resolver to use for name lookups. @param resolver: The new resolver to use. @return: The previously installed resolver. Nr* r� r* r* r+ �installNameResolver� r1 z1IReactorPluggableNameResolver.installNameResolverN)r& r' r( r) r � nameResolverrF r� r* r* r* r+ r� � s �r� c @ �$ e Zd ZdZddd�Zddd�ZdS ) �IReactorDaemonizea� A reactor which provides hooks that need to be called before and after daemonization. Notes: - This interface SHOULD NOT be called by applications. - This interface should only be implemented by reactors as a workaround (in particular, it's implemented currently only by kqueue()). For details please see the comments on ticket #1918. r. Nc C r/ )z� Hook to be called immediately before daemonization. No reactor methods may be called until L{afterDaemonize} is called. Nr* r* r* r* r+ �beforeDaemonize� r1 z!IReactorDaemonize.beforeDaemonizec C r/ )z� Hook to be called immediately after daemonization. This may only be called after L{beforeDaemonize} had been called previously. Nr* r* r* r* r+ �afterDaemonize� r1 z IReactorDaemonize.afterDaemonizer5 )r& r' r( r) r� r� r* r* r* r+ r� � s r� c @ sr e Zd ZdZddd�Zdd d �Zdd d �Zddd�Zdee d fdd�Z ded fdd�Z ded fdd�Z dS )� IReactorFDSetz� Implement me to be able to use L{IFileDescriptor} type resources. This assumes that your main-loop uses UNIX-style numeric file descriptors (or at least similarly opaque IDs returned from a .fileno() method) �reader�IReadDescriptorr. Nc C r/ )a I add reader to the set of file descriptors to get read events for. @param reader: An L{IReadDescriptor} provider that will be checked for read events until it is removed from the reactor with L{removeReader}. Nr* �r� r* r* r+ � addReader� r1 zIReactorFDSet.addReader�writer�IWriteDescriptorc C r/ )a I add writer to the set of file descriptors to get write events for. @param writer: An L{IWriteDescriptor} provider that will be checked for write events until it is removed from the reactor with L{removeWriter}. Nr* �r� r* r* r+ � addWriter r1 zIReactorFDSet.addWriterc C r/ )zG Removes an object previously added with L{addReader}. Nr* r� r* r* r+ � removeReader r1 zIReactorFDSet.removeReaderc C r/ )zG Removes an object previously added with L{addWriter}. Nr* r� r* r* r+ � removeWriter r1 zIReactorFDSet.removeWriter)r� r� c C r/ )z� Remove all readers and writers. Should not remove reactor internal reactor connections (like a waker). @return: A list of L{IReadDescriptor} and L{IWriteDescriptor} providers which were removed. Nr* r* r* r* r+ � removeAll r1 zIReactorFDSet.removeAllc C r/ )z� Return the list of file descriptors currently monitored for input events by the reactor. @return: the list of file descriptors monitored for input events. Nr* r* r* r* r+ � getReaders r1 zIReactorFDSet.getReadersc C r/ )z� Return the list file descriptors currently monitored for output events by the reactor. @return: the list of file descriptors monitored for output events. Nr* r* r* r* r+ � getWriters' r1 zIReactorFDSet.getWriters)r� r� r. N)r� r� r. N) r& r' r( r) r� r� r� r� r r r� r� r� r* r* r* r+ r� � s r� c @ s: e Zd ZdZd dd�Zded fdd�Zdefd d �ZdS ) rk z A listening port. r. Nc C r/ )a Start listening on this port. @raise CannotListenError: If it cannot listen on this port (e.g., it is a TCP port and it cannot bind to the required port number). Nr* r* r* r* r+ �startListening5 r1 z IListeningPort.startListeningr c C r/ )z� Stop listening on this port. If it does not complete immediately, will return Deferred that fires upon completion. Nr* r* r* r* r+ � stopListening> r1 z IListeningPort.stopListeningc C r/ )zj Get the host that this port is listening for. @return: An L{IAddress} provider. Nr* r* r* r* r+ �getHostF r1 zIListeningPort.getHostr5 ) r& r' r( r) r� r r� r$ r� r* r* r* r+ rk 0 s rk c @ � e Zd ZdZdefdd�ZdS )�ILoggingContextz^ Give context information that will be used to log events generated by this item. r. c C r/ )zQ @return: Prefix used during log formatting to indicate context. Nr* r* r* r* r+ � logPrefixT r1 zILoggingContext.logPrefixN)r& r' r( r) r< r� r* r* r* r+ r� N s r� c @ s0 e Zd ZdZdefdd�Zdeddfdd�ZdS ) �IFileDescriptorzI An interface representing a UNIX-style numeric file descriptor. r. c C r/ )aY @return: The platform-specified representation of a file descriptor number. Or C{-1} if the descriptor no longer has a valid file descriptor number associated with it. As long as the descriptor is valid, calls to this method on a particular instance must return the same value. Nr* r* r* r* r+ �fileno_ r1 zIFileDescriptor.fileno�reasonNc C r/ )a� Called when the connection was lost. This is called when the connection on a selectable object has been lost. It will be called whether the connection was closed explicitly, an exception occurred in an event handler, or the other end of the connection closed it first. See also L{IHalfCloseableDescriptor} if your descriptor wants to be notified separately of the two halves of the connection being closed. @param reason: A failure instance indicating the reason why the connection was lost. L{error.ConnectionLost} and L{error.ConnectionDone} are of special note, but the failure may be of other classes as well. Nr* �r� r* r* r+ �connectionLosth r1 z IFileDescriptor.connectionLost)r& r' r( r) r� r� r r� r* r* r* r+ r� Z s r� c @ �" e Zd ZdZdee fdd�ZdS )r� zz An L{IFileDescriptor} that can read. This interface is generally used in conjunction with L{IReactorFDSet}. r. c C r/ )z� Some data is available for reading on your descriptor. @return: If an error is encountered which causes the descriptor to no longer be valid, a L{Failure} should be returned. Otherwise, L{None}. Nr* r* r* r* r+ �doRead� r1 zIReadDescriptor.doReadN)r& r' r( r) r r r� r* r* r* r+ r� { � r� c @ r� )r� z{ An L{IFileDescriptor} that can write. This interface is generally used in conjunction with L{IReactorFDSet}. r. c C r/ )z� Some data can be written to your descriptor. @return: If an error is encountered which causes the descriptor to no longer be valid, a L{Failure} should be returned. Otherwise, L{None}. Nr* r* r* r* r+ �doWrite� r1 zIWriteDescriptor.doWriteN)r& r' r( r) r r r� r* r* r* r+ r� � r� r� c @ r# )�IReadWriteDescriptorz= An L{IFileDescriptor} that can both read and write. Nr% r* r* r* r+ r� � r, r� c @ s4 e Zd ZdZdeddfdd�Zdeddfdd�ZdS ) �IHalfCloseableDescriptorz/ A descriptor that can be half-closed. r� r. Nc C r/ )z6 Indicates write connection was lost. Nr* r� r* r* r+ �writeConnectionLost� r1 z,IHalfCloseableDescriptor.writeConnectionLostc C r/ )z5 Indicates read connection was lost. Nr* r� r* r* r+ �readConnectionLost� r1 z+IHalfCloseableDescriptor.readConnectionLost)r& r' r( r) r r� r� r* r* r* r+ r� � s r� c @ r� )� ISystemHandlez? An object that wraps a networking OS-specific handle. r. c C r/ )ab Return a system- and reactor-specific handle. This might be a socket.socket() object, or some other type of object, depending on which reactor is being used. Use and manipulate at your own risk. This might be used in cases where you want to set specific options not exposed by the Twisted APIs. Nr* r* r* r* r+ � getHandle� r1 zISystemHandle.getHandleN)r& r' r( r) r� r� r* r* r* r+ r� � � r� c @ sB e Zd ZdZdddeddfdd�Zdd d �Zd eddfd d �ZdS )� IConsumerz3 A consumer consumes data from a producer. �producer� IProducer� streamingr. Nc C r/ )a� Register to receive data from a producer. This sets self to be a consumer for a producer. When this object runs out of data (as when a send(2) call on a socket succeeds in moving the last data from a userspace buffer into a kernelspace buffer), it will ask the producer to resumeProducing(). For L{IPullProducer} providers, C{resumeProducing} will be called once each time data is required. For L{IPushProducer} providers, C{pauseProducing} will be called whenever the write buffer fills up and C{resumeProducing} will only be called when it empties. The consumer will only call C{resumeProducing} to balance a previous C{pauseProducing} call; the producer is assumed to start in an un-paused state. @param streaming: C{True} if C{producer} provides L{IPushProducer}, C{False} if C{producer} provides L{IPullProducer}. @raise RuntimeError: If a producer is already registered. Nr* )r� r� r* r* r+ �registerProducer� r1 zIConsumer.registerProducerc C r/ )zM Stop consuming data from a producer, without disconnecting. Nr* r* r* r* r+ �unregisterProducer� r1 z IConsumer.unregisterProducer�datac C r/ )a@ The producer will write data by calling this method. The implementation must be non-blocking and perform whatever buffering is necessary. If the producer has provided enough data for now and it is a L{IPushProducer}, the consumer may call its C{pauseProducing} method. Nr* �r� r* r* r+ �write� r1 zIConsumer.writer5 ) r& r' r( r) r| r� r� r� r r* r* r* r+ r� � s r� c @ � e Zd ZdZddd�ZdS )r� z� A producer produces data for a consumer. Typically producing is done by calling the C{write} method of a class implementing L{IConsumer}. r. Nc C r/ )z� Stop producing data. This tells a producer that its consumer has died, so it must stop producing data for good. Nr* r* r* r* r+ � stopProducing� r1 zIProducer.stopProducingr5 )r& r' r( r) r r* r* r* r+ r� � s r� c @ r� ) � IPushProducera^ A push producer, also known as a streaming producer is expected to produce (write to this consumer) data on a continuous basis, unless it has been paused. A paused push producer will resume producing after its C{resumeProducing()} method is called. For a push producer which is not pauseable, these functions may be noops. r. Nc C r/ )z� Pause producing data. Tells a producer that it has produced too much data to process for the time being, and to stop until C{resumeProducing()} is called. Nr* r* r* r* r+ �pauseProducing r1 z IPushProducer.pauseProducingc C r/ )z� Resume producing data. This tells a producer to re-add itself to the main loop and produce more data for its consumer. Nr* r* r* r* r+ �resumeProducing r1 z IPushProducer.resumeProducingr5 )r& r' r( r) r r r* r* r* r+ r s r c @ r )� IPullProducerz� A pull producer, also known as a non-streaming producer, is expected to produce data each time L{resumeProducing()} is called. r. Nc C r/ )a� Produce data for the consumer a single time. This tells a producer to produce data for the consumer once (not repeatedly, once only). Typically this will be done by calling the consumer's C{write} method a single time with produced data. The producer should produce data before returning from C{resumeProducing()}, that is, it should not schedule a deferred write. Nr* r* r* r* r+ r # r1 z IPullProducer.resumeProducingr5 )r& r' r( r) r r* r* r* r+ r s r c @ sD e Zd Zdeddfdd�Zdeddfdd�Zdd d �Zdd d�ZdS )� IProtocolr� r. Nc C r/ )a2 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. Please keep in mind that you will probably need to buffer some data as partial (or multiple) protocol messages may be received! We recommend that unit tests for protocols call through to this method with differing chunk sizes, down to one byte at a time. @param data: bytes of indeterminate length Nr* r� r* r* r+ � dataReceived1 r1 zIProtocol.dataReceivedr� c C r/ )as Called when the connection is shut down. Clear any circular references here, and any external references to this Protocol. The connection has been closed. The C{reason} Failure wraps a L{twisted.internet.error.ConnectionDone} or L{twisted.internet.error.ConnectionLost} instance (or a subclass of one of those). Nr* r� r* r* r+ r� A r1 zIProtocol.connectionLost� transport� ITransportc C r/ )z@ Make a connection to a transport and a server. Nr* )r r* r* r+ �makeConnectionL r1 zIProtocol.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+ �connectionMadeQ r1 zIProtocol.connectionMade)r r r. Nr5 ) r& r' r( r� r r r� r r r* r* r* r+ r 0 s r c @ sf e Zd ZdZddd�Zded eddfd d �Zdeddfd d �Zde ddfdd�Z de ddfdd�Z dS )r� z7 Interface for process-related event handlers. �processr� r. Nc C r/ )z� Called when the process has been created. @param process: An object representing the process which has been created and associated with this protocol. Nr* )r r* r* r+ r c r1 z IProcessProtocol.makeConnection�childFDr� c C r/ )z� Called when data arrives from the child process. @param childFD: The file descriptor from which the data was received. @param data: The data read from the child's file descriptor. Nr* �r r� r* r* r+ �childDataReceivedk r1 z"IProcessProtocol.childDataReceivedc C r/ )z� Called when a file descriptor associated with the child process is closed. @param childFD: The file descriptor which was closed. Nr* )r r* r* r+ �childConnectionLostt r1 z$IProcessProtocol.childConnectionLostr� c C r/ )aI Called when the child process exits. @param reason: A failure giving the reason the child process terminated. The type of exception for this failure is either L{twisted.internet.error.ProcessDone} or L{twisted.internet.error.ProcessTerminated}. @since: 8.2 Nr* r� r* r* r+ � processExited| r1 z IProcessProtocol.processExitedc C r/ )ay Called when the child process exits and all file descriptors associated with it have been closed. @param reason: A failure giving the reason the child process terminated. The type of exception for this failure is either L{twisted.internet.error.ProcessDone} or L{twisted.internet.error.ProcessTerminated}. Nr* r� r* r* r+ � processEnded� r1 z IProcessProtocol.processEnded)r r� r. N) r& r' r( r) r r= r� r r r r r r* r* r* r+ r� ^ s r� c @ r� ) �IHalfCloseableProtocolaA Implemented to indicate they want notification of half-closes. TCP supports the notion of half-closing the connection, e.g. closing the write side but still not stopping reading. A protocol that implements this interface will be notified of such events, instead of having connectionLost called. r. Nc C r/ )a= Notification of the read connection being closed. This indicates peer did half-close of write side. It is now the responsibility of the this protocol to call loseConnection(). In addition, the protocol MUST make sure a reference to it still exists (i.e. by doing a callLater with one of its methods, etc.) as the reactor will only have a reference to it if it is writing. If the protocol does not do so, it might get garbage collected without the connectionLost method ever being called. Nr* r* r* r* r+ r� � r1 z)IHalfCloseableProtocol.readConnectionLostc C r/ )z� Notification of the write connection being closed. This will never be called for TCP connections as TCP does not support notification of this type of half-close. Nr* r* r* r* r+ r� � r1 z*IHalfCloseableProtocol.writeConnectionLostr5 )r& r' r( r) r� r� r* r* r* r+ r � s r c @ r )�IHandshakeListeneraC An interface implemented by a L{IProtocol} to indicate that it would like to be notified when TLS handshakes complete when run over a TLS-based transport. This interface is only guaranteed to be called when run over a TLS-based transport: non TLS-based transports will not respect this interface. r. Nc C r/ )ax Notification of the TLS handshake being completed. This notification fires when OpenSSL has completed the TLS handshake. At this point the TLS connection is established, and the protocol can interrogate its transport (usually an L{ISSLTransport}) for details of the TLS connection. This notification *also* fires whenever the TLS session is renegotiated. As a result, protocols that have certain minimum security requirements should implement this interface to ensure that they are able to re-evaluate the security of the TLS session if it changes. Nr* r* r* r* r+ �handshakeCompleted� r1 z%IHandshakeListener.handshakeCompletedr5 )r& r' r( r) r r* r* r* r+ r � � r c @ �" e Zd ZdZdeddfdd�ZdS )�IFileDescriptorReceiverz� Protocols may implement L{IFileDescriptorReceiver} to receive file descriptors sent to them. This is useful in conjunction with L{IUNIXTransport}, which allows file descriptors to be sent between processes on a single host. � descriptorr. Nc C r/ )z� Called when a file descriptor is received over the connection. @param descriptor: The descriptor which was received. @return: L{None} Nr* �r r* r* r+ �fileDescriptorReceived� r1 z.IFileDescriptorReceiver.fileDescriptorReceived)r& r' r( r) r= r r* r* r* r+ r � � r c @ s: e Zd ZdZdedee fdd�Zd dd�Zd d d �Z dS ) �IProtocolFactoryz+ Interface for protocol factories. �addrr. c C r/ )a Called when a connection has been established to addr. If None is returned, the connection is assumed to have been refused, and the Port will close the connection. @param addr: The address of the newly-established connection @return: None if the connection was refused, otherwise an object providing L{IProtocol}. Nr* �r r* r* r+ � buildProtocol� r1 z IProtocolFactory.buildProtocolNc C r/ )zM Called every time this is connected to a Port or Connector. Nr* r* r* r* r+ �doStart� r1 zIProtocolFactory.doStartc C r/ )zQ Called every time this is unconnected from a Port or Connector. Nr* r* r* r* r+ �doStop� r1 zIProtocolFactory.doStopr5 ) r& r' r( r) r$ r r r! r" r# r* r* r* r+ r � s r c @ s^ e Zd ZdZdeddfdd�Zdee ddfdd�Zdd d �Zde fd d �Z de fd d�Z dS )r a� I am a transport for bytes. I represent (and wrap) the physical connection and synchronicity of the framework which is talking to the network. I make no representations about whether calls to me will happen immediately or require returning to a control loop, or whether they will happen in the same or another thread. Consider methods of this class (aside from getPeer) to be 'thrown over the wall', to happen at some indeterminate time. r� r. Nc C r/ )aH Write some data to the physical connection, in sequence, in a non-blocking fashion. If possible, make sure that it is all written. No data will ever be lost, although (obviously) the connection may be closed before it all gets through. @param data: The data to write. Nr* r� r* r* r+ r r1 zITransport.writec C r/ )a Write an iterable of byte strings to the physical connection. If possible, make sure that all of the data is written to the socket at once, without first copying it all into a single byte string. @param data: The data to write. Nr* r� r* r* r+ � writeSequence r1 zITransport.writeSequencec C r/ )z� Close my connection, after writing all pending data. Note that if there is a registered producer on a transport it will not be closed until the producer has been unregistered. Nr* r* r* r* r+ �loseConnection# r1 zITransport.loseConnectionc C r/ )ah Get the remote address of this connection. Treat this method with caution. It is the unfortunate result of the CGI and Jabber standards, but should not be considered reliable for the usual host of reasons; port forwarding, proxying, firewalls, IP masquerading, etc. @return: An L{IAddress} provider. Nr* r* r* r* r+ �getPeer+ r1 zITransport.getPeerc C r/ )z� Similar to getPeer, but returns an address describing this side of the connection. @return: An L{IAddress} provider. Nr* r* r* r* r+ r� 7 r1 zITransport.getHostr5 ) r& r' r( r) r� r r r$ r% r$ r& r� r* r* r* r+ r � s r c @ s� e Zd ZdZddd�Zddd�Zdefdd �Zd eddfd d �Zdefd d�Z d eddfdd�Z de d fdd�Z de d fdd�Z dS )� ITCPTransportz A TCP based transport. r. Nc C r/ )aq Half-close the write side of a TCP connection. If the protocol instance this is attached to provides IHalfCloseableProtocol, it will get notified when the operation is done. When closing write connection, as with loseConnection this will only happen when buffer has emptied and there is no registered producer. Nr* r* r* r* r+ �loseWriteConnectionE r1 z!ITCPTransport.loseWriteConnectionc C r/ )z� Close the connection abruptly. Discards any buffered data, stops any registered producer, and, if possible, notifies the other end of the unclean closure. @since: 11.1 Nr* r* r* r* r+ �abortConnectionP r1 z ITCPTransport.abortConnectionc C r/ )z6 Return if C{TCP_NODELAY} is enabled. Nr* r* r* r* r+ � getTcpNoDelay[ r1 zITCPTransport.getTcpNoDelay�enabledc C r/ )z� Enable/disable C{TCP_NODELAY}. Enabling C{TCP_NODELAY} turns off Nagle's algorithm. Small packets are sent sooner, possibly at the expense of overall throughput. Nr* �r+ r* r* r+ � setTcpNoDelay` r1 zITCPTransport.setTcpNoDelayc C r/ )z7 Return if C{SO_KEEPALIVE} is enabled. Nr* r* r* r* r+ �getTcpKeepAliveh r1 z ITCPTransport.getTcpKeepAlivec C r/ )a Enable/disable C{SO_KEEPALIVE}. Enabling C{SO_KEEPALIVE} sends packets periodically when the connection is otherwise idle, usually once every two hours. They are intended to allow detection of lost peers in a non-infinite amount of time. Nr* r, r* r* r+ �setTcpKeepAlivem r1 z ITCPTransport.setTcpKeepAlive�r r c C r/ �z; Returns L{IPv4Address} or L{IPv6Address}. Nr* r* r* r* r+ r� v r1 zITCPTransport.getHostc C r/ r1 r* r* r* r* r+ r& { r1 zITCPTransport.getPeerr5 )r& r' r( r) r( r) r| r* r- r. r/ r r� r& r* r* r* r+ r' @ s r' c @ r )�IUNIXTransportz@ Transport for stream-oriented unix domain connections. r r. Nc C r/ )ax Send a duplicate of this (file, socket, pipe, etc) descriptor to the other end of this connection. The send is non-blocking and will be queued if it cannot be performed immediately. The send will be processed in order with respect to other C{sendFileDescriptor} calls on this transport, but not necessarily with respect to C{write} calls on this transport. The send can only be processed if there are also bytes in the normal connection-oriented send buffer (ie, you must call C{write} at least as many times as you call C{sendFileDescriptor}). @param descriptor: An C{int} giving a valid file descriptor in this process. Note that a I{file descriptor} may actually refer to a socket, a pipe, or anything else POSIX tries to treat in the same way as a file. Nr* r r* r* r+ �sendFileDescriptor� r1 z!IUNIXTransport.sendFileDescriptor)r& r' r( r) r= r3 r* r* r* r+ r2 � s r2 c @ �" e Zd ZdZ d dd�ZdS ) � IOpenSSLServerConnectionCreatoraX A provider of L{IOpenSSLServerConnectionCreator} can create L{OpenSSL.SSL.Connection} objects for TLS servers. @see: L{twisted.internet.ssl} @note: Creating OpenSSL connection objects is subtle, error-prone, and security-critical. Before implementing this interface yourself, consider using L{twisted.internet.ssl.CertificateOptions} as your C{contextFactory}. (For historical reasons, that class does not actually I{implement} this interface; nevertheless it is usable in all Twisted APIs which require a provider of this interface.) � tlsProtocolr r. �OpenSSLConnectionc C r/ )z� Create a connection for the given server protocol. @return: an OpenSSL connection object configured appropriately for the given Twisted protocol. Nr* �r6 r* r* r+ �serverConnectionForTLS� r1 z6IOpenSSLServerConnectionCreator.serverConnectionForTLSN�r6 r r. r7 )r& r' r( r) r9 r* r* r* r+ r5 � s ��r5 c @ r4 ) � IOpenSSLClientConnectionCreatora� A provider of L{IOpenSSLClientConnectionCreator} can create L{OpenSSL.SSL.Connection} objects for TLS clients. @see: L{twisted.internet.ssl} @note: Creating OpenSSL connection objects is subtle, error-prone, and security-critical. Before implementing this interface yourself, consider using L{twisted.internet.ssl.optionsForClientTLS} as your C{contextFactory}. r6 r r. r7 c C r/ )z� Create a connection for the given client protocol. @param tlsProtocol: the client protocol making the request. @return: an OpenSSL connection object configured appropriately for the given Twisted protocol. Nr* r8 r* r* r+ �clientConnectionForTLS� r1 z6IOpenSSLClientConnectionCreator.clientConnectionForTLSNr: )r& r' r( r) r< r* r* r* r+ r; � s ��r; c @ r� )�IProtocolNegotiationFactoryaL A provider of L{IProtocolNegotiationFactory} can provide information about the various protocols that the factory can create implementations of. This can be used, for example, to provide protocol names for Next Protocol Negotiation and Application Layer Protocol Negotiation. @see: L{twisted.internet.ssl} r. c C r/ )z� Returns a list of protocols that can be spoken by the connection factory in the form of ALPN tokens, as laid out in the IANA registry for ALPN tokens. @return: a list of ALPN tokens in order of preference. Nr* r* r* r* r+ �acceptableProtocols� r1 z/IProtocolNegotiationFactory.acceptableProtocolsN)r& r' r( r) r r� r> r* r* r* r+ r= � s r= c @ s e Zd ZdZddd�ZdS )rt a5 A provider of L{IOpenSSLContextFactory} is capable of generating L{OpenSSL.SSL.Context} classes suitable for configuring TLS on a connection. A provider will store enough state to be able to generate these contexts as needed for individual connections. @see: L{twisted.internet.ssl} r. �OpenSSLContextc C r/ )z� Returns a TLS context object, suitable for securing a TLS connection. This context object will be appropriately customized for the connection based on the state in this object. @return: A TLS context object. Nr* r* r* r* r+ � getContext� r1 z!IOpenSSLContextFactory.getContextN)r. r? )r& r' r( r) r@ r* r* r* r+ rt � r rt c @ s* e Zd ZdZdeeef ddfdd�ZdS )� ITLSTransportz� A TCP transport that supports switching to TLS midstream. Once TLS mode is started the transport will implement L{ISSLTransport}. rr r. Nc C r/ )a� Initiate TLS negotiation. @param contextFactory: An object which creates appropriately configured TLS connections. For clients, use L{twisted.internet.ssl.optionsForClientTLS}; for servers, use L{twisted.internet.ssl.CertificateOptions}. @type contextFactory: L{IOpenSSLClientConnectionCreator} or L{IOpenSSLServerConnectionCreator}, depending on whether this L{ITLSTransport} is a server or not. If the appropriate interface is not provided by the value given for C{contextFactory}, it must be an implementor of L{IOpenSSLContextFactory}. Nr* )rr r* r* r+ �startTLS� r1 zITLSTransport.startTLS)r& r' r( r) r r; r5 rB r* r* r* r+ rA � s ���rA c @ r� )� ISSLTransportz$ A SSL/TLS based transport. r. c C r/ )zD Return an object with the peer's certificate info. Nr* r* r* r* r+ �getPeerCertificate r1 z ISSLTransport.getPeerCertificateN)r& r' r( r) r� rD r* r* r* r+ rC r� rC c @ � e Zd ZdZed�ZdS )� INegotiatedz� A TLS based transport that supports using ALPN/NPN to negotiate the protocol to be used inside the encrypted tunnel. aC The protocol selected to be spoken using ALPN/NPN. The result from ALPN is preferred to the result from NPN if both were used. If the remote peer does not support ALPN or NPN, or neither NPN or ALPN are available on this machine, will be L{None}. Otherwise, will be the name of the selected protocol as C{bytes}. Note that until the handshake has completed this property may incorrectly return L{None}: wait until data has been received before trusting it (see https://twistedmatrix.com/trac/ticket/6024). N)r& r' r( r) r �negotiatedProtocolr* r* r* r+ rF s �rF c @ rE )�ICipherz A TLS cipher. z5The fully qualified name of the cipher in L{unicode}.N)r& r' r( r) r �fullNamer* r* r* r+ rH 2 s rH c @ s* e Zd ZdZdee dee fdd�ZdS )�IAcceptableCiphersz9 A list of acceptable ciphers for a TLS context. �availableCiphersr. c C r/ )a� Choose which ciphers to allow to be negotiated on a TLS connection. @param availableCiphers: A L{tuple} of L{ICipher} which gives the names of all ciphers supported by the TLS implementation in use. @return: A L{tuple} of L{ICipher} which represents the ciphers which may be negotiated on the TLS connection. The result is ordered by preference with more preferred ciphers appearing earlier. Nr* )rK r* r* r+ � selectCiphers? r1 z IAcceptableCiphers.selectCiphersN)r& r' r( r) r rH rL r* r* r* r+ rJ : s rJ c @ s� e Zd ZdZed�Zddd�Zddd�Zdd d �Zd e ddfd d �Z de de ddfdd�Z ddd�Z deee f ddfdd�ZdS )r� z A process transport. z�From before L{IProcessProtocol.makeConnection} is called to before L{IProcessProtocol.processEnded} is called, C{pid} is an L{int} giving the platform process ID of this process. C{pid} is L{None} at all other times.r. Nc C r/ )zB Close stdin after all data has been written out. Nr* r* r* r* r+ � closeStdinY r1 z IProcessTransport.closeStdinc C r/ )z Close stdout. Nr* r* r* r* r+ � closeStdout^ r1 z IProcessTransport.closeStdoutc C r/ )z Close stderr. Nr* r* r* r* r+ � closeStderrc r1 z IProcessTransport.closeStderrr c C r/ )z� Close a file descriptor which is connected to the child process, identified by its FD in the child process. Nr* r r* r* r+ � closeChildFDh r1 z IProcessTransport.closeChildFDr r� c C r/ )a� Similar to L{ITransport.write} but also allows the file descriptor in the child process which will receive the bytes to be specified. @param childFD: The file descriptor to which to write. @param data: The bytes to write. @raise KeyError: If C{childFD} is not a file descriptor that was mapped in the child when L{IReactorProcess.spawnProcess} was used to create it. Nr* r r* r* r+ � writeToChildn r1 z IProcessTransport.writeToChildc C r/ )z1 Close stdin, stderr and stdout. Nr* r* r* r* r+ r% { r1 z IProcessTransport.loseConnection�signalIDc C r/ )a* Send a signal to the process. @param signalID: can be - one of C{"KILL"}, C{"TERM"}, or C{"INT"}. These will be implemented in a cross-platform manner, and so should be used if possible. - an integer, where it represents a POSIX signal ID. @raise twisted.internet.error.ProcessExitedAlready: If the process has already exited. @raise OSError: If the C{os.kill} call fails with an errno different from C{ESRCH}. Nr* )rR r* r* r+ � signalProcess� r1 z IProcessTransport.signalProcessr5 )r& r' r( r) r �pidrM rN rO r= rP r� rQ r% r r< rS r* r* r* r+ r� M s � r� c @ sF e Zd ZdZdedefdd�Zdeddfdd �Zdeddfd d �ZdS ) �IServiceCollectionzF An object which provides access to a collection of services. � serviceNamer. c C r/ )z� Retrieve the named service from this application. Raise a C{KeyError} if there is no such service name. Nr* )rV r* r* r+ �getServiceNamed� r1 z"IServiceCollection.getServiceNamed�serviceNc C r/ )z3 Add a service to this collection. Nr* �rX r* r* r+ � addService� r1 z IServiceCollection.addServicec C r/ )z8 Remove a service from this collection. Nr* rY r* r* r+ � removeService� r1 z IServiceCollection.removeService) r& r' r( r) r< r� rW rZ r[ r* r* r* r+ rU � s rU c @ s� e Zd ZdZdedeeeef ddfdd�Z ded eddfd d �Z de d fd d�Z ded fdd�Z deddfdd�Zdefdd�ZdS )� IUDPTransportz. Transport for UDP DatagramProtocols. �packetr r. Nc C r/ )a` Write packet to given address. @param addr: a tuple of (ip, port). For connected transports must be the address the transport is connected to, or None. In non-connected mode this is mandatory. @raise twisted.internet.error.MessageLengthError: C{packet} was too long. Nr* �r] r r* r* r+ r � r1 zIUDPTransport.writerm rg c C r/ )a� Connect the transport to an address. This changes it to connected mode. Datagrams can only be sent to this address, and will only be received from this address. In addition the protocol's connectionRefused method might get called if destination is not receiving datagrams. @param host: an IP address, not a domain name ('127.0.0.1', not 'localhost') @param port: port to connect to. Nr* )rm rg r* r* r+ r3 � r1 zIUDPTransport.connectr0 c C r/ )zk Get this port's host address. @return: an address describing the listening port. Nr* r* r* r* r+ r� � r1 zIUDPTransport.getHostr c C r/ )z� Stop listening on this port. If it does not complete immediately, will return L{Deferred} that fires upon completion. Nr* r* r* r* r+ r� � r1 zIUDPTransport.stopListeningr+ c C r/ )zo Set whether this port may broadcast. @param enabled: Whether the port may broadcast. Nr* r, r* r* r+ �setBroadcastAllowed� r1 z!IUDPTransport.setBroadcastAllowedc C r/ )z{ Checks if broadcast is currently allowed on this port. @return: Whether this port may broadcast. Nr* r* r* r* r+ �getBroadcastAllowed� r1 z!IUDPTransport.getBroadcastAllowed)r& r' r( r) r� r r r< r= r r3 r r� r� r| r_ r` r* r* r* r+ r\ � s " r\ c @ s0 e Zd ZdZdededdfdd�Zd d d �ZdS ) �IUNIXDatagramTransportz, Transport for UDP PacketProtocols. r] r r. Nc C r/ )z0 Write packet to given address. Nr* r^ r* r* r+ r � r1 z IUNIXDatagramTransport.writer c C r/ �z) Returns L{UNIXAddress}. Nr* r* r* r* r+ r� � r1 z IUNIXDatagramTransport.getHost�r. r )r& r' r( r) r� r< r r� r* r* r* r+ ra � s ra c @ s6 e Zd ZdZdeddfdd�Zd dd �Zd d d �ZdS ) � IUNIXDatagramConnectedTransportz5 Transport for UDP ConnectedPacketProtocols. r] r. Nc C r/ )z> Write packet to address we are connected to. Nr* )r] r* r* r+ r � r1 z%IUNIXDatagramConnectedTransport.writer c C r/ rb r* r* r* r* r+ r� r1 z'IUNIXDatagramConnectedTransport.getHostc C r/ rb r* r* r* r* r+ r& r1 z'IUNIXDatagramConnectedTransport.getPeerrc )r& r' r( r) r� r r� r& r* r* r* r+ rd � s rd c @ s� e Zd ZdZdefdd�Zdeddfdd�Zdefd d �Zd eddfd d �Z de fdd�Z de ddfdd�Z dededdfdd�Z dededdfdd�ZdS )�IMulticastTransportz5 Additional functionality for multicast UDP. r. c C r/ )zA Return interface of outgoing multicast packets. Nr* r* r* r* r+ �getOutgoingInterface r1 z(IMulticastTransport.getOutgoingInterfacer Nc C r/ )ze Set interface for outgoing multicast packets. Returns Deferred of success. Nr* r r* r* r+ �setOutgoingInterface r1 z(IMulticastTransport.setOutgoingInterfacec C r/ )z5 Return if loopback mode is enabled. Nr* r* r* r* r+ �getLoopbackMode r1 z#IMulticastTransport.getLoopbackModery c C r/ )z2 Set if loopback mode is enabled. Nr* )ry r* r* r+ �setLoopbackMode! r1 z#IMulticastTransport.setLoopbackModec C r/ )z9 Get time to live for multicast packets. Nr* r* r* r* r+ �getTTL& r1 zIMulticastTransport.getTTL�ttlc C r/ )z8 Set time to live on multicast packets. Nr* )rk r* r* r+ �setTTL+ r1 zIMulticastTransport.setTTLrj zDeferred[None]c C r/ )z� Join a multicast group. Returns L{Deferred} of success or failure. If an error occurs, the returned L{Deferred} will fail with L{error.MulticastJoinError}. Nr* �r rj r* r* r+ � joinGroup0 r1 z IMulticastTransport.joinGroupc C r/ )zG Leave multicast group, return L{Deferred} of success. Nr* rm r* r* r+ � leaveGroup8 r1 z IMulticastTransport.leaveGroup)r& r' r( r) r< rf rg r| rh ri r= rj rl rn ro r* r* r* r+ re s re c @ �" e Zd ZdZdeddfdd�ZdS )�IStreamClientEndpointz� A stream client endpoint is a place that L{ClientFactory} can connect to. For example, a remote TCP host/port pair would be a TCP client endpoint. @since: 10.1 �protocolFactoryr. zDeferred[IProtocol]c C r/ )a� Connect the C{protocolFactory} to the location specified by this L{IStreamClientEndpoint} provider. @param protocolFactory: A provider of L{IProtocolFactory} @return: A L{Deferred} that results in an L{IProtocol} upon successful connection otherwise a L{Failure} wrapping L{ConnectError} or L{NoProtocol <twisted.internet.error.NoProtocol>}. Nr* �rr r* r* r+ r3 F r1 z IStreamClientEndpoint.connectN)r& r' r( r) r r3 r* r* r* r+ rq > r rq c @ rp )�IStreamServerEndpointzz A stream server endpoint is a place that a L{Factory} can listen for incoming connections. @since: 10.1 rr r. zDeferred[IListeningPort]c C r/ )a, Listen with C{protocolFactory} at the location specified by this L{IStreamServerEndpoint} provider. @param protocolFactory: A provider of L{IProtocolFactory} @return: A L{Deferred} that results in an L{IListeningPort} or an L{CannotListenError} Nr* rs r* r* r+ �listen[ r1 z IStreamServerEndpoint.listenN)r& r' r( r) r ru r* r* r* r+ rt S r rt c @ �2 e Zd ZdZed�Zdedededefdd�Z d S ) �!IStreamServerEndpointStringParserz� An L{IStreamServerEndpointStringParser} is like an L{IStreamClientEndpointStringParserWithReactor}, except for L{IStreamServerEndpoint}s instead of clients. It integrates with L{endpoints.serverFromString} in much the same way. a A C{str}, the description prefix to respond to. For example, an L{IStreamServerEndpointStringParser} plugin which had C{"foo"} for its C{prefix} attribute would be called for endpoint descriptions like C{"foo:bar:baz"} or C{"foo:"}. �reactorr� r� r. c O r/ )z� Parse a stream server endpoint from a reactor and string-only arguments and keyword arguments. @see: L{IStreamClientEndpointStringParserWithReactor.parseStreamClient} @return: a stream server endpoint Nr* �rx r� r� r* r* r+ �parseStreamServerx r1 z3IStreamServerEndpointStringParser.parseStreamServerN) r& r' r( r) r �prefixr� r� rt rz r* r* r* r+ rw g s � ����rw c @ rv ) �,IStreamClientEndpointStringParserWithReactora� An L{IStreamClientEndpointStringParserWithReactor} is a parser which can convert a set of string C{*args} and C{**kwargs} into an L{IStreamClientEndpoint} provider. This interface is really only useful in the context of the plugin system for L{endpoints.clientFromString}. See the document entitled "I{The Twisted Plugin System}" for more details on how to write a plugin. If you place an L{IStreamClientEndpointStringParserWithReactor} plugin in the C{twisted.plugins} package, that plugin's C{parseStreamClient} method will be used to produce endpoints for any description string that begins with the result of that L{IStreamClientEndpointStringParserWithReactor}'s prefix attribute. a! L{bytes}, the description prefix to respond to. For example, an L{IStreamClientEndpointStringParserWithReactor} plugin which had C{b"foo"} for its C{prefix} attribute would be called for endpoint descriptions like C{b"foo:bar:baz"} or C{b"foo:"}. rx r� r� r. c O r/ )a� This method is invoked by L{endpoints.clientFromString}, if the type of endpoint matches the return value from this L{IStreamClientEndpointStringParserWithReactor}'s C{prefix} method. @param reactor: The reactor passed to L{endpoints.clientFromString}. @param args: The byte string arguments, minus the endpoint type, in the endpoint description string, parsed according to the rules described in L{endpoints.quoteStringArgument}. For example, if the description were C{b"my-type:foo:bar:baz=qux"}, C{args} would be C{(b'foo', b'bar')} @param kwargs: The byte string arguments from the endpoint description passed as keyword arguments. For example, if the description were C{b"my-type:foo:bar:baz=qux"}, C{kwargs} would be C{dict(baz=b'qux')}. @return: a client endpoint Nr* ry r* r* r+ �parseStreamClient� r1 z>IStreamClientEndpointStringParserWithReactor.parseStreamClientN) r& r' r( r) r r{ r� r� rq r} r* r* r* r+ r| � s � ����r| c @ rE )� _ISupportsExitSignalCapturinga An implementor of L{_ISupportsExitSignalCapturing} will capture the value of any delivered exit signal (SIGINT, SIGTERM, SIGBREAK) for which it has installed a handler. The caught signal number is made available in the _exitSignal attribute. z� C{int} or C{None}, the integer exit signal delivered to the application, or None if no signal was delivered. N)r& r' r( r) r � _exitSignalr* r* r* r+ r~ � s �r~ N)xr) �typingr r r r r r r r r r r �zope.interfacer r �twisted.python.failurer �socketr � OpenSSL.SSLr r7 r r? � ImportErrorr� �twisted.internet.abstractr �twisted.internet.addressr r r �twisted.internet.deferr �twisted.internet.protocolr r r r r �twisted.internet.sslr �twisted.names.dnsr r �twisted.protocols.tlsr �twisted.python.runtimer! �supportsThreads�twisted.python.threadpoolr" r$ r- r6 r> r@ rF rM rf rq rv r} r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� rk r� r� r� r� r� r� r� r� r� r r r r� r r r r r r' r2 r5 r; r= rt rA rC rF rH rJ r� rU r\ ra rd re rq rt rw r| r~ r* r* r* r+ �<module> s� 4 � !!( U0,), |c#: ? !-.6" AA F<3 1