/usr/share/doc/corosync/html/cmap_set.3.html is in libcmap-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 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 | <!-- Creator : groff version 1.22.2 -->
<!-- CreationDate: Thu Mar 20 15:54:40 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>CMAP_SET</title>
</head>
<body>
<h1 align="center">CMAP_SET</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="#SEE ALSO">SEE ALSO</a><br>
<hr>
<h2>NAME
<a name="NAME"></a>
</h2>
<p style="margin-left:11%; margin-top: 1em">cmap_set
− Store value in CMAP</p>
<h2>SYNOPSIS
<a name="SYNOPSIS"></a>
</h2>
<p style="margin-left:11%; margin-top: 1em"><b>#include
<corosync/cmap.h></b></p>
<p style="margin-left:11%; margin-top: 1em"><b>cs_error_t
cmap_set (cmap_handle_t</b> <i>handle</i><b>, const char
*</b><i>key_name</i><b>, const void *</b><i>value</i><b>,
size_t</b> <i>value_len</i><b>, cmap_value_types_t</b>
<i>type</i><b>);</b></p>
<p style="margin-left:11%; margin-top: 1em">Also shortcuts
for different types are defined</p>
<p style="margin-left:11%; margin-top: 1em"><b>cs_error_t
cmap_set_int8(cmap_handle_t</b> <i>handle</i><b>, const char
*</b><i>key_name</i><b>, int8_t</b>
<i>value</i><b>);</b></p>
<p style="margin-left:11%; margin-top: 1em"><b>cs_error_t
cmap_set_uint8(cmap_handle_t</b> <i>handle</i><b>, const
char *</b><i>key_name</i><b>, uint8_t</b>
<i>value</i><b>);</b></p>
<p style="margin-left:11%; margin-top: 1em"><b>cs_error_t
cmap_set_int16(cmap_handle_t</b> <i>handle</i><b>, const
char *</b><i>key_name</i><b>, int16_t</b>
<i>value</i><b>);</b></p>
<p style="margin-left:11%; margin-top: 1em"><b>cs_error_t
cmap_set_uint16(cmap_handle_t</b> <i>handle</i><b>, const
char *</b><i>key_name</i><b>, uint16_t</b>
<i>value</i><b>);</b></p>
<p style="margin-left:11%; margin-top: 1em"><b>cs_error_t
cmap_set_int32(cmap_handle_t</b> <i>handle</i><b>, const
char *</b><i>key_name</i><b>, int32_t</b>
<i>value</i><b>);</b></p>
<p style="margin-left:11%; margin-top: 1em"><b>cs_error_t
cmap_set_uint32(cmap_handle_t</b> <i>handle</i><b>, const
char *</b><i>key_name</i><b>, uint32_t</b>
<i>value</i><b>);</b></p>
<p style="margin-left:11%; margin-top: 1em"><b>cs_error_t
cmap_set_int64(cmap_handle_t</b> <i>handle</i><b>, const
char *</b><i>key_name</i><b>, int64_t</b>
<i>value</i><b>);</b></p>
<p style="margin-left:11%; margin-top: 1em"><b>cs_error_t
cmap_set_uint64(cmap_handle_t</b> <i>handle</i><b>, const
char *</b><i>key_name</i><b>, uint64_t</b>
<i>value</i><b>);</b></p>
<p style="margin-left:11%; margin-top: 1em"><b>cs_error_t
cmap_set_float(cmap_handle_t</b> <i>handle</i><b>, const
char *</b><i>key_name</i><b>, float</b>
<i>value</i><b>);</b></p>
<p style="margin-left:11%; margin-top: 1em"><b>cs_error_t
cmap_set_double(cmap_handle_t</b> <i>handle</i><b>, const
char *</b><i>key_name</i><b>, double</b>
<i>value</i><b>);</b></p>
<p style="margin-left:11%; margin-top: 1em"><b>cs_error_t
cmap_set_string(cmap_handle_t</b> <i>handle</i><b>, const
char *</b><i>key_name</i><b>, const char
*</b><i>value</i><b>);</b></p>
<h2>DESCRIPTION
<a name="DESCRIPTION"></a>
</h2>
<p style="margin-left:11%; margin-top: 1em">The
<b>cmap_set</b> function is used to store key inside cmap.
The <i>handle</i> argument is connection to CMAP database
obtained by calling <b>cmap_initialize(3)</b> function.
<i>key_name</i> is name of key to set value. Key name is
limited by minimal (CMAP_KEYNAME_MINLEN, currently 3) and
maximal (CMAP_KEYNAME_MAXLEN, currently 255) length. Also
key can contain only limited set of characters expressed by
regexp [a-zA-Z0-9._-/:]*. <i>value</i> is pointer to
allocated data which will be stored inside CMAP. Length of
value (number of bytes) is supplied as <i>value_len</i>
parameter. Last parameter is <i>type</i> which gives type of
value. It may be one of:</p>
<p style="margin-left:11%; margin-top: 1em"><b>CMAP_VALUETYPE_INT8</b>
- 8-bit signed interger</p>
<p style="margin-left:11%; margin-top: 1em"><b>CMAP_VALUETYPE_UINT8</b>
- 8-bit unsigned integer</p>
<p style="margin-left:11%; margin-top: 1em"><b>CMAP_VALUETYPE_INT16</b>
- 16-bit signed interger</p>
<p style="margin-left:11%; margin-top: 1em"><b>CMAP_VALUETYPE_UINT16</b>
- 16-bit unsigned integer</p>
<p style="margin-left:11%; margin-top: 1em"><b>CMAP_VALUETYPE_INT32</b>
- 32-bit signed interger</p>
<p style="margin-left:11%; margin-top: 1em"><b>CMAP_VALUETYPE_UINT32</b>
- 32-bit unsigned integer</p>
<p style="margin-left:11%; margin-top: 1em"><b>CMAP_VALUETYPE_INT64</b>
- 64-bit signed interger</p>
<p style="margin-left:11%; margin-top: 1em"><b>CMAP_VALUETYPE_UINT64</b>
- 64-bit unsigned integer</p>
<p style="margin-left:11%; margin-top: 1em"><b>CMAP_VALUETYPE_FLOAT</b>
- Float value</p>
<p style="margin-left:11%; margin-top: 1em"><b>CMAP_VALUETYPE_DOUBLE</b>
- Double value</p>
<p style="margin-left:11%; margin-top: 1em"><b>CMAP_VALUETYPE_STRING</b>
- C-style string</p>
<p style="margin-left:11%; margin-top: 1em"><b>CMAP_VALUETYPE_BINARY</b>
- Binary data, byte with zero value has no special
meaning</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. If value or key_name
are unspecified, CS_ERR_INVALID_PARAM is returned. Too short
or too long key_name returns CS_ERR_NAME_TOO_LONG error
code. Some of keys may be tagged read-only directly in
corosync and seting such key will result in CS_ERR_ACCESS
error.</p>
<h2>SEE ALSO
<a name="SEE ALSO"></a>
</h2>
<p style="margin-left:11%; margin-top: 1em"><b>cmap_get</b>(3),
<b>cmap_initialize</b>(3), <b>cmap_overview</b>(8)</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>
|