distributed 2021.10.0

ParametersBackRef

An event stores a single flag, which is set to false on start. The flag can be set to true (using the set() call) or back to false (with the clear() call). Every call to wait() blocks until the event flag is set to true.

Parameters

name: string (optional) :

Name of the event. Choosing the same name allows two disconnected processes to coordinate an event. If not given, a random name will be generated.

client: Client (optional) :

Client to use for communication with the scheduler. If not given, the default global client will be used.

Distributed Centralized Event equivalent to asyncio.Event

Examples

This example is valid syntax, but we were not able to check execution
>>> event_1 = Event('a')  # doctest: +SKIP
... event_1.wait(timeout=1) # doctest: +SKIP
... # in another process
... event_2 = Event('a') # doctest: +SKIP
... event_2.set() # doctest: +SKIP
... # now event_1 will stop waiting
See :

Back References

The following pages refer to to this document either explicitly or contain code examples using this.

distributed.event.Event.wait distributed.event.Event

Local connectivity graph

Hover to see nodes names; edges to Self not shown, Caped at 50 nodes.

Using a canvas is more power efficient and can get hundred of nodes ; but does not allow hyperlinks; , arrows or text (beyond on hover)

SVG is more flexible but power hungry; and does not scale well to 50 + nodes.

All aboves nodes referred to, (or are referred from) current nodes; Edges from Self to other have been omitted (or all nodes would be connected to the central node "self" which is not useful). Nodes are colored by the library they belong to, and scaled with the number of references pointing them


File: /distributed/event.py#153
type: <class 'type'>
Commit: