σ šίΘ[c@`snddlmZmZmZmZddlmZddlmZdgZ dgZ de fd„ƒYZ d S( i(tabsolute_importtdivisiontprint_functiontunicode_literalsi(t SAMPClient(t SAMPHubProxyuSAMPIntegratedClientuSAMPIntegratedClient.*tSAMPIntegratedClientcB`s`eZdZd(d(d(d(ded„Zed„ƒZd(d(dd„Zd„Z d„Z d„Z d „Z d „Z d „Zd „Zd „Zd„Zd„Zd„Zd„Zd„Zd„Zd„Zd„Zd„Zd„Zd„Zd„Zd(d(d„Zd„Zejje_d„Z ej je _d„Z!ej!je!_ed(d„Z"ej"je"_ed(d„Z#ej#je#_ed(d „Z$ej$je$_d!„Z%ej%je%_ed"„Z&ej&je&_ed#„Z'ej'je'_d$„Z(ej(je(_d(d%„Z)ej)je)_d&„Z*ej*je*_d'„Z+ej+je+_RS()uo A Simple SAMP client. This class is meant to simplify the client usage providing a proxy class that merges the :class:`~astropy.samp.SAMPClient` and :class:`~astropy.samp.SAMPHubProxy` functionalities in a simplified API. Parameters ---------- name : str, optional Client name (corresponding to ``samp.name`` metadata keyword). description : str, optional Client description (corresponding to ``samp.description.text`` metadata keyword). metadata : dict, optional Client application metadata in the standard SAMP format. addr : str, optional Listening address (or IP). This defaults to 127.0.0.1 if the internet is not reachable, otherwise it defaults to the host name. port : int, optional Listening XML-RPC server socket port. If left set to 0 (the default), the operating system will select a free port. callable : bool, optional Whether the client can receive calls and notifications. If set to `False`, then the client can send notifications and calls, but can not receive any. icC`sLtƒ|_i|d6|d6|d6|d6|d6|d6|_d|_dS(Nunameu descriptionumetadatauaddruportucallable(Rthubtclient_argumentstNonetclient(tselftnamet descriptiontmetadatataddrtporttcallable((s=lib/python2.7/site-packages/astropy/samp/integrated_client.pyt__init__1s  cC`s|jjo|jjS(uΨ Testing method to verify the client connection with a running Hub. Returns ------- is_connected : bool True if the client is connected to a Hub, False otherwise. (Rt is_connectedR t is_running(R ((s=lib/python2.7/site-packages/astropy/samp/integrated_client.pyRJs icC`sL|jj|||ƒt|j|j|_|jjƒ|jjƒdS(uN Connect with the current or specified SAMP Hub, start and register the client. Parameters ---------- hub : `~astropy.samp.SAMPHubServer`, optional The hub to connect to. hub_params : dict, optional Optional dictionary containing the lock-file content of the Hub with which to connect. This dictionary has the form ``{: , ...}``. pool_size : int, optional The number of socket connections opened to communicate with the Hub. N(RtconnectRRR tstarttregister(R Rt hub_paramst pool_size((s=lib/python2.7/site-packages/astropy/samp/integrated_client.pyRVs  cC`sN|jrJz|jjƒWd|jjr9|jjƒn|jjƒXndS(uw Unregister the client from the current SAMP Hub, stop the client and disconnect from the Hub. N(RR t unregisterRtstopRt disconnect(R ((s=lib/python2.7/site-packages/astropy/samp/integrated_client.pyRws   cC`s |jjƒS(uL Proxy to ``ping`` SAMP Hub method (Standard Profile only). (Rtping(R ((s=lib/python2.7/site-packages/astropy/samp/integrated_client.pyR…scC`s|jj|ƒS(u? Proxy to ``declareMetadata`` SAMP Hub method. (R tdeclare_metadata(R R((s=lib/python2.7/site-packages/astropy/samp/integrated_client.pyR‹scC`s|jj|jƒ|ƒS(u; Proxy to ``getMetadata`` SAMP Hub method. (Rt get_metadatatget_private_key(R t client_id((s=lib/python2.7/site-packages/astropy/samp/integrated_client.pyR‘scC`s|jj|jƒ|ƒS(u@ Proxy to ``getSubscriptions`` SAMP Hub method. (Rtget_subscriptionsR (R R!((s=lib/python2.7/site-packages/astropy/samp/integrated_client.pyR"—scC`s|jj|jƒƒS(u” Proxy to ``getRegisteredClients`` SAMP Hub method. This returns all the registered clients, excluding the current client. (Rtget_registered_clientsR (R ((s=lib/python2.7/site-packages/astropy/samp/integrated_client.pyR#scC`s|jj|jƒ|ƒS(uD Proxy to ``getSubscribedClients`` SAMP Hub method. (Rtget_subscribed_clientsR (R tmtype((s=lib/python2.7/site-packages/astropy/samp/integrated_client.pyR$₯scC`s_i}d|krG|d}|d=i|d6|d6}|j|ƒni|d6|d6}|S(Nu extra_kwsu samp.mtypeu samp.params(tupdate(R R%tparamstmsgtextra((s=lib/python2.7/site-packages/astropy/samp/integrated_client.pyt_format_easy_msg«s  cC`s|jj|jƒ||ƒS(u6 Proxy to ``notify`` SAMP Hub method. (RtnotifyR (R t recipient_idtmessage((s=lib/python2.7/site-packages/astropy/samp/integrated_client.pyR+ΉscK`s|j||j||ƒƒS(u9 Easy to use version of :meth:`~astropy.samp.integrated_client.SAMPIntegratedClient.notify`. This is a proxy to ``notify`` method that allows to send the notification message in a simplified way. Note that reserved ``extra_kws`` keyword is a dictionary with the special meaning of being used to add extra keywords, in addition to the standard ``samp.mtype`` and ``samp.params``, to the message sent. Parameters ---------- recipient_id : str Recipient ID mtype : str the MType to be notified params : dict or set of keywords Variable keyword set which contains the list of parameters for the specified MType. Examples -------- >>> from astropy.samp import SAMPIntegratedClient >>> cli = SAMPIntegratedClient() >>> ... >>> cli.enotify("samp.msg.progress", msgid = "xyz", txt = "initialization", ... percent = "10", extra_kws = {"my.extra.info": "just an example"}) (R+R*(R R,R%R'((s=lib/python2.7/site-packages/astropy/samp/integrated_client.pytenotifyΏscC`s|jj|jƒ|ƒS(u9 Proxy to ``notifyAll`` SAMP Hub method. (Rt notify_allR (R R-((s=lib/python2.7/site-packages/astropy/samp/integrated_client.pyR/ΰscK`s|j|j||ƒƒS(u Easy to use version of :meth:`~astropy.samp.integrated_client.SAMPIntegratedClient.notify_all`. This is a proxy to ``notifyAll`` method that allows to send the notification message in a simplified way. Note that reserved ``extra_kws`` keyword is a dictionary with the special meaning of being used to add extra keywords, in addition to the standard ``samp.mtype`` and ``samp.params``, to the message sent. Parameters ---------- mtype : str MType to be notified. params : dict or set of keywords Variable keyword set which contains the list of parameters for the specified MType. Examples -------- >>> from astropy.samp import SAMPIntegratedClient >>> cli = SAMPIntegratedClient() >>> ... >>> cli.enotify_all("samp.msg.progress", txt = "initialization", ... percent = "10", ... extra_kws = {"my.extra.info": "just an example"}) (R/R*(R R%R'((s=lib/python2.7/site-packages/astropy/samp/integrated_client.pyt enotify_allζscC`s|jj|jƒ|||ƒS(u4 Proxy to ``call`` SAMP Hub method. (RtcallR (R R,tmsg_tagR-((s=lib/python2.7/site-packages/astropy/samp/integrated_client.pyR1scK`s|j|||j||ƒƒS(u‚ Easy to use version of :meth:`~astropy.samp.integrated_client.SAMPIntegratedClient.call`. This is a proxy to ``call`` method that allows to send a call message in a simplified way. Note that reserved ``extra_kws`` keyword is a dictionary with the special meaning of being used to add extra keywords, in addition to the standard ``samp.mtype`` and ``samp.params``, to the message sent. Parameters ---------- recipient_id : str Recipient ID msg_tag : str Message tag to use mtype : str MType to be sent params : dict of set of keywords Variable keyword set which contains the list of parameters for the specified MType. Examples -------- >>> from astropy.samp import SAMPIntegratedClient >>> cli = SAMPIntegratedClient() >>> ... >>> msgid = cli.ecall("abc", "xyz", "samp.msg.progress", ... txt = "initialization", percent = "10", ... extra_kws = {"my.extra.info": "just an example"}) (R1R*(R R,R2R%R'((s=lib/python2.7/site-packages/astropy/samp/integrated_client.pytecall s$cC`s|jj|jƒ||ƒS(u7 Proxy to ``callAll`` SAMP Hub method. (Rtcall_allR (R R2R-((s=lib/python2.7/site-packages/astropy/samp/integrated_client.pyR41scK`s |j||j||ƒƒdS(u[ Easy to use version of :meth:`~astropy.samp.integrated_client.SAMPIntegratedClient.call_all`. This is a proxy to ``callAll`` method that allows to send the call message in a simplified way. Note that reserved ``extra_kws`` keyword is a dictionary with the special meaning of being used to add extra keywords, in addition to the standard ``samp.mtype`` and ``samp.params``, to the message sent. Parameters ---------- msg_tag : str Message tag to use mtype : str MType to be sent params : dict of set of keywords Variable keyword set which contains the list of parameters for the specified MType. Examples -------- >>> from astropy.samp import SAMPIntegratedClient >>> cli = SAMPIntegratedClient() >>> ... >>> msgid = cli.ecall_all("xyz", "samp.msg.progress", ... txt = "initialization", percent = "10", ... extra_kws = {"my.extra.info": "just an example"}) N(R4R*(R R2R%R'((s=lib/python2.7/site-packages/astropy/samp/integrated_client.pyt ecall_all7s cC`s|jj|jƒ|||ƒS(u; Proxy to ``callAndWait`` SAMP Hub method. (Rt call_and_waitR (R R,R-ttimeout((s=lib/python2.7/site-packages/astropy/samp/integrated_client.pyR6YscK`s|j||j||ƒ|ƒS(uš Easy to use version of :meth:`~astropy.samp.integrated_client.SAMPIntegratedClient.call_and_wait`. This is a proxy to ``callAndWait`` method that allows to send the call message in a simplified way. Note that reserved ``extra_kws`` keyword is a dictionary with the special meaning of being used to add extra keywords, in addition to the standard ``samp.mtype`` and ``samp.params``, to the message sent. Parameters ---------- recipient_id : str Recipient ID mtype : str MType to be sent timeout : str Call timeout in seconds params : dict of set of keywords Variable keyword set which contains the list of parameters for the specified MType. Examples -------- >>> from astropy.samp import SAMPIntegratedClient >>> cli = SAMPIntegratedClient() >>> ... >>> cli.ecall_and_wait("xyz", "samp.msg.progress", "5", ... txt = "initialization", percent = "10", ... extra_kws = {"my.extra.info": "just an example"}) (R6R*(R R,R%R7R'((s=lib/python2.7/site-packages/astropy/samp/integrated_client.pytecall_and_wait_s#cC`s|jj|jƒ||ƒS(u5 Proxy to ``reply`` SAMP Hub method. (RtreplyR (R tmsg_idtresponse((s=lib/python2.7/site-packages/astropy/samp/integrated_client.pyR9„scC`sWi|d6}|dk r0|ji|d6ƒn|dk rS|ji|d6ƒn|S(Nu samp.statusu samp.resultu samp.error(R R&(R tstatustresultterrorR(((s=lib/python2.7/site-packages/astropy/samp/integrated_client.pyt_format_easy_responseŠs    cC`s|j||j|||ƒƒS(ua Easy to use version of :meth:`~astropy.samp.integrated_client.SAMPIntegratedClient.reply`. This is a proxy to ``reply`` method that allows to send a reply message in a simplified way. Parameters ---------- msg_id : str Message ID to which reply. status : str Content of the ``samp.status`` response keyword. result : dict Content of the ``samp.result`` response keyword. error : dict Content of the ``samp.error`` response keyword. Examples -------- >>> from astropy.samp import SAMPIntegratedClient, SAMP_STATUS_ERROR >>> cli = SAMPIntegratedClient() >>> ... >>> cli.ereply("abd", SAMP_STATUS_ERROR, result={}, ... error={"samp.errortxt": "Test error message"}) (R9R?(R R:R<R=R>((s=lib/python2.7/site-packages/astropy/samp/integrated_client.pytereply”scC`s|jj|||ƒS(N(R treceive_notification(R t private_keyt sender_idR-((s=lib/python2.7/site-packages/astropy/samp/integrated_client.pyRA΅scC`s|jj||||ƒS(N(R t receive_call(R RBRCR:R-((s=lib/python2.7/site-packages/astropy/samp/integrated_client.pyRDΊscC`s|jj||||ƒS(N(R treceive_response(R RBt responder_idR2R;((s=lib/python2.7/site-packages/astropy/samp/integrated_client.pyREΏscC`s#|jj||dtddƒdS(NtdeclareR(R tbind_receive_messagetTrueR (R R%tfunctionRGR((s=lib/python2.7/site-packages/astropy/samp/integrated_client.pyRHΔscC`s|jj||||ƒdS(N(R tbind_receive_notification(R R%RJRGR((s=lib/python2.7/site-packages/astropy/samp/integrated_client.pyRKΙscC`s|jj||||ƒdS(N(R tbind_receive_call(R R%RJRGR((s=lib/python2.7/site-packages/astropy/samp/integrated_client.pyRLΞscC`s|jj||ƒdS(N(R tbind_receive_response(R R2RJ((s=lib/python2.7/site-packages/astropy/samp/integrated_client.pyRMΣscC`s|jj||ƒdS(N(R tunbind_receive_notification(R R%RG((s=lib/python2.7/site-packages/astropy/samp/integrated_client.pyRNΨscC`s|jj||ƒdS(N(R tunbind_receive_call(R R%RG((s=lib/python2.7/site-packages/astropy/samp/integrated_client.pyROέscC`s|jj|ƒdS(N(R tunbind_receive_response(R R2((s=lib/python2.7/site-packages/astropy/samp/integrated_client.pyRPβscC`s|jj|ƒdS(N(R tdeclare_subscriptions(R t subscriptions((s=lib/python2.7/site-packages/astropy/samp/integrated_client.pyRQηscC`s |jjƒS(N(R R (R ((s=lib/python2.7/site-packages/astropy/samp/integrated_client.pyR μscC`s |jjƒS(N(R t get_public_id(R ((s=lib/python2.7/site-packages/astropy/samp/integrated_client.pyRSρsN(,t__name__t __module__t__doc__R RIRtpropertyRRRRRRR"R#R$R*R+R.R/R0R1R3R4R5R6R8R9R?R@RARRDRERHRKRLRMRNRORPRQR RS(((s=lib/python2.7/site-packages/astropy/samp/integrated_client.pyRsh!  !          !    &  "  %  !          N( t __future__RRRRR Rt hub_proxyRt__all__t__doctest_skip__tobjectR(((s=lib/python2.7/site-packages/astropy/samp/integrated_client.pyts "