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
|
# Server green modes
PyTango server API from version 9.2.0 supports two green modes:
{obj}`~tango.GreenMode.Gevent` and {obj}`~tango.GreenMode.Asyncio`.
Both can be used in writing new device servers in an asynchronous way.
:::{note}
If your device server has multiple devices they must all use
the same green mode.
:::
(green-modes-no-sync-warning)=
:::{warning}
These green modes disable Tango's [device server serialisation](https://tango-controls.readthedocs.io/en/latest/development/advanced/threading.html#serialization-model-within-a-device-server),
i.e., {obj}`tango.SerialModel.NO_SYNC` is automatically passed to {func}`tango.Util.set_serial_model`,
when the device server starts. From those docs: "This is an exotic kind of serialization and
should be used with **extreme care** only with devices which are fully thread safe."
:::
## gevent mode
This mode lets you convert your existing devices to asynchronous devices
easily. You just add `green_mode = tango.GreenMode.Gevent` line to your device
class. Consider this example:
```
class GeventDevice(Device):
green_mode = tango.GreenMode.Gevent
```
Every method in your device class will be treated as a
coroutine implicitly. This can be beneficial, but also potentially dangerous
as it is a lot harder to debug. You should use this green mode with care.
{obj}`~tango.GreenMode.Gevent` green mode is useful when you don't want to
change too much in your existing code (or you don't feel comfortable with
writing syntax of asynchronous calls).
Another thing to keep in mind is that when using {obj}`~tango.GreenMode.Gevent`
green mode is that the Tango monitor lock is disabled, so the client requests can
be processed concurrently.
Greenlets can also be used to spawn tasks in the background.
(server-green-mode-asyncio)=
## asyncio mode
The way asyncio green mode on the server side works is it redirects all user
code to an event loop. This means that all user methods become coroutines, so
in Python > 3.5 you should define them with `async` keyword.
This also means that in order to convert existing code of your devices
to {obj}`~tango.GreenMode.Asyncio` green mode you will have to introduce
at least those changes. But, of course, to truly benefit from this green mode
(and asynchronous approach in general), you should introduce more far-fetched changes!
The main benefit of asynchronous programing approach is that it lets you
control precisely when code is run sequentially without interruptions and
when control can be given back to the event loop. It's especially useful
if you want to perform some long operations and don't want to prevent clients
from accessing other parts of your device (attributes, in particular). This
means that in {obj}`~tango.GreenMode.Asyncio` green mode there is no monitor
lock!
The example below shows how asyncio can be used to write an asynchronous
Tango device:
```{literalinclude} ../../../examples/asyncio_green_mode/asyncio_device_example.py
:linenos: true
```
|
