|Mc @sdZddlZddlmZddlmZmZmZddlm Z m Z m Z dd%dYZ de fd YZ d e fd YZd d&d YZde fdYZde fdYZdd'dYZeje jZejdefdYZdejfdYZejee je jdejfdYZejee je jdefdYZdd(dYZdefdYZ d e fd!YZ!d"d)d#YZ"dddd$ddd"dddd d g Z#dS(*s Standard implementations of Twisted protocol-related interfaces. Start here if you are looking to write a new protocol implementation for Twisted. The Protocol class contains some introductory material. Maintainer: Itamar Shtull-Trauring iN(t implements(tlogtfailuret components(t interfacesterrortdefertFactorycBsZeZdZeejdZdZe Z dZ dZ dZ dZdZRS(sThis is a factory which produces protocols. By default, buildProtocol will create a protocol of the class given in self.protocol. icCsG|js3|jr&tjd|n|jn|jd|_dS(scMake sure startFactory is called. Users should not call this function themselves! sStarting factory %riN(tnumPortstnoisyRtmsgt startFactory(tself((s=/usr/lib/python2.7/dist-packages/twisted/internet/protocol.pytdoStart%s    cCsZ|jdkrdS|jd|_|jsV|jrItjd|n|jndS(sbMake sure stopFactory is called. Users should not call this function themselves! iNisStopping factory %r(RR RR t stopFactory(R ((s=/usr/lib/python2.7/dist-packages/twisted/internet/protocol.pytdoStop0s  cCsdS(spThis will be called before I begin listening on a Port or Connector. It will only be called once, even if the factory is connected to multiple ports. This can be used to perform 'unserialization' tasks that are best put off until things are actually running, such as connecting to a database, opening files, etcetera. N((R ((s=/usr/lib/python2.7/dist-packages/twisted/internet/protocol.pyR ?scCsdS(s}This will be called before I stop listening on all Ports/Connectors. This can be overridden to perform 'shutdown' tasks such as disconnecting database connections, closing files, etc. It will be called, for example, before an application shuts down, if it was connected to a port. User code should not call this function directly. N((R ((s=/usr/lib/python2.7/dist-packages/twisted/internet/protocol.pyRJscCs|j}||_|S(svCreate an instance of a subclass of Protocol. The returned instance will handle input on an incoming server connection, and an attribute "factory" pointing to the creating factory. Override this method to alter how Protocol instances get created. @param addr: an object implementing L{twisted.internet.interfaces.IAddress} (tprotocoltfactory(R taddrtp((s=/usr/lib/python2.7/dist-packages/twisted/internet/protocol.pyt buildProtocolUs  N(t__name__t __module__t__doc__RRtIProtocolFactorytNoneRRtTrueR R RR RR(((s=/usr/lib/python2.7/dist-packages/twisted/internet/protocol.pyRs   t ClientFactorycBs)eZdZdZdZdZRS(sxA Protocol factory for clients. This can be used together with the various connectXXX methods in reactors. cCsdS(sCalled when a connection has been started. You can call connector.stopConnecting() to stop the connection attempt. @param connector: a Connector object. N((R t connector((s=/usr/lib/python2.7/dist-packages/twisted/internet/protocol.pytstartedConnectinglscCsdS(sCalled when a connection has failed to connect. It may be useful to call connector.connect() - this will reconnect. @type reason: L{twisted.python.failure.Failure} N((R Rtreason((s=/usr/lib/python2.7/dist-packages/twisted/internet/protocol.pytclientConnectionFailedtscCsdS(sCalled when an established connection is lost. It may be useful to call connector.connect() - this will reconnect. @type reason: L{twisted.python.failure.Failure} N((R RR((s=/usr/lib/python2.7/dist-packages/twisted/internet/protocol.pytclientConnectionLost|s(RRRRRR (((s=/usr/lib/python2.7/dist-packages/twisted/internet/protocol.pyRes  t_InstanceFactorycBsGeZdZeZdZdZdZdZ dZ dZ RS(sP Factory used by ClientCreator. @ivar deferred: The L{Deferred} which represents this connection attempt and which will be fired when it succeeds or fails. @ivar pending: After a connection attempt succeeds or fails, a delayed call which will fire the L{Deferred} representing this connection attempt. cCs||_||_||_dS(N(treactortinstancetdeferred(R R"R#R$((s=/usr/lib/python2.7/dist-packages/twisted/internet/protocol.pyt__init__s  cCsd|jfS(Ns(R#(R ((s=/usr/lib/python2.7/dist-packages/twisted/internet/protocol.pyt__repr__scCs:|jjd|j|jj|j|_d|_|jS(s Return the pre-constructed protocol instance and arrange to fire the waiting L{Deferred} to indicate success establishing the connection. iN(R"t callLatertfireR$tcallbackR#tpendingR(R R((s=/usr/lib/python2.7/dist-packages/twisted/internet/protocol.pyRs ! cCs4|jjd|j|jj||_d|_dS(s Arrange to fire the waiting L{Deferred} with the given failure to indicate the connection could not be established. iN(R"R'R(R$terrbackR*R(R RR((s=/usr/lib/python2.7/dist-packages/twisted/internet/protocol.pyRs cCsd|_||dS(sw Clear C{self.pending} to avoid a reference cycle and then invoke the callable with the value. N(RR*(R tcallabletvalue((s=/usr/lib/python2.7/dist-packages/twisted/internet/protocol.pyR(s N( RRRtFalseR RR*R%R&RRR((((s=/usr/lib/python2.7/dist-packages/twisted/internet/protocol.pyR!s    t ClientCreatorcBsMeZdZdZdZdddZdedZdddZ RS(s Client connections that do not require a factory. The various connect* methods create a protocol instance using the given protocol class and arguments, and connect it, returning a Deferred of the resulting protocol instance. Useful for cases when we don't really need a factory. Mainly this is when there is no shared state between protocol instances, and no need to reconnect. The C{connectTCP}, C{connectUNIX}, and C{connectSSL} methods each return a L{Deferred} which will fire with an instance of the protocol class passed to L{ClientCreator.__init__}. These Deferred can be cancelled to abort the connection attempt (in a very unlikely case, cancelling the Deferred may not prevent the protocol from being instantiated and connected to a transport; if this happens, it will be disconnected immediately afterwards and the Deferred will still errback with L{CancelledError}). cOs(||_||_||_||_dS(N(R"t protocolClasstargstkwargs(R R"R0R1R2((s=/usr/lib/python2.7/dist-packages/twisted/internet/protocol.pyR%s   csafd}tj|}t|j|j|j|j||d|||S(s3 Initiate a connection attempt. @param method: A callable which will actually start the connection attempt. For example, C{reactor.connectTCP}. @param *args: Positional arguments to pass to C{method}, excluding the factory. @param **kwargs: Keyword arguments to pass to C{method}. @return: A L{Deferred} which fires with an instance of the protocol class passed to this L{ClientCreator}'s initializer or fails if the connection cannot be set up for some reason. cs-jjdk r)jjndS(N(t disconnectR*Rtcancel(R$(Rtf(s=/usr/lib/python2.7/dist-packages/twisted/internet/protocol.pyt cancelConnects R(RtDeferredR!R"R0R1R2(R tmethodR1R2R6td((R5Rs=/usr/lib/python2.7/dist-packages/twisted/internet/protocol.pyt_connects $icCs%|j|jj||d|d|S(s Connect to a TCP server. The parameters are all the same as to L{IReactorTCP.connectTCP} except that the factory parameter is omitted. @return: A L{Deferred} which fires with an instance of the protocol class passed to this L{ClientCreator}'s initializer or fails if the connection cannot be set up for some reason. ttimeoutt bindAddress(R:R"t connectTCP(R thosttportR;R<((s=/usr/lib/python2.7/dist-packages/twisted/internet/protocol.pyR=s cCs"|j|jj|d|d|S(s Connect to a Unix socket. The parameters are all the same as to L{IReactorUNIX.connectUNIX} except that the factory parameter is omitted. @return: A L{Deferred} which fires with an instance of the protocol class passed to this L{ClientCreator}'s initializer or fails if the connection cannot be set up for some reason. R;tcheckPID(R:R"t connectUNIX(R taddressR;R@((s=/usr/lib/python2.7/dist-packages/twisted/internet/protocol.pyRAs c Cs+|j|jj||d|d|d|S(s Connect to an SSL server. The parameters are all the same as to L{IReactorSSL.connectSSL} except that the factory parameter is omitted. @return: A L{Deferred} which fires with an instance of the protocol class passed to this L{ClientCreator}'s initializer or fails if the connection cannot be set up for some reason. tcontextFactoryR;R<(R:R"t connectSSL(R R>R?RCR;R<((s=/usr/lib/python2.7/dist-packages/twisted/internet/protocol.pyRDs  N( RRRR%R:RR=R.RARD(((s=/usr/lib/python2.7/dist-packages/twisted/internet/protocol.pyR/s   tReconnectingClientFactorycBseZdZdZdZdZdZeZdZd Z d Z d Z d Z dZdZdZd d Zd Zd Zd ZRS(s Factory which auto-reconnects clients with an exponential back-off. Note that clients should call my resetDelay method after they have connected successfully. @ivar maxDelay: Maximum number of seconds between connection attempts. @ivar initialDelay: Delay for the first reconnection attempt. @ivar factor: A multiplicitive factor by which the delay grows @ivar jitter: Percentage of randomness to introduce into the delay length to prevent stampeding. @ivar clock: The clock used to schedule reconnection. It's mainly useful to be parametrized in tests. If the factory is serialized, this attribute will not be serialized, and the default value (the reactor) will be restored when deserialized. @type clock: L{IReactorTime} @ivar maxRetries: Maximum number of consecutive unsuccessful connection attempts, after which no further connection attempts will be made. If this is not explicitly set, no maximum is applied. ig?giW @gȉ4؟?iicCs#|jr||_|jndS(N(tcontinueTryingRtretry(R RR((s=/usr/lib/python2.7/dist-packages/twisted/internet/protocol.pyROs  cCs#|jr||_|jndS(N(RFRRG(R Rt unused_reason((s=/usr/lib/python2.7/dist-packages/twisted/internet/protocol.pyR Us  csjs-jr)tjdfndSdkrcjdkrWtdqcjnjd7_jdk rjjkrjrtjdjfndSt j j j _ j r tjj j j _ njr0tjdj fnfd}jdkrmdd lm}|_njjj |_dS( sL Have this connector connect again, after a suitable delay. s!Abandoning %s on explicit requestNsno connector to retryisAbandoning %s after %d retries.s%s will retry in %d secondscsd_jdS(N(Rt_callIDtconnect((RR (s=/usr/lib/python2.7/dist-packages/twisted/internet/protocol.pyt reconnectorys i(R"(RFR RR RRt ValueErrortretriest maxRetriestmintdelaytfactortmaxDelaytjittertrandomt normalvariatetclockttwisted.internetR"R'RI(R RRKR"((R Rs=/usr/lib/python2.7/dist-packages/twisted/internet/protocol.pyRG[s2    !      cCsc|jr"|jjd|_nd|_|jr_y|jjWq_tjk r[q_XndS(sE Put a stop to any attempt to reconnect in progress. iN(RIR4RRFRtstopConnectingRtNotConnectingError(R ((s=/usr/lib/python2.7/dist-packages/twisted/internet/protocol.pyt stopTryings     cCs+|j|_d|_d|_d|_dS(st Call this method after a successful connection: it resets the delay and the retry counter. iiN(t initialDelayRPRMRRIRF(R ((s=/usr/lib/python2.7/dist-packages/twisted/internet/protocol.pyt resetDelays   cCsL|jj}x6ddddddgD]}||kr(||=q(q(W|S(s- Remove all of the state which is mutated by connection attempts and failures, returning just the state which describes how reconnections should be attempted. This will make the unserialized instance behave just as this one did when it was first instantiated. RRMRPRFRIRV(t__dict__tcopy(R tstatetkey((s=/usr/lib/python2.7/dist-packages/twisted/internet/protocol.pyt __getstate__s   N(RRRRRR[RQRSRPRMRRNRIRRVRFRR RGRZR\Ra(((s=/usr/lib/python2.7/dist-packages/twisted/internet/protocol.pyRE%s$   '  t ServerFactorycBseZdZRS(sUSubclass this to indicate that your protocol.Factory is only usable for servers. (RRR(((s=/usr/lib/python2.7/dist-packages/twisted/internet/protocol.pyRbst BaseProtocolcBs,eZdZdZdZdZdZRS(sThis is the abstract superclass of all protocols. If you are going to write a new protocol for Twisted, start here. The docstrings of this class explain how you can get started. Any protocol implementation, either client or server, should be a subclass of me. My API is quite simple. Implement dataReceived(data) to handle both event-based and synchronous input; output can be sent through the 'transport' attribute, which is to be an instance that implements L{twisted.internet.interfaces.ITransport}. Some subclasses exist already to help you write common types of protocols: see the L{twisted.protocols.basic} module for a few of them. icCs d|_||_|jdS(sMake a connection to a transport and a server. This sets the 'transport' attribute of this Protocol, and calls the connectionMade() callback. iN(t connectedt transporttconnectionMade(R Re((s=/usr/lib/python2.7/dist-packages/twisted/internet/protocol.pytmakeConnections  cCsdS(sCalled 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. N((R ((s=/usr/lib/python2.7/dist-packages/twisted/internet/protocol.pyRfsN(RRRRdRReRgRf(((s=/usr/lib/python2.7/dist-packages/twisted/internet/protocol.pyRcs  tProtocolcBs*eZeejdZedZRS(cCsdS(s=Called whenever data is received. Use this method to translate to a higher-level message. Usually, some callback will be made upon the receipt of each complete protocol message. @param data: a string of indeterminate length. Please keep in mind that you will probably need to buffer some data, as partial (or multiple) protocol messages may be received! I recommend that unit tests for protocols call through to this method with differing chunk sizes, down to one byte at a time. N((R tdata((s=/usr/lib/python2.7/dist-packages/twisted/internet/protocol.pyt dataReceivedscCsdS(sCalled when the connection is shut down. Clear any circular references here, and any external references to this Protocol. The connection has been closed. @type reason: L{twisted.python.failure.Failure} N((R R((s=/usr/lib/python2.7/dist-packages/twisted/internet/protocol.pytconnectionLosts(RRRRt IProtocolRjtconnectionDoneRk(((s=/usr/lib/python2.7/dist-packages/twisted/internet/protocol.pyRhs  tProtocolToConsumerAdaptercBs0eZeejdZdZdZRS(cCs|jj|dS(N(toriginalRj(R Ri((s=/usr/lib/python2.7/dist-packages/twisted/internet/protocol.pytwritescCsdS(N((R tproducert streaming((s=/usr/lib/python2.7/dist-packages/twisted/internet/protocol.pytregisterProducerscCsdS(N((R ((s=/usr/lib/python2.7/dist-packages/twisted/internet/protocol.pytunregisterProducers(RRRRt IConsumerRpRsRt(((s=/usr/lib/python2.7/dist-packages/twisted/internet/protocol.pyRns   tConsumerToProtocolAdaptercBs9eZeejdZdZdZdZRS(cCs|jj|dS(N(RoRp(R Ri((s=/usr/lib/python2.7/dist-packages/twisted/internet/protocol.pyRj scCsdS(N((R R((s=/usr/lib/python2.7/dist-packages/twisted/internet/protocol.pyRkscCsdS(N((R Re((s=/usr/lib/python2.7/dist-packages/twisted/internet/protocol.pyRgscCsdS(N((R ((s=/usr/lib/python2.7/dist-packages/twisted/internet/protocol.pyRfs( RRRRRlRjRkRgRf(((s=/usr/lib/python2.7/dist-packages/twisted/internet/protocol.pyRv s     tProcessProtocolcBsleZdZeejdZdZdZdZ dZ dZ dZ dZ d ZRS( s Base process protocol implementation which does simple dispatching for stdin, stdout, and stderr file descriptors. cCs<|dkr|j|n|dkr8|j|ndS(Nii(t outReceivedt errReceived(R tchildFDRi((s=/usr/lib/python2.7/dist-packages/twisted/internet/protocol.pytchildDataReceived"s  cCsdS(s5 Some data was received from stdout. N((R Ri((s=/usr/lib/python2.7/dist-packages/twisted/internet/protocol.pyRx)scCsdS(s5 Some data was received from stderr. N((R Ri((s=/usr/lib/python2.7/dist-packages/twisted/internet/protocol.pyRy/scCsO|dkr|jn2|dkr2|jn|dkrK|jndS(Niii(tinConnectionLosttoutConnectionLostterrConnectionLost(R Rz((s=/usr/lib/python2.7/dist-packages/twisted/internet/protocol.pytchildConnectionLost5s      cCsdS(s; This will be called when stdin is closed. N((R ((s=/usr/lib/python2.7/dist-packages/twisted/internet/protocol.pyR|>scCsdS(s< This will be called when stdout is closed. N((R ((s=/usr/lib/python2.7/dist-packages/twisted/internet/protocol.pyR}DscCsdS(s< This will be called when stderr is closed. N((R ((s=/usr/lib/python2.7/dist-packages/twisted/internet/protocol.pyR~JscCsdS(sy This will be called when the subprocess exits. @type reason: L{twisted.python.failure.Failure} N((R R((s=/usr/lib/python2.7/dist-packages/twisted/internet/protocol.pyt processExitedPscCsdS(s This will be called when the subprocess is finished. @type reason: L{twisted.python.failure.Failure} N((R R((s=/usr/lib/python2.7/dist-packages/twisted/internet/protocol.pyt processEndedXs(RRRRRtIProcessProtocolR{RxRyRR|R}R~RR(((s=/usr/lib/python2.7/dist-packages/twisted/internet/protocol.pyRws        tAbstractDatagramProtocolcBs_eZdZd ZdZeZdZdZ dZ dZ dZ dZ dZRS( sV Abstract protocol for datagram-oriented transports, e.g. IP, ICMP, ARP, UDP. icCs|jj}d|d<|S(NRe(R]R^R(R R9((s=/usr/lib/python2.7/dist-packages/twisted/internet/protocol.pyRajs cCsG|js3|jr&tjd|n|jn|jd|_dS(swMake sure startProtocol is called. This will be called by makeConnection(), users should not call it. sStarting protocol %siN(RR RR t startProtocol(R ((s=/usr/lib/python2.7/dist-packages/twisted/internet/protocol.pyR os    cCse|jdkst|jd|_d|_|jsa|jrTtjd|n|jndS(snMake sure stopProtocol is called. This will be called by the port, users should not call it. iisStopping protocol %sN(RtAssertionErrorRReR RR t stopProtocol(R ((s=/usr/lib/python2.7/dist-packages/twisted/internet/protocol.pyRzs   cCsdS(sCalled when a transport is connected to this protocol. Will only be called once, even if multiple ports are connected. N((R ((s=/usr/lib/python2.7/dist-packages/twisted/internet/protocol.pyRscCsdS(sxCalled when the transport is disconnected. Will only be called once, after all ports are disconnected. N((R ((s=/usr/lib/python2.7/dist-packages/twisted/internet/protocol.pyRscCs,|jdkst||_|jdS(sMake a connection to a transport and a server. This sets the 'transport' attribute of this DatagramProtocol, and calls the doStart() callback. N(ReRRR (R Re((s=/usr/lib/python2.7/dist-packages/twisted/internet/protocol.pyRgs cCsdS(sCalled when a datagram is received. @param datagram: the string received from the transport. @param addr: tuple of source of datagram. N((R tdatagramR((s=/usr/lib/python2.7/dist-packages/twisted/internet/protocol.pytdatagramReceivedsN(RRRRReRRR RaR RRRRgR(((s=/usr/lib/python2.7/dist-packages/twisted/internet/protocol.pyRas    tDatagramProtocolcBseZdZdZRS(s  Protocol for datagram-oriented transport, e.g. UDP. @type transport: C{NoneType} or L{IUDPTransport} provider @ivar transport: The transport with which this protocol is associated, if it is associated with one. cCsdS(sCalled due to error from write in connected mode. Note this is a result of ICMP message generated by *previous* write. N((R ((s=/usr/lib/python2.7/dist-packages/twisted/internet/protocol.pytconnectionRefuseds(RRRR(((s=/usr/lib/python2.7/dist-packages/twisted/internet/protocol.pyRstConnectedDatagramProtocolcBs eZdZdZdZRS(sZProtocol for connected datagram-oriented transport. No longer necessary for UDP. cCsdS(snCalled when a datagram is received. @param datagram: the string received from the transport. N((R R((s=/usr/lib/python2.7/dist-packages/twisted/internet/protocol.pyRscCsdS(s`Called if connecting failed. Usually this will be due to a DNS lookup failure. N((R R((s=/usr/lib/python2.7/dist-packages/twisted/internet/protocol.pytconnectionFaileds(RRRRR(((s=/usr/lib/python2.7/dist-packages/twisted/internet/protocol.pyRs t FileWrappercBseZdZeejdZdZdZ dZ dZ dZ dZ dZdZdZdZd Zd Zd Zd Zd ZdZdZRS(sA wrapper around a file-like object to make it behave as a Transport. This doesn't actually stream the file to the attached protocol, and is thus useful mainly as a utility for debugging protocols. icCs ||_dS(N(tfile(R R((s=/usr/lib/python2.7/dist-packages/twisted/internet/protocol.pyR%scCs,y|jj|Wn|jnXdS(N(RRpthandleException(R Ri((s=/usr/lib/python2.7/dist-packages/twisted/internet/protocol.pyRpscCs|jr|jjndS(N(RqtresumeProducing(R ((s=/usr/lib/python2.7/dist-packages/twisted/internet/protocol.pyt_checkProducers cCs)||_||_|s%|jndS(s%From abstract.FileDescriptor N(RqtstreamingProducerR(R RqRr((s=/usr/lib/python2.7/dist-packages/twisted/internet/protocol.pyRss  cCs d|_dS(N(RRq(R ((s=/usr/lib/python2.7/dist-packages/twisted/internet/protocol.pyRtscCs|j|jdS(N(RttloseConnection(R ((s=/usr/lib/python2.7/dist-packages/twisted/internet/protocol.pyt stopConsumings cCs|jdj|dS(Nt(Rptjoin(R tiovec((s=/usr/lib/python2.7/dist-packages/twisted/internet/protocol.pyt writeSequencescCsBd|_y|jjWn!ttfk r=|jnXdS(Ni(tclosedRtclosetIOErrortOSErrorR(R ((s=/usr/lib/python2.7/dist-packages/twisted/internet/protocol.pyRs  cCsdS(NR(sfilesfile((R ((s=/usr/lib/python2.7/dist-packages/twisted/internet/protocol.pytgetPeerscCsdS(NR((R ((s=/usr/lib/python2.7/dist-packages/twisted/internet/protocol.pytgetHostscCsdS(N((R ((s=/usr/lib/python2.7/dist-packages/twisted/internet/protocol.pyR scCsdS(N((R ((s=/usr/lib/python2.7/dist-packages/twisted/internet/protocol.pyR scCsdS(N((R ((s=/usr/lib/python2.7/dist-packages/twisted/internet/protocol.pytpauseProducingscCs|jdS(N(R(R ((s=/usr/lib/python2.7/dist-packages/twisted/internet/protocol.pyt stopProducingsN(RRRRRt ITransportRt disconnectingRRqRR%RpRRsRtRRRRRRRRR(((s=/usr/lib/python2.7/dist-packages/twisted/internet/protocol.pyRs(              Rm(((((($RRTtzope.interfaceRttwisted.pythonRRRRWRRRRRR!R/RERbRctFailuretConnectionDoneRmt cleanFailureRhtAdapterRntregisterAdapterRlRuRvRwRRRRt__all__(((s=/usr/lib/python2.7/dist-packages/twisted/internet/protocol.pyt s: O 7i(    FDN