This file is indexed.

/usr/share/gtk-doc/html/dee-1.0/DeeServer.html is in libdee-doc 1.0.10-3.1.

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
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Dee Reference Manual: DeeServer</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="index.html" title="Dee Reference Manual">
<link rel="up" href="ch01.html" title="Peer Discovery">
<link rel="prev" href="DeePeer.html" title="DeePeer">
<link rel="next" href="ch02.html" title="Models">
<meta name="generator" content="GTK-Doc V1.20 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="10"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span> 
                  <a href="#DeeServer.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> 
                  <a href="#DeeServer.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties"> <span class="dim">|</span> 
                  <a href="#DeeServer.properties" class="shortcut">Properties</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="ch01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="DeePeer.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="ch02.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="DeeServer"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="DeeServer.top_of_page"></a>DeeServer</span></h2>
<p>DeeServer — Creates a server object you can connect to.</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="DeeServer.functions"></a><h2>Functions</h2>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<span class="returnvalue">gchar</span> *
</td>
<td class="function_name">
<a class="link" href="DeeServer.html#dee-server-bus-address-for-name" title="dee_server_bus_address_for_name ()">dee_server_bus_address_for_name</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">const <span class="returnvalue">gchar</span> *
</td>
<td class="function_name">
<a class="link" href="DeeServer.html#dee-server-get-client-address" title="dee_server_get_client_address ()">dee_server_get_client_address</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="DeeServer.html" title="DeeServer"><span class="returnvalue">DeeServer</span></a> *
</td>
<td class="function_name">
<a class="link" href="DeeServer.html#dee-server-new" title="dee_server_new ()">dee_server_new</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="DeeServer.html" title="DeeServer"><span class="returnvalue">DeeServer</span></a> *
</td>
<td class="function_name">
<a class="link" href="DeeServer.html#dee-server-new-for-address" title="dee_server_new_for_address ()">dee_server_new_for_address</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="DeeServer.properties"></a><h2>Properties</h2>
<div class="informaltable"><table border="0">
<colgroup>
<col width="150px" class="properties_type">
<col width="300px" class="properties_name">
<col width="200px" class="properties_flags">
</colgroup>
<tbody>
<tr>
<td class="property_type">
<span class="type">gchar</span> *</td>
<td class="property_name"><a class="link" href="DeeServer.html#DeeServer--bus-address" title="The “bus-address” property">bus-address</a></td>
<td class="property_flags">Read / Write / Construct Only</td>
</tr>
<tr>
<td class="property_type"><span class="type">gboolean</span></td>
<td class="property_name"><a class="link" href="DeeServer.html#DeeServer--same-user-only" title="The “same-user-only” property">same-user-only</a></td>
<td class="property_flags">Read / Write / Construct Only</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="DeeServer.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody>
<tr>
<td class="datatype_keyword"> </td>
<td class="function_name"><a class="link" href="DeeServer.html#DeeServer-struct" title="DeeServer">DeeServer</a></td>
</tr>
<tr>
<td class="datatype_keyword"> </td>
<td class="function_name"><a class="link" href="DeeServer.html#DeeServerClass" title="DeeServerClass">DeeServerClass</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="DeeServer.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen">    GObject
    <span class="lineart">╰──</span> <a class="link" href="DeePeer.html" title="DeePeer">DeePeer</a>
        <span class="lineart">╰──</span> DeeServer
</pre>
</div>
<div class="refsect1">
<a name="DeeServer.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include &lt;dee.h&gt;
</pre>
</div>
<div class="refsect1">
<a name="DeeServer.description"></a><h2>Description</h2>
<p><a class="link" href="DeeServer.html" title="DeeServer"><span class="type">DeeServer</span></a> allows you to create private connections (connections which 
are not routed via dbus-daemon). Note that, unlike <a class="link" href="DeePeer.html" title="DeePeer"><span class="type">DeePeer</span></a>, <a class="link" href="DeeServer.html" title="DeeServer"><span class="type">DeeServer</span></a>
will always be swarm leader, and clients connected to it cannot overtake
swarm leadership once the server connection is closed.</p>
</div>
<div class="refsect1">
<a name="DeeServer.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="dee-server-bus-address-for-name"></a><h3>dee_server_bus_address_for_name ()</h3>
<pre class="programlisting"><span class="returnvalue">gchar</span> *
dee_server_bus_address_for_name (<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>,
                                 <em class="parameter"><code><span class="type">gboolean</span> include_username</code></em>);</pre>
<p>Helper method which creates bus address string for the given name, which
should have the same format as a DBus unique name.</p>
<div class="refsect3">
<a name="id-1.2.4.9.2.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>name</p></td>
<td class="parameter_description"><p>A name to create bus address for.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>include_username</p></td>
<td class="parameter_description"><p>Include current user name as part of the bus address.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.4.9.2.6"></a><h4>Returns</h4>
<p> Newly allocated string with bus address.
Use <code class="function">g_free()</code> to free. </p>
<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="dee-server-get-client-address"></a><h3>dee_server_get_client_address ()</h3>
<pre class="programlisting">const <span class="returnvalue">gchar</span> *
dee_server_get_client_address (<em class="parameter"><code><a class="link" href="DeeServer.html" title="DeeServer"><span class="type">DeeServer</span></a> *server</code></em>);</pre>
<p>Gets a D-Bus address string that can be used by clients to connect to server.</p>
<div class="refsect3">
<a name="id-1.2.4.9.3.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>server</p></td>
<td class="parameter_description"><p>A <a class="link" href="DeeServer.html" title="DeeServer"><span class="type">DeeServer</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.4.9.3.6"></a><h4>Returns</h4>
<p> A D-Bus address string. Do not free.</p>
<p></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="dee-server-new"></a><h3>dee_server_new ()</h3>
<pre class="programlisting"><a class="link" href="DeeServer.html" title="DeeServer"><span class="returnvalue">DeeServer</span></a> *
dee_server_new (<em class="parameter"><code>const <span class="type">gchar</span> *swarm_name</code></em>);</pre>
<p>Creates a new instance of <a class="link" href="DeeServer.html" title="DeeServer"><span class="type">DeeServer</span></a> and tries to bind 
to <a class="link" href="DeeServer.html#DeeServer--bus-address" title="The “bus-address” property"><span class="type">“bus-address”</span></a>. The <a class="link" href="DeePeer.html#DeePeer--swarm-leader" title="The “swarm-leader” property"><span class="type">“swarm-leader”</span></a> property will be set
when the binding succeeds.</p>
<div class="note"><p>
    Note that this function will automatically determine the value
    of <a class="link" href="DeeServer.html#DeeServer--bus-address" title="The “bus-address” property"><span class="type">“bus-address”</span></a> property and will generally cause your
    application to use new socket for every <a class="link" href="DeeServer.html" title="DeeServer"><span class="type">DeeServer</span></a> with different swarm
    name. See <a class="link" href="DeeServer.html#dee-server-new-for-address" title="dee_server_new_for_address ()"><code class="function">dee_server_new_for_address()</code></a> if you'd like to share one
    connection between multiple <a class="link" href="DeeServer.html" title="DeeServer"><span class="type">DeeServer</span></a> instances.
  </p></div>
<div class="refsect3">
<a name="id-1.2.4.9.4.6"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>swarm_name</p></td>
<td class="parameter_description"><p>Name of swarm to join.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.4.9.4.7"></a><h4>Returns</h4>
<p> A newly constructed <a class="link" href="DeeServer.html" title="DeeServer"><span class="type">DeeServer</span></a>. </p>
<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="dee-server-new-for-address"></a><h3>dee_server_new_for_address ()</h3>
<pre class="programlisting"><a class="link" href="DeeServer.html" title="DeeServer"><span class="returnvalue">DeeServer</span></a> *
dee_server_new_for_address (<em class="parameter"><code>const <span class="type">gchar</span> *swarm_name</code></em>,
                            <em class="parameter"><code>const <span class="type">gchar</span> *bus_address</code></em>);</pre>
<p>Creates a new instance of <a class="link" href="DeeServer.html" title="DeeServer"><span class="type">DeeServer</span></a> and tries to bind to <em class="parameter"><code>bus_address</code></em>
.
The <a class="link" href="DeePeer.html#DeePeer--swarm-leader" title="The “swarm-leader” property"><span class="type">“swarm-leader”</span></a> property will be set when the binding succeeds.</p>
<p>If there is already a <a class="link" href="DeeServer.html" title="DeeServer"><span class="type">DeeServer</span></a> instance bound to <em class="parameter"><code>bus_address</code></em>
,
the connection will be shared with the newly constructed instance.</p>
<div class="note"><p>
    This function is primarily meant for sharing of one connection (socket)
    between multiple DeeServers, so that you can create <a class="link" href="DeeServer.html" title="DeeServer"><span class="type">DeeServer</span></a> instances
    with varying swarm names, but the same bus address, which will cause
    them to share the connection (the sharing is possible only within
    the same process though).
  </p></div>
<div class="refsect3">
<a name="id-1.2.4.9.5.7"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>swarm_name</p></td>
<td class="parameter_description"><p>Name of swarm to join.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>bus_address</p></td>
<td class="parameter_description"><p>D-Bus address to use for the connection.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.4.9.5.8"></a><h4>Returns</h4>
<p> A newly constructed <a class="link" href="DeeServer.html" title="DeeServer"><span class="type">DeeServer</span></a>. </p>
<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
</div>
</div>
</div>
<div class="refsect1">
<a name="DeeServer.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="DeeServer-struct"></a><h3>DeeServer</h3>
<pre class="programlisting">typedef struct _DeeServer DeeServer;</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="DeeServerClass"></a><h3>DeeServerClass</h3>
<pre class="programlisting">typedef struct {
} DeeServerClass;
</pre>
<p>
</p>
</div>
</div>
<div class="refsect1">
<a name="DeeServer.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="DeeServer--bus-address"></a><h3>The <code class="literal">“bus-address”</code> property</h3>
<pre class="programlisting">  “bus-address”              <span class="type">gchar</span> *</pre>
<p>Bus address to use for the connection.</p>
<p>Flags: Read / Write / Construct Only</p>
<p>Default value: NULL</p>
</div>
<hr>
<div class="refsect2">
<a name="DeeServer--same-user-only"></a><h3>The <code class="literal">“same-user-only”</code> property</h3>
<pre class="programlisting">  “same-user-only”           <span class="type">gboolean</span></pre>
<p>Accept connections from current user only.</p>
<p>Flags: Read / Write / Construct Only</p>
<p>Default value: TRUE</p>
</div>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.20</div>
</body>
</html>