1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
|
.. doctest-skip-all
.. _vo-samp-example_clients:
Communication between Integrated Clients Objects
************************************************
As shown in :doc:`example_table_image`, the |SAMPIntegratedClient| class can be
used to communicate with other SAMP-enabled tools such as `TOPCAT
<http://www.star.bris.ac.uk/~mbt/topcat/>`_, `SAO DS9
<http://ds9.si.edu/>`_, or `Aladin Desktop
<http://aladin.u-strasbg.fr>`_.
In this section, we look at how we can set up two |SAMPIntegratedClient|
instances and communicate between them.
First, start up a SAMP hub as described in :doc:`example_hub`.
Next, we create two clients and connect them to the hub::
>>> from astropy import samp
>>> client1 = samp.SAMPIntegratedClient(name="Client 1", description="Test Client 1",
... metadata = {"client1.version":"0.01"})
>>> client2 = samp.SAMPIntegratedClient(name="Client 2", description="Test Client 2",
... metadata = {"client2.version":"0.25"})
>>> client1.connect()
>>> client2.connect()
We now define functions to call when receiving a notification, call or
response::
>>> def test_receive_notification(private_key, sender_id, mtype, params, extra):
... print("Notification:", private_key, sender_id, mtype, params, extra)
>>> def test_receive_call(private_key, sender_id, msg_id, mtype, params, extra):
... print("Call:", private_key, sender_id, msg_id, mtype, params, extra)
... client1.ereply(msg_id, samp.SAMP_STATUS_OK, result = {"txt": "printed"})
>>> def test_receive_response(private_key, sender_id, msg_id, response):
... print("Response:", private_key, sender_id, msg_id, response)
We subscribe client 1 to ``"samp.app.*"`` and bind it to the
related functions::
>>> client1.bind_receive_notification("samp.app.*", test_receive_notification)
>>> client1.bind_receive_call("samp.app.*", test_receive_call)
We now bind message tags received by client 2 to suitable functions::
>>> client2.bind_receive_response("my-dummy-print", test_receive_response)
>>> client2.bind_receive_response("my-dummy-print-specific", test_receive_response)
We are now ready to test out the clients and callback functions. Client 2
notifies all clients using the "samp.app.echo" message type via the hub::
>>> client2.enotify_all("samp.app.echo", txt="Hello world!")
['cli#2']
Notification: 0d7f4500225981c104a197c7666a8e4e cli#2 samp.app.echo {'txt':
'Hello world!'} {'host': 'antigone.lambrate.inaf.it', 'user': 'unknown'}
We can also find a dictionary that specifies which clients would currently
receive ``samp.app.echo`` messages::
>>> print(client2.get_subscribed_clients("samp.app.echo"))
{'cli#2': {}}
Client 2 calls all clients with the ``"samp.app.echo"`` message type using
``"my-dummy-print"`` as a message-tag::
>>> print(client2.call_all("my-dummy-print",
... {"samp.mtype": "samp.app.echo",
... "samp.params": {"txt": "Hello world!"}}))
{'cli#1': 'msg#1;;cli#hub;;cli#2;;my-dummy-print'}
Call: 8c8eb53178cb95e168ab17ec4eac2353 cli#2
msg#1;;cli#hub;;cli#2;;my-dummy-print samp.app.echo {'txt': 'Hello world!'}
{'host': 'antigone.lambrate.inaf.it', 'user': 'unknown'}
Response: d0a28636321948ccff45edaf40888c54 cli#1 my-dummy-print
{'samp.status': 'samp.ok', 'samp.result': {'txt': 'printed'}}
Client 2 then calls client 1 using the ``"samp.app.echo"`` message type,
tagging the message as ``"my-dummy-print-specific"``::
>>> try:
... print(client2.call(client1.get_public_id(),
... "my-dummy-print-specific",
... {"samp.mtype": "samp.app.echo",
... "samp.params": {"txt": "Hello client 1!"}}))
... except samp.SAMPProxyError as e:
... print("Error ({0}): {1}".format(e.faultCode, e.faultString))
msg#2;;cli#hub;;cli#2;;my-dummy-print-specific
Call: 8c8eb53178cb95e168ab17ec4eac2353 cli#2
msg#2;;cli#hub;;cli#2;;my-dummy-print-specific samp.app.echo {'txt': 'Hello
Cli 1!'} {'host': 'antigone.lambrate.inaf.it', 'user': 'unknown'}
Response: d0a28636321948ccff45edaf40888c54 cli#1 my-dummy-print-specific
{'samp.status': 'samp.ok', 'samp.result': {'txt': 'printed'}}
We can now define a function called to test synchronous calls::
>>> def test_receive_sync_call(private_key, sender_id, msg_id, mtype, params, extra):
... import time
... print("SYNC Call:", sender_id, msg_id, mtype, params, extra)
... time.sleep(2)
... client1.reply(msg_id, {"samp.status": samp.SAMP_STATUS_OK,
... "samp.result": {"txt": "printed sync"}})
We now bind the ``samp.test`` message type to ``test_receive_sync_call``::
>>> client1.bind_receive_call("samp.test", test_receive_sync_call)
>>> try:
... # Sync call
... print(client2.call_and_wait(client1.get_public_id(),
... {"samp.mtype": "samp.test",
... "samp.params": {"txt": "Hello SYNCRO client 1!"}},
... "10"))
... except samp.SAMPProxyError as e:
... # If timeout expires than a SAMPProxyError is returned
... print("Error ({0}): {1}".format(e.faultCode, e.faultString))
SYNC Call: cli#2 msg#3;;cli#hub;;cli#2;;sampy::sync::call samp.test {'txt':
'Hello SYNCRO Cli 1!'} {'host': 'antigone.lambrate.inaf.it', 'user':
'unknown'}
{'samp.status': 'samp.ok', 'samp.result': {'txt': 'printed sync'}}
Finally, we disconnect the clients from the hub at the end::
>>> client1.disconnect()
>>> client2.disconnect()
|
