1CPG_MCAST_JOINED(3)Corosync Cluster Engine Programmer's ManuaClPG_MCAST_JOINED(3)
2
3
4

NAME

6       cpg_mcast_joined - Multicasts to all groups joined to a handle
7

SYNOPSIS

9       #include <sys/uio.h> #include <corosync/cpg.h>
10
11       int  cpg_mcast_joined(cpg_handle_t  handle,  cpg_guarantee_t guarantee,
12       struct iovec *iovec, int iov_len);
13

DESCRIPTION

15       The cpg_mcast_joined function will multicast a message to all the  pro‐
16       cesses that have been joined with the cpg_join(3) function for the same
17       group name.  Messages that are sent to any of the groups joined to  the
18       parameter  handle  will be delivered to all subscribed processes in the
19       system.
20
21       The argument guarantee requests a delivery guarantee for the message to
22       be sent.  The cpg_guarantee_t type is defined by:
23
24              typedef enum {
25                      CPG_TYPE_UNORDERED,     /* not implemented */
26                      CPG_TYPE_FIFO,          /* same as agreed */
27                      CPG_TYPE_AGREED,        /* implemented */
28                      CPG_TYPE_SAFE           /* not implemented */
29              } cpg_guarantee_t;
30
31       The meanings of the cpg_guarantee_t typedef are:
32
33       CPG_TYPE_UNORDERED
34              Messages  are guaranteed to be delivered, but with no particular
35              order.  This mode is unimplemented in the CPG library.
36
37       CPG_TYPE_FIFO
38              Messages are guaranteed to be  delivered  in  first  sent  first
39              delivery  order.   In  fact, this guarantee is equivalent to the
40              CPG_TYPE_AGREED guarantee.
41
42       CPG_TYPE_AGREED
43              All processors must agree on the order of delivery.  If  a  mes‐
44              sage  is sent from two or more processes at about the same time,
45              the delivery will occur in the same order to all processes.
46
47       CPG_TYPE_SAFE
48              All processes must agree on the order of delivery.  Further  all
49              processes  must  have  a copy of the message before any delivery
50              takes place.  This mode is unimplemented in the CPG library.
51
52       The iovec argument describes the scatter/gather list which is  used  to
53       transmit a message.  This is a iovec described by:
54
55              struct iovec
56              {
57                      void *iov_base;     /* Pointer to data.  */
58                      unsigned int iov_len;     /* Length of data.  */
59              };
60
61       The iov_len argument describes the number of entires in the iovec argu‐
62       ment.
63
64

RETURN VALUE

66       This call returns the CPG_OK value if successful, otherwise an error is
67       returned.
68

ERRORS

70       The errors are undocumented.
71

SEE ALSO

73       cpg_overview(8),   cpg_initialize(3),  cpg_finalize(3),  cpg_fd_get(3),
74       cpg_dispatch(3),   cpg_join(3),   cpg_leave(3),    cpg_mcast_joined(3),
75       cpg_membership_get(3)          cpg_zcb_alloc(3)         cpg_zcb_free(3)
76       cpg_zcb_mcast_joined(3)      cpg_context_get(3)      cpg_context_set(3)
77       cpg_local_get(3)
78
79
80corosync Man Page                 3004-08-31               CPG_MCAST_JOINED(3)
Impressum