1CPG_ZCB_MCAST_JOINECDo(r3o)sync Cluster Engine Programmer's MCaPnGu_aZlCB_MCAST_JOINED(3)
2
3
4

NAME

6       cpg_mcast_joined  -  Multicasts a zero copy buffer to all groups joined
7       to a handle
8

SYNOPSIS

10       #include <sys/uio.h> #include <corosync/cpg.h>
11
12       int cpg_zcb_mcast_joined(cpg_handle_t handle,  cpg_guarantee_t  guaran‐
13       tee, const void *buffer,int msg_len );
14

DESCRIPTION

16       The  cpg_zcb_mcast_joined  function  will  multicast a zero copy buffer
17       message to all the processes that have been joined with the cpg_join(3)
18       funtion  for the same group name.  Messages that are sent to any of the
19       groups joined to the parameter handle will be  delivered  to  all  sub‐
20       scribed processes in the system.
21
22       The argument guarantee requests a delivery guarantee for the message to
23       be sent.  The cpg_guarantee_t type is defined by:
24
25              typedef enum {
26                      CPG_TYPE_UNORDERED,     /* not implemented */
27                      CPG_TYPE_FIFO,          /* same as agreed */
28                      CPG_TYPE_AGREED,        /* implemented */
29                      CPG_TYPE_SAFE           /* not implemented */
30              } cpg_guarantee_t;
31
32       The meanings of the cpg_guarantee_t typedef are:
33
34       CPG_TYPE_UNORDERED
35              Messages are guaranteed to be delivered, but with no  particular
36              order.  This mode is unimplemented in the CPG library.
37
38       CPG_TYPE_FIFO
39              Messages  are  guaranteed  to  be  delivered in first sent first
40              delivery order.  In fact, this guarantee is  equivalent  to  the
41              CPG_TYPE_AGREED guarantee.
42
43       CPG_TYPE_AGREED
44              All  processors  must agree on the order of delivery.  If a mes‐
45              sage is sent from two or more processes at about the same  time,
46              the delivery will occur in the same order to all processes.
47
48       CPG_TYPE_SAFE
49              All  processes must agree on the order of delivery.  Further all
50              processes must have a copy of the message  before  any  delivery
51              takes place.  This mode is unimplemented in the CPG library.
52
53       The msg argument describes the zero copy buffer which is used to trans‐
54       mit a message.  this buffer must be allocated by cpg_zcb_alloc(3).
55
56
57       The msg_len argument describes the number of bytes to be transmitted in
58       the zero copy buffer.
59
60

RETURN VALUE

62       This call returns the CPG_OK value if successful, otherwise an error is
63       returned.
64

ERRORS

66       The errors are undocumented.
67

SEE ALSO

69       cpg_overview(8),  cpg_initialize(3),  cpg_finalize(3),   cpg_fd_get(3),
70       cpg_dispatch(3),    cpg_join(3),   cpg_leave(3),   cpg_mcast_joined(3),
71       cpg_membership_get(3)         cpg_zcb_alloc(3)          cpg_zcb_free(3)
72       cpg_zcb_mcast_joined(3)      cpg_context_get(3)      cpg_context_set(3)
73       cpg_local_get(3)
74
75
76corosync Man Page                 3004-08-31           CPG_ZCB_MCAST_JOINED(3)
Impressum