/usr/share/doc/corosync/html/cpg_initialize.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 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 | <!-- Creator : groff version 1.22.2 -->
<!-- CreationDate: Thu Mar 20 15:54:32 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_INITIALIZE</title>
</head>
<body>
<h1 align="center">CPG_INITIALIZE</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_initialize
− Create a new connection to the CPG service</p>
<h2>SYNOPSIS
<a name="SYNOPSIS"></a>
</h2>
<p style="margin-left:11%; margin-top: 1em"><b>#include
<corosync/cpg.h></b></p>
<p style="margin-left:11%; margin-top: 1em"><b>int
cpg_initialize(cpg_handle_t *</b><i>handle</i><b>,
cpg_callbacks_t *</b><i>callbacks</i><b>);</b></p>
<h2>DESCRIPTION
<a name="DESCRIPTION"></a>
</h2>
<p style="margin-left:11%; margin-top: 1em">The
<b>cpg_initialize</b> function is used to initialize a
connection to the closed process groups API. This function
is deprecated and <b>cpg_model_initialize</b> should be used
in newly written code.</p>
<p style="margin-left:11%; margin-top: 1em">Each
application may have several connections to the CPG API.
Each application uses the <i>handle</i> argument to uniquely
identify the connection. The <i>handle</i> argument is then
used in other function calls to identify the connection to
be used for communication with the CPG service.</p>
<p style="margin-left:11%; margin-top: 1em">Every time an
CPG event occurs within the joined group, one of the
callbacks specified by the argument <i>callbacks</i> is
called. The callback functions are described by the
following type definitions:</p>
<p style="margin-left:22%; margin-top: 1em">typedef void
(*cpg_deliver_fn_t) ( <br>
cpg_handle_t handle, <br>
const struct cpg_name *group_name, <br>
uint32_t nodeid, <br>
uint32_t pid, <br>
const void *msg, <br>
size_t msg_len);</p>
<p style="margin-left:22%; margin-top: 1em">typedef void
(*cpg_confchg_fn_t) ( <br>
cpg_handle_t handle, <br>
const struct cpg_name *group_name, <br>
const struct cpg_address *member_list, size_t
member_list_entries, <br>
const struct cpg_address *left_list, size_t
left_list_entries, <br>
const struct cpg_address *joined_list, size_t
joined_list_entries);</p>
<p style="margin-left:11%; margin-top: 1em">The
<i>callbacks</i> argument is of the type:</p>
<p style="margin-left:22%; margin-top: 1em">typedef struct
{ <br>
cpg_deliver_fn_t cpg_deliver_fn; <br>
cpg_confchg_fn_t cpg_confchg_fn; <br>
} cpg_callbacks_t;</p>
<p style="margin-left:11%; margin-top: 1em">When a
configuration change occurs or a message is to be delivered
one of the callbacks is called from the
<b>cpg_dispatch()</b> function. If a configuration change
occurs, <i>cpg_confchg_fn</i> is called. If a delivery of a
message occurs, <i>cpg_deliver_fn</i> is called.</p>
<p style="margin-left:11%; margin-top: 1em">The
<i>cpg_address</i> structure is defined</p>
<p style="margin-left:22%; margin-top: 1em">struct
cpg_address { <br>
unsigned int nodeid; <br>
unsigned int pid; <br>
unsigned int reason; <br>
};</p>
<p style="margin-left:11%; margin-top: 1em">where nodeid is
a 32 bit unique node identifier, pid is the process ID of
the process that has joined/left the group or sent the
message, and reason is an integer code indicating why the
node joined/left the group.</p>
<p style="margin-left:22%; margin-top: 1em">CPG_REASON_JOIN
- the process joined a group using cpg_join(). <br>
CPG_REASON_LEAVE - the process left a group using
cpg_leave() <br>
CPG_REASON_NODEDOWN - the process left a group because the
node left the cluster. <br>
CPG_REASON_NODEUP - the process joined a group because it
was already a member of a group on a node that has just
joined the cluster <br>
CPG_REASON_PROCDOWN - the process left a group without
calling cpg_leave()</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)
<b>cpg_model_initialize</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>
|