IR-e^CDddlmZddlmZdgZdgZGddZdS)) SAMPClient) SAMPHubProxySAMPIntegratedClientzSAMPIntegratedClient.*ceZdZdZ d+dZedZd,dZd Zd Z d Z d Z d Z dZ dZdZdZdZdZdZdZdZdZdZdZdZdZdZd-dZdZejje_dZejje_d Z ej je _d.d!Z!ej!je!_d.d"Z"ej"je"_d.d#Z#ej#je#_d$Z$ej$je$_d/d%Z%ej%je%_d/d&Z&ej&je&_d'Z'ej'je'_d0d(Z(ej(je(_d)Z)ej)je)_d*Z*ej*je*_dS)1rao 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. NTcXt|_||||||d|_ d|_dS)N)name descriptionmetadataaddrportcallable)rhubclient_argumentsclient)selfr r r r r rs >lib/python3.11/site-packages/astropy/samp/integrated_client.py__init__zSAMPIntegratedClient.__init__/sF >>&  ! !   99c2|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_runningrs rrz!SAMPIntegratedClient.is_connectedNsx$?)??rc|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)rconnectrrrstartregister)rr hub_params pool_sizes rrzSAMPIntegratedClient.connectZsj& j)444!CCT-BCC   rcN|jr |j|jjr|j|jdS#|jjr|j|jwxYwdS)zw Unregister the client from the current SAMP Hub, stop the client and disconnect from the Hub. N)rr unregisterrstopr disconnectrs rr$zSAMPIntegratedClient.disconnectxs   & & &&(((;)'K$$&&&##%%%%%;)'K$$&&&##%%%%  & &s A""AB"c4|jS)zL Proxy to ``ping`` SAMP Hub method (Standard Profile only). )rpingrs rr&zSAMPIntegratedClient.pingsx}}rc6|j|S)z? Proxy to ``declareMetadata`` SAMP Hub method. )rdeclare_metadata)rr s rr(z%SAMPIntegratedClient.declare_metadatas{++H555rc\|j||S)z; Proxy to ``getMetadata`` SAMP Hub method. )r get_metadataget_private_keyr client_ids rr*z!SAMPIntegratedClient.get_metadatas(x$$T%9%9%;%;YGGGrc\|j||S)z@ Proxy to ``getSubscriptions`` SAMP Hub method. )rget_subscriptionsr+r,s rr/z&SAMPIntegratedClient.get_subscriptionss(x))$*>*>*@*@)LLLrcZ|j|S)z Proxy to ``getRegisteredClients`` SAMP Hub method. This returns all the registered clients, excluding the current client. )rget_registered_clientsr+rs rr1z+SAMPIntegratedClient.get_registered_clientss& x..t/C/C/E/EFFFrc\|j||S)zD Proxy to ``getSubscribedClients`` SAMP Hub method. )rget_subscribed_clientsr+)rmtypes rr3z+SAMPIntegratedClient.get_subscribed_clientss(x..t/C/C/E/EuMMMrchi}d|vr&|d}|d=||d}||n||d}|S)N extra_kws)z samp.mtypez samp.paramsupdate)rr4paramsmsgextras r_format_easy_msgz%SAMPIntegratedClient._format_easy_msgsX & ;'E{#!&v>>C JJu    !&v>>C rc^|j|||S)z6 Proxy to ``notify`` SAMP Hub method. )rnotifyr+)r recipient_idmessages rr>zSAMPIntegratedClient.notifys(xt3355|WMMMrc V|||||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?r4r9s renotifyzSAMPIntegratedClient.enotifys(>{{<)>)>uf)M)MNNNrc\|j||S)z9 Proxy to ``notifyAll`` SAMP Hub method. )r notify_allr+)rr@s rrDzSAMPIntegratedClient.notify_alls(x""4#7#7#9#97CCCrc T||||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"}) )rDr<)rr4r9s r enotify_allz SAMPIntegratedClient.enotify_alls&:t44UFCCDDDrc`|j||||S)z4 Proxy to ``call`` SAMP Hub method. )rcallr+)rr?msg_tagr@s rrHzSAMPIntegratedClient.calls*x}}T1133\7GTTTrc X||||||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"}) )rHr<)rr?rIr4r9s recallzSAMPIntegratedClient.ecall s+Fyyw0E0EeV0T0TUUUrc^|j|||S)z7 Proxy to ``callAll`` SAMP Hub method. )rcall_allr+)rrIr@s rrMzSAMPIntegratedClient.call_all0s*x  !5!5!7!7'JJJrc Z|||||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)rMr<)rrIr4r9s r ecall_allzSAMPIntegratedClient.ecall_all6s/@ gt44UFCCDDDDDrc`|j||||S)z; Proxy to ``callAndWait`` SAMP Hub method. )r call_and_waitr+)rr?r@timeouts rrQz"SAMPIntegratedClient.call_and_waitXs3x%%  " "L'7   rc X||||||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"}) )rQr<)rr?r4rRr9s recall_and_waitz#SAMPIntegratedClient.ecall_and_wait`s4F!! $//v>>   rc^|j|||S)z5 Proxy to ``reply`` SAMP Hub method. )rreplyr+)rmsg_idresponses rrVzSAMPIntegratedClient.replys(x~~d2244fhGGGrcrd|i}||d|i||d|i|S)Nz samp.statusz samp.resultz samp.errorr7)rstatusresulterrorr:s r_format_easy_responsez*SAMPIntegratedClient._format_easy_responsesKf%   JJ v. / / /   JJ e, - - - rcX||||||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"}) )rVr])rrWrZr[r\s rereplyzSAMPIntegratedClient.ereplys*:zz&$"<"rBrDrFrHrKrMrOrQrTrVr]r_rbrrfrhrlrprrrtrvryr{r}r+rrrrr s  H  ::::> @ @X @< & & & 666 HHH MMM GGGNNN   NNN OOOBDDD EEE>UUU #V#V#VJKKK E E ED   % % % NHHH UUUUBQQQ$.#B#J QQQ&2:L   *:BWWWW$.#B#J RRRR)3(L(T%JJJJ!+ < D===%/$D$L!@@@@+5*P*X'8888#-"@"H555'1&H&P#9999%/$D$L!---)8@O+++'4rsx###### ! ",-l=l=l=l=l=l=l=l=l=l=r