1EVS_JOIN(3) Openais Programmer's Manual EVS_JOIN(3)
2
3
4
6 evs_join - Joins one or more groups in the EVS library
7
9 #include <openais/evs.h>
10
11 int evs_join(evs_handle_t handle, evs_group_t *groups, int
12 group_entries);
13
15 The evs_join function is used to join one or more groups. When a group
16 is joined, using the evs_mcast_joined(3) function will multicast to the
17 groups joined in the argument handle. Messages that are sent to any of
18 the groups joined to the parameter handle will be delivered by evs_dis‐
19 patch(3).
20
21 This call may be used more then once on a handle, in which case the
22 joined groups will be all of the groups passed to the evs_join(3) func‐
23 tion during the lifecycle of the parameter handle.
24
25 The argument groups is used to specify the groups to join. A group is
26 a 32 byte key. The key is not a string, hence, the entire key is used
27 when joining the channel. For that reason the entire group should be
28 initialized.
29
30 The argument group_entries specifies how many entries are located in
31 the groups argument.
32
33 The groups argument is of the type evs_group_t which is defined by the
34 structure:
35
36
37 typedef struct {
38 char key[32];
39 } evs_groups_t;
40
42 This call returns the EVS_OK value if successful, otherwise an error is
43 returned.
44
46 The errors are undocumented.
47
49 evs_overview(8), evs_initialize(3), evs_finalize(3), evs_fd_get(3),
50 evs_dispatch(3), evs_leave(3), evs_mcast_joined(3),
51 evs_mcast_groups(3), evs_mmembership_get(3)
52
53openais Man Page 2004-08-31 EVS_JOIN(3)