m0_clink Struct Reference
#include <chan.h>
Collaboration diagram for m0_clink:
Data Fields | |
| struct m0_chan * | cl_chan |
| m0_chan_cb_t | cl_cb |
| struct m0_clink * | cl_group |
| struct m0_tlink | cl_linkage |
| struct m0_semaphore | cl_wait |
| bool | cl_is_oneshot |
| uint64_t | cl_magic |
Detailed Description
A record of interest in events on a stream.
A clink records the appearance of events in the stream.
There are two ways to use a clink:
- an asynchronous call-back can be specified as an argument to clink constructor m0_clink_init(). This call-back is called when an event happens in the channel the clink is registered with. It is guaranteed that a call-back is executed in the same context where event producer declared new event. A per-channel mutex m0_chan::ch_guard is held while call-backs are executed (except the case when m0_clink_signal() is used by producer).
- once a clink is registered with a channel, it is possible to wait until an event happens by calling m0_chan_wait().
See the "Filtered wake-ups" section in the top-level comment on how to combine call-backs with waiting.
Concurrency control
A user must guarantee that at most one thread waits on a clink. Synchronization between call-backs, waits and clink destruction is also up to user.
A user owns a clink before call to m0_clink_add() and after return from the m0_clink_del() call. At any other time clink can be concurrently accessed by the implementation.
Liveness
A user is free to dispose a clink whenever it owns the latter.
Field Documentation
◆ cl_cb
| m0_chan_cb_t cl_cb |
◆ cl_chan
| struct m0_chan* cl_chan |
◆ cl_group
◆ cl_is_oneshot
◆ cl_linkage
| struct m0_tlink cl_linkage |
Linkage into m0_chan::ch_links
◆ cl_magic
◆ cl_wait
| struct m0_semaphore cl_wait |
The documentation for this struct was generated from the following file:
- lib/chan.h
