a ߙfbC@s6ddlmZddlmZdgZdgZGdddZdS)) SAMPClient) SAMPHubProxySAMPIntegratedClientzSAMPIntegratedClient.*c@seZdZdZdPddZeddZdQd d Zd d ZddZ ddZ ddZ ddZ ddZ ddZddZddZddZd d!Zd"d#Zd$d%Zd&d'Zd(d)Zd*d+Zd,d-Zd.d/Zd0d1Zd2d3ZdRd4d5Zd6d7Zejje_d8d9Zejje_d:d;Z ej je _dSdd?Z"ej"je"_dUd@dAZ#ej#je#_dBdCZ$ej$je$_dVdDdEZ%ej%je%_dWdFdGZ&ej&je&_dHdIZ'ej'je'_dXdJdKZ(ej(je(_dLdMZ)ej)je)_dNdOZ*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. NTcCs&t|_||||||d|_d|_dS)N)name descriptionmetadataaddrportcallable)rhubclient_argumentsclient)selfrrrr r r r=lib/python3.9/site-packages/astropy/samp/integrated_client.py__init__/szSAMPIntegratedClient.__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_runningrrrrrHs z!SAMPIntegratedClient.is_connectedcCs>|j|||t|jfi|j|_|j|jdS)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 rstartregister)rr Z hub_paramsZ pool_sizerrrrTs zSAMPIntegratedClient.connectcCsT|jrPz*|jW|jjr&|j|jn|jjrD|j|j0dS)zw Unregister the client from the current SAMP Hub, stop the client and disconnect from the Hub. N)rrZ unregisterrstopr disconnectrrrrrus    zSAMPIntegratedClient.disconnectcCs |jS)zL Proxy to ``ping`` SAMP Hub method (Standard Profile only). )r pingrrrrrszSAMPIntegratedClient.pingcCs |j|S)z? Proxy to ``declareMetadata`` SAMP Hub method. )rdeclare_metadata)rrrrrrsz%SAMPIntegratedClient.declare_metadatacCs|j||S)z; Proxy to ``getMetadata`` SAMP Hub method. )r get_metadataget_private_keyrZ client_idrrrrsz!SAMPIntegratedClient.get_metadatacCs|j||S)z@ Proxy to ``getSubscriptions`` SAMP Hub method. )r get_subscriptionsrr rrrr!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_clientsrrrrrr"sz+SAMPIntegratedClient.get_registered_clientscCs|j||S)zD Proxy to ``getSubscribedClients`` SAMP Hub method. )r get_subscribed_clientsr)rmtyperrrr#sz+SAMPIntegratedClient.get_subscribed_clientscCs>i}d|vr0|d}|d=||d}||n ||d}|S)NZ extra_kws)z samp.mtypez samp.paramsupdate)rr$paramsmsgZextrarrr_format_easy_msgs   z%SAMPIntegratedClient._format_easy_msgcCs|j|||S)z6 Proxy to ``notify`` SAMP Hub method. )r notifyr)r recipient_idmessagerrrr*szSAMPIntegratedClient.notifycKs|||||S)a4 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 str 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'rrrenotifyszSAMPIntegratedClient.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 str 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_allsz SAMPIntegratedClient.enotify_allcCs|j||||S)z4 Proxy to ``call`` SAMP Hub method. )r callr)rr+msg_tagr,rrrr0szSAMPIntegratedClient.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 str 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"}) )r0r))rr+r1r$r'rrrecall s$zSAMPIntegratedClient.ecallcCs|j|||S)z7 Proxy to ``callAll`` SAMP Hub method. )r call_allr)rr1r,rrrr3/szSAMPIntegratedClient.call_allcKs|||||dS)aV 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 str 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)r3r))rr1r$r'rrr ecall_all5s zSAMPIntegratedClient.ecall_allcCs|j||||S)z; Proxy to ``callAndWait`` SAMP Hub method. )r call_and_waitr)rr+r,timeoutrrrr5Wsz"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 str 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"}) )r5r))rr+r$r6r'rrrecall_and_wait]s#z#SAMPIntegratedClient.ecall_and_waitcCs|j|||S)z5 Proxy to ``reply`` SAMP Hub method. )r replyr)rmsg_idresponserrrr8szSAMPIntegratedClient.replycCs8d|i}|dur|d|i|dur4|d|i|S)Nz samp.statusz samp.resultz samp.errorr%)rstatusresulterrorr(rrr_format_easy_responses 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"}) )r8r>)rr9r;r<r=rrrereplyszSAMPIntegratedClient.ereplycCs|j|||SN)rreceive_notification)r private_key sender_idr,rrrrAsz)SAMPIntegratedClient.receive_notificationcCs|j||||Sr@)r receive_call)rrBrCr9r,rrrrDsz!SAMPIntegratedClient.receive_callcCs|j||||Sr@)rreceive_response)rrBZ responder_idr1r:rrrrEsz%SAMPIntegratedClient.receive_responsecCs|jj||ddddS)NT)declarer)rbind_receive_messagerr$functionrFrrrrrGsz)SAMPIntegratedClient.bind_receive_messagecCs|j||||dSr@)rbind_receive_notificationrHrrrrJsz.SAMPIntegratedClient.bind_receive_notificationcCs|j||||dSr@)rbind_receive_callrHrrrrKsz&SAMPIntegratedClient.bind_receive_callcCs|j||dSr@)rbind_receive_response)rr1rIrrrrLsz*SAMPIntegratedClient.bind_receive_responsecCs|j||dSr@)runbind_receive_notificationrr$rFrrrrMsz0SAMPIntegratedClient.unbind_receive_notificationcCs|j||dSr@)runbind_receive_callrNrrrrOsz(SAMPIntegratedClient.unbind_receive_callcCs|j|dSr@)runbind_receive_response)rr1rrrrPsz,SAMPIntegratedClient.unbind_receive_responsecCs|j|dSr@)rdeclare_subscriptions)rZ subscriptionsrrrrQsz*SAMPIntegratedClient.declare_subscriptionscCs |jSr@)rrrrrrrsz$SAMPIntegratedClient.get_private_keycCs |jSr@)r get_public_idrrrrrRsz"SAMPIntegratedClient.get_public_id)NNNNrT)NNr)NN)TN)TN)TN)T)T)N)+__name__ __module__ __qualname____doc__rpropertyrrrrrrr!r"r#r)r*r-r.r/r0r2r3r4r5r7r8r>r?rArrDrErGrJrKrLrMrOrPrQrrRrrrrr sl"  !!&"% !                  N)rrZ hub_proxyr__all__Z__doctest_skip__rrrrrs