/usr/share/doc/corosync/html/cpg_zcb_mcast_joined.3.html is in libcpg-dev 2.3.3-1ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 | <!-- Creator : groff version 1.22.2 -->
<!-- CreationDate: Thu Mar 20 15:54:33 2014 -->
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta name="generator" content="groff -Thtml, see www.gnu.org">
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<meta name="Content-Style" content="text/css">
<style type="text/css">
p { margin-top: 0; margin-bottom: 0; vertical-align: top }
pre { margin-top: 0; margin-bottom: 0; vertical-align: top }
table { margin-top: 0; margin-bottom: 0; vertical-align: top }
h1 { text-align: center }
</style>
<title>CPG_ZCB_MCAST_JOINED</title>
</head>
<body>
<h1 align="center">CPG_ZCB_MCAST_JOINED</h1>
<a href="#NAME">NAME</a><br>
<a href="#SYNOPSIS">SYNOPSIS</a><br>
<a href="#DESCRIPTION">DESCRIPTION</a><br>
<a href="#RETURN VALUE">RETURN VALUE</a><br>
<a href="#ERRORS">ERRORS</a><br>
<a href="#SEE ALSO">SEE ALSO</a><br>
<hr>
<h2>NAME
<a name="NAME"></a>
</h2>
<p style="margin-left:11%; margin-top: 1em">cpg_mcast_joined
− Multicasts a zero copy buffer to all groups joined
to a handle</p>
<h2>SYNOPSIS
<a name="SYNOPSIS"></a>
</h2>
<p style="margin-left:11%; margin-top: 1em"><b>#include
<sys/uio.h> #include <corosync/cpg.h></b></p>
<p style="margin-left:11%; margin-top: 1em"><b>int
cpg_zcb_mcast_joined(cpg_handle_t</b> <i>handle</i><b>,
cpg_guarantee_t</b> <i>guarantee</i><b>, const void
*</b><i>buffer,</i><b>int</b> <i>msg_len</i> <b>);</b></p>
<h2>DESCRIPTION
<a name="DESCRIPTION"></a>
</h2>
<p style="margin-left:11%; margin-top: 1em">The
<b>cpg_zcb_mcast_joined</b> function will multicast a zero
copy buffer message to all the processes that have been
joined with the <b>cpg_join(3)</b> funtion for the same
group name. Messages that are sent to any of the groups
joined to the parameter <i>handle</i> will be delivered to
all subscribed processes in the system.</p>
<p style="margin-left:11%; margin-top: 1em">The argument
<i>guarantee</i> requests a delivery guarantee for the
message to be sent. The cpg_guarantee_t type is defined
by:</p>
<p style="margin-left:22%; margin-top: 1em">typedef enum {
<br>
CPG_TYPE_UNORDERED, /* not implemented */ <br>
CPG_TYPE_FIFO, /* same as agreed */ <br>
CPG_TYPE_AGREED, /* implemented */ <br>
CPG_TYPE_SAFE /* not implemented */ <br>
} cpg_guarantee_t;</p>
<p style="margin-left:11%; margin-top: 1em">The meanings of
the cpg_guarantee_t typedef are: <b><br>
CPG_TYPE_UNORDERED</b></p>
<p style="margin-left:22%;">Messages are guaranteed to be
delivered, but with no particular order. This mode is
unimplemented in the CPG library.</p>
<p style="margin-left:11%;"><b>CPG_TYPE_FIFO</b></p>
<p style="margin-left:22%;">Messages are guaranteed to be
delivered in first sent first delivery order. In fact, this
guarantee is equivalent to the CPG_TYPE_AGREED
guarantee.</p>
<p style="margin-left:11%;"><b>CPG_TYPE_AGREED</b></p>
<p style="margin-left:22%;">All processors must agree on
the order of delivery. If a message is sent from two or more
processes at about the same time, the delivery will occur in
the same order to all processes.</p>
<p style="margin-left:11%;"><b>CPG_TYPE_SAFE</b></p>
<p style="margin-left:22%;">All processes must agree on the
order of delivery. Further all processes must have a copy of
the message before any delivery takes place. This mode is
unimplemented in the CPG library.</p>
<p style="margin-left:11%; margin-top: 1em">The <i>msg</i>
argument describes the zero copy buffer which is used to
transmit a message. this buffer must be allocated by
<b>cpg_zcb_alloc(3).</b></p>
<p style="margin-left:11%; margin-top: 1em">The
<i>msg_len</i> argument describes the number of bytes to be
transmitted in the zero copy buffer.</p>
<h2>RETURN VALUE
<a name="RETURN VALUE"></a>
</h2>
<p style="margin-left:11%; margin-top: 1em">This call
returns the CS_OK value if successful, otherwise an error is
returned.</p>
<h2>ERRORS
<a name="ERRORS"></a>
</h2>
<p style="margin-left:11%; margin-top: 1em">The errors are
undocumented.</p>
<h2>SEE ALSO
<a name="SEE ALSO"></a>
</h2>
<p style="margin-left:11%; margin-top: 1em"><b>cpg_overview</b>(8),
<b>cpg_initialize</b>(3), <b>cpg_finalize</b>(3),
<b>cpg_fd_get</b>(3), <b>cpg_dispatch</b>(3),
<b>cpg_join</b>(3), <b>cpg_leave</b>(3),
<b>cpg_mcast_joined</b>(3), <b>cpg_membership_get</b>(3)
<b>cpg_zcb_alloc</b>(3) <b>cpg_zcb_free</b>(3)
<b>cpg_zcb_mcast_joined</b>(3) <b>cpg_context_get</b>(3)
<b>cpg_context_set</b>(3) <b>cpg_local_get</b>(3)</p>
<p style="margin-left:11%; margin-top: 1em"><b>CS_ERR_TRY_AGAIN</b>
Resource temporarily unavailable</p>
<p style="margin-left:11%; margin-top: 1em"><b>CS_ERR_INVALID_PARAM</b>
Invalid argument</p>
<p style="margin-left:11%; margin-top: 1em"><b>CS_ERR_ACCESS</b>
Permission denied</p>
<p style="margin-left:11%; margin-top: 1em"><b>CS_ERR_LIBRARY</b>
The connection failed</p>
<p style="margin-left:11%; margin-top: 1em"><b>CS_ERR_INTERRUPT</b>
System call inturrupted by a signal</p>
<p style="margin-left:11%; margin-top: 1em"><b>CS_ERR_NOT_SUPPORTED</b>
The requested protocol/functuality not supported</p>
<p style="margin-left:11%; margin-top: 1em"><b>CS_ERR_MESSAGE_ERROR</b>
Incorrect auth message received</p>
<p style="margin-left:11%; margin-top: 1em"><b>CS_ERR_NO_MEMORY</b>
Not enough memory to completed the requested task</p>
<hr>
</body>
</html>
|