This file is indexed.

/usr/share/doc/corosync/html/cmap_dispatch.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
<!-- Creator     : groff version 1.22.2 -->
<!-- CreationDate: Thu Mar 20 15:54:41 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_DISPATCH</title>

</head>
<body>

<h1 align="center">CMAP_DISPATCH</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_dispatch
&minus; Dispatches callbacks from the CMAP service</p>

<h2>SYNOPSIS
<a name="SYNOPSIS"></a>
</h2>


<p style="margin-left:11%; margin-top: 1em"><b>#include
&lt;corosync/cmap.h&gt;</b></p>

<p style="margin-left:11%; margin-top: 1em"><b>cs_error_t
cmap_dispatch (cmap_handle_t</b> <i>handle</i><b>,
cs_dispatch_flags_t</b> <i>dispatch_types</i><b>);</b></p>

<h2>DESCRIPTION
<a name="DESCRIPTION"></a>
</h2>


<p style="margin-left:11%; margin-top: 1em">The
<b>cmap_dispatch</b> function is used to dispatch
configuration changes.</p>

<p style="margin-left:11%; margin-top: 1em">Each
application may have several connections to the CMAP API.
Each application uses the <i>handle</i> argument to uniquely
identify the connection.</p>

<p style="margin-left:11%; margin-top: 1em">The
<i>dispatch_types</i> argument is used to identify the type
of dispatch to execute. The possible types are
CS_DISPATCH_ONE, CS_DISPATCH_ALL and
CS_DISPATCH_BLOCKING.</p>

<p style="margin-left:11%; margin-top: 1em">The dispatch
values have the following meanings: <b><br>
CS_DISPATCH_ONE</b></p>

<p style="margin-left:22%;">Dispatch at least one callback,
blocking until the callback is dispatched.</p>

<p style="margin-left:11%;"><b>CS_DISPATCH_ALL</b></p>

<p style="margin-left:22%;">Dispatch all waiting callbacks
without blocking to wait for any callbacks.</p>


<p style="margin-left:11%;"><b>CS_DISPATCH_BLOCKING</b></p>

<p style="margin-left:22%;">Dispatch all callbacks blocking
indefinitely. This is used in a threaded program where a
thread is created, and then cs_dispatch() is called
immediately from the created thread to execute
callbacks.</p>


<p style="margin-left:11%;"><b>CS_DISPATCH_ONE_NONBLOCKING</b></p>

<p style="margin-left:22%;">Dispatch at most one callback.
If there is no pending callback, CS_ERR_TRY_AGAIN is
returned.</p>

<p style="margin-left:11%; margin-top: 1em">It&rsquo;s
needed to call <b>cmap_track_add(3)</b> to add tracked items
and receive callbacks.</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>SEE ALSO
<a name="SEE ALSO"></a>
</h2>



<p style="margin-left:11%; margin-top: 1em"><b>cmap_track_add</b>(3),
<b>cmap_track_delete</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>