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
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
|
/*
* SPDX-FileCopyrightText: All Contributors to the PyTango project
*
* SPDX-License-Identifier: LGPL-3.0-or-later
*/
#include "common_header.h"
#include "convertors/type_casters.h"
void export_dserver(py::module &m) {
py::class_<Tango::DServer, LeakingSmartPtr<Tango::DServer>, Tango::Device_6Impl>(m, "DServer")
.def("query_class",
&Tango::DServer::query_class,
R"doc(
query_class(self) -> list[str]
Command to read all the classes used in a device server process
:return: The class name list in a strings sequence
:rtype: list[str])doc")
.def("query_device",
&Tango::DServer::query_device,
R"doc(
query_device(self) -> list[str]
Command to read all the devices implemented by a device server process
:return: The device name list in a strings sequence
:rtype: list[str])doc")
.def("query_sub_device",
&Tango::DServer::query_sub_device,
R"doc(
query_sub_device(self) -> list[str]
Command to read all the sub devices used by a device server process
:return: The sub device name list in a sequence of strings
:rtype: list[str])doc")
.def("kill",
&Tango::DServer::kill,
R"doc(
kill(self) -> KillThread
Command to kill the device server process. This is done by starting a thread which will kill the process.
Starting a thread allows the client to receive something from the server before it is killed
:return: killing thread
:rtype: KillThread)doc")
.def("restart",
py::overload_cast<const std::string &>(&Tango::DServer::restart),
R"doc(
restart(self, d_name) -> None
Command to restart a device
:param d_name: The device name to be re-started
:type d_name: str)doc",
py::arg("d_name"))
.def("restart_server",
&Tango::DServer::restart_server,
R"doc(
restart_server(self) -> None
Command to restart a server (all devices embedded within the server))
doc")
.def("query_class_prop",
&Tango::DServer::query_class_prop,
R"doc(
query_class_prop(self) -> list[str]
Command to return the list of property device at class level for the specified class
:return: the list of property device
:rtype: list[str])doc")
.def("query_dev_prop",
&Tango::DServer::query_dev_prop,
R"doc(
query_dev_prop(self) -> list[str]
Command to return the list of property device at device level for the specified class
:return: the list of property device
:rtype: list[str])doc")
.def("polled_device",
&Tango::DServer::polled_device,
R"doc(
polled_device(self) -> list[str]
Command to read all the devices actually polled by the device server
:return: The device name list in a strings sequence
:rtype: list[str])doc")
.def("dev_poll_status",
&Tango::DServer::dev_poll_status,
R"doc(
dev_poll_status(self, dev_name) -> list[str]
Command to read device polling status
:param dev_name: The device name
:type dev_name: str
:return: The device polling status as a string (multiple lines)
:rtype: list[str])doc")
.def("add_obj_polling",
&Tango::DServer::add_obj_polling,
R"doc(
add_obj_polling(self, argin, with_db_upd, delta_ms) -> None
command to add one object to be polled
:param argin:
The polling parameters, as a sequence of two sequences.
First, a list of integers, index 0: update period in milliseconds.
Second, a list of strings:
index 0: device name,
index 1: object type, either "command" or "attribute",
index 2: object name.
Example: ([2000], ["sys/tg_test/1", "attribute", "double_scalar"])
:type argin: tuple[list[int], list[str]]
:param with_db_upd: set to true if db has to be updated
:type with_db_upd: bool
:param delta_ms:
:type delta_ms: int)doc",
py::arg("argin"),
py::arg("with_db_upd") = true,
py::arg("delta_ms") = 0)
.def("upd_obj_polling_period",
&Tango::DServer::upd_obj_polling_period,
R"doc(
upd_obj_polling_period(self, argin, with_db_upd) -> None
command to update an already polled object update period
:param argin:
The polling parameters, as a sequence of two sequences.
First, a list of integers, index 0: update period in milliseconds.
Second, a list of strings:
index 0: device name,
index 1: object type, either "command" or "attribute",
index 2: object name.
Example: ([2000], ["sys/tg_test/1", "attribute", "double_scalar"])
:type argin: tuple[list[int], list[str]]
:param with_db_upd: set to true if db has to be updated
:type with_db_upd: bool)doc",
py::arg("argin"),
py::arg("with_db_upd") = true)
.def("rem_obj_polling",
&Tango::DServer::rem_obj_polling,
R"doc(
rem_obj_polling(self, argin, with_db_upd) -> None
command to remove an already polled object from the device polled object list
:param argin: The polling parameters: device name; object type (command or attribute); object name
:type argin: list[str]
:param with_db_upd: set to true if db has to be updated
:type with_db_upd: bool)doc",
py::arg("argin"),
py::arg("with_db_upd") = true)
.def("stop_polling",
&Tango::DServer::stop_polling,
R"doc(
stop_polling(self) -> None
Command to stop the polling thread)doc")
.def("start_polling",
py::overload_cast<>(&Tango::DServer::start_polling),
R"doc(
start_polling(self) -> None
Command to start the polling thread)doc")
.def("add_event_heartbeat",
&Tango::DServer::add_event_heartbeat,
R"doc(
add_event_heartbeat(self) -> None
Command to ask the heartbeat thread to send the event heartbeat every 9 seconds)doc")
.def("rem_event_heartbeat",
&Tango::DServer::rem_event_heartbeat,
R"doc(
rem_event_heartbeat(self) -> None
Command to ask the heartbeat thread to stop sending the event heartbeat)doc")
.def("lock_device",
&Tango::DServer::lock_device,
R"doc(
lock_device(self, in_data: tuple[list[int], list[str]]) -> None
command to lock device
:param in_data: a structure with: (lock validity, name of the device(s) to be locked,)
:type in_data: tuple[list[int], list[str]])doc",
py::arg("in_data"))
.def("un_lock_device",
&Tango::DServer::un_lock_device,
R"doc(
un_lock_device(self, in_data: tuple[list[int], list[str]]) -> int
command to unlock device
:param in_data: a structure with: (lock validity, name of the device(s) to be unlocked)
:type in_data: tuple[list[int], list[str]]
:return:
:rtype: int)doc",
py::arg("in_data"))
.def("re_lock_devices",
&Tango::DServer::re_lock_devices,
R"doc(
un_lock_device(self, in_data: tuple[list[int], list[str]]) -> None
command to relock device
:param in_data: a structure with: (lock validity, name of the device(s) to be relocked)
:type in_data: tuple[list[int], list[str]])doc",
py::arg("in_data"))
.def("dev_lock_status",
&Tango::DServer::dev_lock_status,
R"doc(
dev_lock_status(self, dev_name: str) -> tuple[list[int], list[str]]
command to get device lock status
:param dev_name: device name
:type dev_name: str
:return: device lock status
:rtype: tuple[list[int], list[str]])doc",
py::arg("dev_name"))
.def("delete_devices",
&Tango::DServer::delete_devices,
R"doc(
delete_devices(self) -> None
Call destructor for all objects registered in the server)doc")
.def("start_logging", &Tango::DServer::start_logging)
.def("stop_logging", &Tango::DServer::stop_logging)
.def("get_process_name", &Tango::DServer::get_process_name)
.def("get_personal_name", &Tango::DServer::get_personal_name)
.def("get_instance_name", &Tango::DServer::get_instance_name)
.def("get_full_name", &Tango::DServer::get_full_name)
.def("get_fqdn", &Tango::DServer::get_fqdn)
.def("get_poll_th_pool_size", &Tango::DServer::get_poll_th_pool_size)
.def("get_opt_pool_usage", &Tango::DServer::get_opt_pool_usage)
.def("get_poll_th_conf", &Tango::DServer::get_poll_th_conf);
}
|
