B îq\.Cã@s6ddlmZddlmZdgZdgZGdd„dƒZdS)é)Ú SAMPClient)Ú SAMPHubProxyÚSAMPIntegratedClientzSAMPIntegratedClient.*c@sÐeZdZdZdPdd„Zedd„ƒZdQd d „Zd d „Zdd„Z dd„Z dd„Z dd„Z dd„Z dd„Zdd„Zdd„Zdd„Zd d!„Zd"d#„Zd$d%„Zd&d'„Zd(d)„Zd*d+„Zd,d-„Zd.d/„Zd0d1„Zd2d3„ZdRd4d5„Zd6d7„Zejje_d8d9„Zejje_d:d;„Z ej je _dSdd?„Z"ej"je"_dUd@dA„Z#ej#je#_dBdC„Z$ej$je$_dVdDdE„Z%ej%je%_dWdFdG„Z&ej&je&_dHdI„Z'ej'je'_dXdJdK„Z(ej(je(_dLdM„Z)ej)je)_dNdO„Z*ej*je*_dS)Yrao 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. NéTcCs&tƒ|_||||||dœ|_d|_dS)N)ÚnameÚ descriptionÚmetadataÚaddrÚportÚcallable)rÚhubÚclient_argumentsÚclient)Úselfrrrr r r ©rú=lib/python3.7/site-packages/astropy/samp/integrated_client.pyÚ__init__/s zSAMPIntegratedClient.__init__cCs|jjo|jjS)zØ 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. )r Ú is_connectedrÚ is_running)rrrrrHs z!SAMPIntegratedClient.is_connectedécCs:|j |||¡t|jf|jŽ|_|j ¡|j ¡dS)aN 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)r Úconnectrr rÚstartÚregister)rr Z hub_paramsZ pool_sizerrrrTs   zSAMPIntegratedClient.connectcCs8|jr4z|j ¡Wd|jjr(|j ¡|j ¡XdS)zw Unregister the client from the current SAMP Hub, stop the client and disconnect from the Hub. N)rrZ unregisterrÚstopr Ú disconnect)rrrrrus  zSAMPIntegratedClient.disconnectcCs |j ¡S)zL Proxy to ``ping`` SAMP Hub method (Standard Profile only). )r Úping)rrrrrƒszSAMPIntegratedClient.pingcCs |j |¡S)z? Proxy to ``declareMetadata`` SAMP Hub method. )rÚdeclare_metadata)rrrrrr‰sz%SAMPIntegratedClient.declare_metadatacCs|j | ¡|¡S)z; Proxy to ``getMetadata`` SAMP Hub method. )r Ú get_metadataÚget_private_key)rÚ client_idrrrrsz!SAMPIntegratedClient.get_metadatacCs|j | ¡|¡S)z@ Proxy to ``getSubscriptions`` SAMP Hub method. )r Úget_subscriptionsr)rrrrrr •sz&SAMPIntegratedClient.get_subscriptionscCs|j | ¡¡S)z” Proxy to ``getRegisteredClients`` SAMP Hub method. This returns all the registered clients, excluding the current client. )r Úget_registered_clientsr)rrrrr!›sz+SAMPIntegratedClient.get_registered_clientscCs|j | ¡|¡S)zD Proxy to ``getSubscribedClients`` SAMP Hub method. )r Úget_subscribed_clientsr)rÚmtyperrrr"£sz+SAMPIntegratedClient.get_subscribed_clientscCs>i}d|kr0|d}|d=||dœ}| |¡n ||dœ}|S)NZ extra_kws)z samp.mtypez samp.params)Úupdate)rr#ÚparamsÚmsgZextrarrrÚ_format_easy_msg©s   z%SAMPIntegratedClient._format_easy_msgcCs|j | ¡||¡S)z6 Proxy to ``notify`` SAMP Hub method. )r Únotifyr)rÚ recipient_idÚmessagerrrr(·szSAMPIntegratedClient.notifycKs| || ||¡¡S)a9 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')rr)r#r%rrrÚenotify½szSAMPIntegratedClient.enotifycCs|j | ¡|¡S)z9 Proxy to ``notifyAll`` SAMP Hub method. )r Ú notify_allr)rr*rrrr,ÞszSAMPIntegratedClient.notify_allcKs| | ||¡¡S)a 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')rr#r%rrrÚ enotify_alläsz SAMPIntegratedClient.enotify_allcCs|j | ¡|||¡S)z4 Proxy to ``call`` SAMP Hub method. )r Úcallr)rr)Úmsg_tagr*rrrr.szSAMPIntegratedClient.callcKs| ||| ||¡¡S)a‚ 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"}) )r.r')rr)r/r#r%rrrÚecall s$zSAMPIntegratedClient.ecallcCs|j | ¡||¡S)z7 Proxy to ``callAll`` SAMP Hub method. )r Úcall_allr)rr/r*rrrr1/szSAMPIntegratedClient.call_allcKs| || ||¡¡dS)a[ 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)r1r')rr/r#r%rrrÚ ecall_all5s zSAMPIntegratedClient.ecall_allcCs|j | ¡|||¡S)z; Proxy to ``callAndWait`` SAMP Hub method. )r Ú call_and_waitr)rr)r*Útimeoutrrrr3Wsz"SAMPIntegratedClient.call_and_waitcKs| || ||¡|¡S)aš 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"}) )r3r')rr)r#r4r%rrrÚecall_and_wait]s#z#SAMPIntegratedClient.ecall_and_waitcCs|j | ¡||¡S)z5 Proxy to ``reply`` SAMP Hub method. )r Úreplyr)rÚmsg_idÚresponserrrr6‚szSAMPIntegratedClient.replycCs8d|i}|dk r| d|i¡|dk r4| d|i¡|S)Nz samp.statusz samp.resultz samp.error)r$)rÚstatusÚresultÚerrorr&rrrÚ_format_easy_responseˆs z*SAMPIntegratedClient._format_easy_responsecCs| || |||¡¡S)aa 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"}) )r6r<)rr7r9r:r;rrrÚereply’szSAMPIntegratedClient.ereplycCs|j |||¡S)N)rÚreceive_notification)rÚ private_keyÚ sender_idr*rrrr>³sz)SAMPIntegratedClient.receive_notificationcCs|j ||||¡S)N)rÚ receive_call)rr?r@r7r*rrrrA¸sz!SAMPIntegratedClient.receive_callcCs|j ||||¡S)N)rÚreceive_response)rr?Z responder_idr/r8rrrrB½sz%SAMPIntegratedClient.receive_responsecCs|jj||ddddS)NT)Údeclarer)rÚbind_receive_message)rr#ÚfunctionrCrrrrrDÂsz)SAMPIntegratedClient.bind_receive_messagecCs|j ||||¡dS)N)rÚbind_receive_notification)rr#rErCrrrrrFÇsz.SAMPIntegratedClient.bind_receive_notificationcCs|j ||||¡dS)N)rÚbind_receive_call)rr#rErCrrrrrGÌsz&SAMPIntegratedClient.bind_receive_callcCs|j ||¡dS)N)rÚbind_receive_response)rr/rErrrrHÑsz*SAMPIntegratedClient.bind_receive_responsecCs|j ||¡dS)N)rÚunbind_receive_notification)rr#rCrrrrIÖsz0SAMPIntegratedClient.unbind_receive_notificationcCs|j ||¡dS)N)rÚunbind_receive_call)rr#rCrrrrJÛsz(SAMPIntegratedClient.unbind_receive_callcCs|j |¡dS)N)rÚunbind_receive_response)rr/rrrrKàsz,SAMPIntegratedClient.unbind_receive_responsecCs|j |¡dS)N)rÚdeclare_subscriptions)rZ subscriptionsrrrrLåsz*SAMPIntegratedClient.declare_subscriptionscCs |j ¡S)N)rr)rrrrrêsz$SAMPIntegratedClient.get_private_keycCs |j ¡S)N)rÚ get_public_id)rrrrrMïsz"SAMPIntegratedClient.get_public_id)NNNNrT)NNr)NN)TN)TN)TN)T)T)N)+Ú__name__Ú __module__Ú __qualname__Ú__doc__rÚpropertyrrrrrrr r!r"r'r(r+r,r-r.r0r1r2r3r5r6r<r=r>rrArBrDrFrGrHrIrJrKrLrrMrrrrr sh!  !!&"% !                  N)rrZ hub_proxyrÚ__all__Z__doctest_skip__rrrrrÚs