U
    
W[  ã                   @   sx   d Z ddlmZm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ƒZ	dS )z
Public Jabber Interfaces.
é    )Ú	AttributeÚ	Interfacec                   @   s   e Zd ZdZdS )ÚIInitializerz¡
    Interface for XML stream initializers.

    Initializers perform a step in getting the XML stream ready to be
    used for the exchange of XML stanzas.
    N)Ú__name__Ú
__module__Ú__qualname__Ú__doc__© r	   r	   úH/usr/lib/python3/dist-packages/twisted/words/protocols/jabber/ijabber.pyr   
   s   r   c                   @   s    e Zd ZdZedƒZdd„ ZdS )ÚIInitiatingInitializerzJ
    Interface for XML stream initializers for the initiating entity.
    zThe associated XML streamc                   C   s   dS )z‚
        Initiate the initialization step.

        May return a deferred when the initialization is done asynchronously.
        Nr	   r	   r	   r	   r
   Ú
initialize   s    z!IInitiatingInitializer.initializeN)r   r   r   r   r   Ú	xmlstreamr   r	   r	   r	   r
   r      s   r   c                   @   s   e Zd ZdZedƒZdS )ÚIIQResponseTrackeraº  
    IQ response tracker interface.

    The XMPP stanza C{iq} has a request-response nature that fits
    naturally with deferreds. You send out a request and when the response
    comes back a deferred is fired.

    The L{twisted.words.protocols.jabber.client.IQ} class implements a C{send}
    method that returns a deferred. This deferred is put in a dictionary that
    is kept in an L{XmlStream} object, keyed by the request stanzas C{id}
    attribute.

    An object providing this interface (usually an instance of L{XmlStream}),
    keeps the said dictionary and sets observers on the iq stanzas of type
    C{result} and C{error} and lets the callback fire the associated deferred.
    z2Dictionary of deferreds waiting for an iq responseN)r   r   r   r   r   ZiqDeferredsr	   r	   r	   r
   r   $   s   r   c                   @   sP   e Zd ZdZedƒZedƒZdd„ Zdd„ Zdd	„ Z	d
d„ Z
dd„ Zdd„ ZdS )ÚIXMPPHandlerz°
    Interface for XMPP protocol handlers.

    Objects that provide this interface can be added to a stream manager to
    handle of (part of) an XMPP extension protocol.
    z#XML stream manager for this handlerzThe managed XML streamc                 C   s   dS )za
        Set the parent of the handler.

        @type parent: L{IXMPPHandlerCollection}
        Nr	   ©Úparentr	   r	   r
   ÚsetHandlerParentE   s    zIXMPPHandler.setHandlerParentc                 C   s   dS )zd
        Remove the parent of the handler.

        @type parent: L{IXMPPHandlerCollection}
        Nr	   r   r	   r	   r
   ÚdisownHandlerParentM   s    z IXMPPHandler.disownHandlerParentc                 C   s   dS )aj  
        A connection over the underlying transport of the XML stream has been
        established.

        At this point, no traffic has been exchanged over the XML stream
        given in C{xs}.

        This should setup L{xmlstream} and call L{connectionMade}.

        @type xs:
               L{twisted.words.protocols.jabber.xmlstream.XmlStream}
        Nr	   ©Zxsr	   r	   r
   ÚmakeConnectionU   s    zIXMPPHandler.makeConnectionc                   C   s   dS )zý
        Called after a connection has been established.

        This method can be used to change properties of the XML Stream, its
        authenticator or the stream manager prior to stream initialization
        (including authentication).
        Nr	   r	   r	   r	   r
   ÚconnectionMaded   s    zIXMPPHandler.connectionMadec                   C   s   dS )a  
        The XML stream has been initialized.

        At this point, authentication was successful, and XML stanzas can be
        exchanged over the XML stream L{xmlstream}. This method can be
        used to setup observers for incoming stanzas.
        Nr	   r	   r	   r	   r
   ÚconnectionInitializedn   s    z"IXMPPHandler.connectionInitializedc                 C   s   dS )zê
        The XML stream has been closed.

        Subsequent use of C{parent.send} will result in data being queued
        until a new connection has been established.

        @type reason: L{twisted.python.failure.Failure}
        Nr	   )Úreasonr	   r	   r
   ÚconnectionLostx   s    zIXMPPHandler.connectionLostN)r   r   r   r   r   r   r   r   r   r   r   r   r   r	   r	   r	   r
   r   :   s   

r   c                   @   s(   e Zd ZdZdd„ Zdd„ Zdd„ ZdS )	ÚIXMPPHandlerCollectionz\
    Collection of handlers.

    Contain several handlers and manage their connection.
    c                   C   s   dS )z:
        Get an iterator over all child handlers.
        Nr	   r	   r	   r	   r
   Ú__iter__‹   s    zIXMPPHandlerCollection.__iter__c                 C   s   dS )zN
        Add a child handler.

        @type handler: L{IXMPPHandler}
        Nr	   ©Zhandlerr	   r	   r
   Ú
addHandler‘   s    z!IXMPPHandlerCollection.addHandlerc                 C   s   dS )zQ
        Remove a child handler.

        @type handler: L{IXMPPHandler}
        Nr	   r   r	   r	   r
   ÚremoveHandler™   s    z$IXMPPHandlerCollection.removeHandlerN)r   r   r   r   r   r   r   r	   r	   r	   r
   r   „   s   r   c                   @   s(   e Zd ZdZdd„ Zdd„ Zdd„ ZdS )	ÚIServicezÒ
    External server-side component service interface.

    Services that provide this interface can be added to L{ServiceManager} to
    implement (part of) the functionality of the server-side component.
    c                 C   s   dS )ax  
        Parent component has established a connection.

        At this point, authentication was successful, and XML stanzas
        can be exchanged over the XML stream C{xs}. This method can be used
        to setup observers for incoming stanzas.

        @param xs: XML Stream that represents the established connection.
        @type xs: L{xmlstream.XmlStream}
        Nr	   r   r	   r	   r
   ÚcomponentConnectedª   s    zIService.componentConnectedc                   C   s   dS )zÕ
        Parent component has lost the connection to the Jabber server.

        Subsequent use of C{self.parent.send} will result in data being
        queued until a new connection has been established.
        Nr	   r	   r	   r	   r
   ÚcomponentDisconnected·   s    zIService.componentDisconnectedc                 C   s   dS )ay  
        Parent component has established a connection over the underlying
        transport.

        At this point, no traffic has been exchanged over the XML stream. This
        method can be used to change properties of the XML Stream (in C{xs}),
        the service manager or it's authenticator prior to stream
        initialization (including authentication).
        Nr	   r   r	   r	   r
   ÚtransportConnectedÀ   s    zIService.transportConnectedN)r   r   r   r   r    r!   r"   r	   r	   r	   r
   r   ¢   s   	r   N)
r   Zzope.interfacer   r   r   r   r   r   r   r   r	   r	   r	   r
   Ú<module>   s   
J