/usr/share/gtk-doc/html/libinfinity-0.5/InfUserTable.html is in libinfinity-0.5-doc 0.5.5-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 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>InfUserTable</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="index.html" title="libinfinity-0.5 Reference Manual">
<link rel="up" href="ch02.html" title="Common libinfinity API">
<link rel="prev" href="InfChatBuffer.html" title="InfChatBuffer">
<link rel="next" href="InfUser.html" title="InfUser">
<meta name="generator" content="GTK-Doc V1.19 (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="2">
<tr valign="middle">
<td><a accesskey="p" href="InfChatBuffer.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch02.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">libinfinity-0.5 Reference Manual</th>
<td><a accesskey="n" href="InfUser.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#InfUserTable.synopsis" class="shortcut">Top</a>
|
<a href="#InfUserTable.description" class="shortcut">Description</a>
|
<a href="#InfUserTable.object-hierarchy" class="shortcut">Object Hierarchy</a>
|
<a href="#InfUserTable.signals" class="shortcut">Signals</a>
</td></tr>
</table>
<div class="refentry">
<a name="InfUserTable"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="InfUserTable.top_of_page"></a>InfUserTable</span></h2>
<p>InfUserTable — User information storage</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="InfUserTable.stability-level"></a><h2>Stability Level</h2>
Unstable, unless otherwise indicated
</div>
<div class="refsynopsisdiv">
<a name="InfUserTable.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
#include <libinfinity/common/inf-user-table.h>
<span class="returnvalue">void</span> (<a class="link" href="InfUserTable.html#InfUserTableForeachUserFunc" title="InfUserTableForeachUserFunc ()">*InfUserTableForeachUserFunc</a>) (<em class="parameter"><code><a class="link" href="InfUser.html" title="InfUser"><span class="type">InfUser</span></a> *user</code></em>,
<em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>);
<a class="link" href="InfUserTable.html#InfUserTable-struct" title="InfUserTable">InfUserTable</a>;
struct <a class="link" href="InfUserTable.html#InfUserTableClass" title="struct InfUserTableClass">InfUserTableClass</a>;
<a class="link" href="InfUserTable.html" title="InfUserTable"><span class="returnvalue">InfUserTable</span></a> * <a class="link" href="InfUserTable.html#inf-user-table-new" title="inf_user_table_new ()">inf_user_table_new</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
<span class="returnvalue">void</span> <a class="link" href="InfUserTable.html#inf-user-table-add-user" title="inf_user_table_add_user ()">inf_user_table_add_user</a> (<em class="parameter"><code><a class="link" href="InfUserTable.html" title="InfUserTable"><span class="type">InfUserTable</span></a> *user_table</code></em>,
<em class="parameter"><code><a class="link" href="InfUser.html" title="InfUser"><span class="type">InfUser</span></a> *user</code></em>);
<span class="returnvalue">void</span> <a class="link" href="InfUserTable.html#inf-user-table-remove-user" title="inf_user_table_remove_user ()">inf_user_table_remove_user</a> (<em class="parameter"><code><a class="link" href="InfUserTable.html" title="InfUserTable"><span class="type">InfUserTable</span></a> *user_table</code></em>,
<em class="parameter"><code><a class="link" href="InfUser.html" title="InfUser"><span class="type">InfUser</span></a> *user</code></em>);
<a class="link" href="InfUser.html" title="InfUser"><span class="returnvalue">InfUser</span></a> * <a class="link" href="InfUserTable.html#inf-user-table-lookup-user-by-id" title="inf_user_table_lookup_user_by_id ()">inf_user_table_lookup_user_by_id</a> (<em class="parameter"><code><a class="link" href="InfUserTable.html" title="InfUserTable"><span class="type">InfUserTable</span></a> *user_table</code></em>,
<em class="parameter"><code><span class="type">guint</span> id</code></em>);
<a class="link" href="InfUser.html" title="InfUser"><span class="returnvalue">InfUser</span></a> * <a class="link" href="InfUserTable.html#inf-user-table-lookup-user-by-name" title="inf_user_table_lookup_user_by_name ()">inf_user_table_lookup_user_by_name</a> (<em class="parameter"><code><a class="link" href="InfUserTable.html" title="InfUserTable"><span class="type">InfUserTable</span></a> *user_table</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>);
<span class="returnvalue">void</span> <a class="link" href="InfUserTable.html#inf-user-table-foreach-user" title="inf_user_table_foreach_user ()">inf_user_table_foreach_user</a> (<em class="parameter"><code><a class="link" href="InfUserTable.html" title="InfUserTable"><span class="type">InfUserTable</span></a> *user_table</code></em>,
<em class="parameter"><code><a class="link" href="InfUserTable.html#InfUserTableForeachUserFunc" title="InfUserTableForeachUserFunc ()"><span class="type">InfUserTableForeachUserFunc</span></a> func</code></em>,
<em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>);
<span class="returnvalue">void</span> <a class="link" href="InfUserTable.html#inf-user-table-foreach-local-user" title="inf_user_table_foreach_local_user ()">inf_user_table_foreach_local_user</a> (<em class="parameter"><code><a class="link" href="InfUserTable.html" title="InfUserTable"><span class="type">InfUserTable</span></a> *user_table</code></em>,
<em class="parameter"><code><a class="link" href="InfUserTable.html#InfUserTableForeachUserFunc" title="InfUserTableForeachUserFunc ()"><span class="type">InfUserTableForeachUserFunc</span></a> func</code></em>,
<em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="InfUserTable.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
GObject
+----InfUserTable
</pre>
</div>
<div class="refsect1">
<a name="InfUserTable.signals"></a><h2>Signals</h2>
<pre class="synopsis">
"<a class="link" href="InfUserTable.html#InfUserTable-add-local-user" title='The "add-local-user" signal'>add-local-user</a>" : <code class="literal">Run Last</code>
"<a class="link" href="InfUserTable.html#InfUserTable-add-user" title='The "add-user" signal'>add-user</a>" : <code class="literal">Run Last</code>
"<a class="link" href="InfUserTable.html#InfUserTable-remove-local-user" title='The "remove-local-user" signal'>remove-local-user</a>" : <code class="literal">Run Last</code>
"<a class="link" href="InfUserTable.html#InfUserTable-remove-user" title='The "remove-user" signal'>remove-user</a>" : <code class="literal">Run Last</code>
</pre>
</div>
<div class="refsect1">
<a name="InfUserTable.description"></a><h2>Description</h2>
<p>
<a class="link" href="InfUserTable.html" title="InfUserTable"><span class="type">InfUserTable</span></a> manages multiple <a class="link" href="InfUser.html" title="InfUser"><span class="type">InfUser</span></a> objects and provides an easy way to
look up users by their ID and name. All users within a user table must have
a unique ID and name. The user table is used by <a class="link" href="InfSession.html" title="InfSession"><span class="type">InfSession</span></a> to store the
users within the session.
</p>
</div>
<div class="refsect1">
<a name="InfUserTable.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="InfUserTableForeachUserFunc"></a><h3>InfUserTableForeachUserFunc ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> (*InfUserTableForeachUserFunc) (<em class="parameter"><code><a class="link" href="InfUser.html" title="InfUser"><span class="type">InfUser</span></a> *user</code></em>,
<em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>);</pre>
<p>
This callback is called for every user iterated by
<a class="link" href="InfUserTable.html#inf-user-table-foreach-user" title="inf_user_table_foreach_user ()"><code class="function">inf_user_table_foreach_user()</code></a> or <a class="link" href="InfUserTable.html#inf-user-table-foreach-local-user" title="inf_user_table_foreach_local_user ()"><code class="function">inf_user_table_foreach_local_user()</code></a>.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>user</code></em> :</span></p></td>
<td>The <a class="link" href="InfUser.html" title="InfUser"><span class="type">InfUser</span></a> for the current iteration.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td>The user_data passed to <a class="link" href="InfUserTable.html#inf-user-table-foreach-user" title="inf_user_table_foreach_user ()"><code class="function">inf_user_table_foreach_user()</code></a> or
<a class="link" href="InfUserTable.html#inf-user-table-foreach-local-user" title="inf_user_table_foreach_local_user ()"><code class="function">inf_user_table_foreach_local_user()</code></a>.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="InfUserTable-struct"></a><h3>InfUserTable</h3>
<pre class="programlisting">typedef struct _InfUserTable InfUserTable;</pre>
<p>
<a class="link" href="InfUserTable.html" title="InfUserTable"><span class="type">InfUserTable</span></a> is an opaque data type. You should only access it via the
public API functions.
</p>
</div>
<hr>
<div class="refsect2">
<a name="InfUserTableClass"></a><h3>struct InfUserTableClass</h3>
<pre class="programlisting">struct InfUserTableClass {
void(*add_user)(InfUserTable* user_table,
InfUser* user);
void(*remove_user)(InfUserTable* user_table,
InfUser* user);
void(*add_local_user)(InfUserTable* user_table,
InfUser* user);
void(*remove_local_user)(InfUserTable* user_table,
InfUser* user);
};
</pre>
<p>
Signals for the <a class="link" href="InfUserTable.html" title="InfUserTable"><span class="type">InfUserTable</span></a> class.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="structfield"><code><a name="InfUserTableClass.add-user"></a>add_user</code></em> ()</span></p></td>
<td>Default signal handler for the <a class="link" href="InfUserTable.html#InfUserTable-add-user" title='The "add-user" signal'><span class="type">"add_user"</span></a> signal.</td>
</tr>
<tr>
<td><p><span class="term"><em class="structfield"><code><a name="InfUserTableClass.remove-user"></a>remove_user</code></em> ()</span></p></td>
<td>Default signal handler for the <a class="link" href="InfUserTable.html#InfUserTable-remove-user" title='The "remove-user" signal'><span class="type">"remove_user"</span></a>
signal.</td>
</tr>
<tr>
<td><p><span class="term"><em class="structfield"><code><a name="InfUserTableClass.add-local-user"></a>add_local_user</code></em> ()</span></p></td>
<td>Default signal handler for the
<a class="link" href="InfUserTable.html#InfUserTable-add-local-user" title='The "add-local-user" signal'><span class="type">"add_local_user"</span></a> signal.</td>
</tr>
<tr>
<td><p><span class="term"><em class="structfield"><code><a name="InfUserTableClass.remove-local-user"></a>remove_local_user</code></em> ()</span></p></td>
<td>Default signal handler for the
<a class="link" href="InfUserTable.html#InfUserTable-remove-local-user" title='The "remove-local-user" signal'><span class="type">"remove_local_user"</span></a> signal.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="inf-user-table-new"></a><h3>inf_user_table_new ()</h3>
<pre class="programlisting"><a class="link" href="InfUserTable.html" title="InfUserTable"><span class="returnvalue">InfUserTable</span></a> * inf_user_table_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
Creates a new, empty user table.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>A <a class="link" href="InfUserTable.html" title="InfUserTable"><span class="type">InfUserTable</span></a>.</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="inf-user-table-add-user"></a><h3>inf_user_table_add_user ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> inf_user_table_add_user (<em class="parameter"><code><a class="link" href="InfUserTable.html" title="InfUserTable"><span class="type">InfUserTable</span></a> *user_table</code></em>,
<em class="parameter"><code><a class="link" href="InfUser.html" title="InfUser"><span class="type">InfUser</span></a> *user</code></em>);</pre>
<p>
Inserts <em class="parameter"><code>user</code></em> into <em class="parameter"><code>user_table</code></em>.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_table</code></em> :</span></p></td>
<td>A <a class="link" href="InfUserTable.html" title="InfUserTable"><span class="type">InfUserTable</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user</code></em> :</span></p></td>
<td>A <a class="link" href="InfUser.html" title="InfUser"><span class="type">InfUser</span></a> not already contained in <em class="parameter"><code>user_table</code></em>.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="inf-user-table-remove-user"></a><h3>inf_user_table_remove_user ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> inf_user_table_remove_user (<em class="parameter"><code><a class="link" href="InfUserTable.html" title="InfUserTable"><span class="type">InfUserTable</span></a> *user_table</code></em>,
<em class="parameter"><code><a class="link" href="InfUser.html" title="InfUser"><span class="type">InfUser</span></a> *user</code></em>);</pre>
<p>
Removes <em class="parameter"><code>user</code></em> from <em class="parameter"><code>uesr_table</code></em>.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_table</code></em> :</span></p></td>
<td>A <a class="link" href="InfUserTable.html" title="InfUserTable"><span class="type">InfUserTable</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user</code></em> :</span></p></td>
<td>A <a class="link" href="InfUser.html" title="InfUser"><span class="type">InfUser</span></a> contained in <em class="parameter"><code>table</code></em>.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="inf-user-table-lookup-user-by-id"></a><h3>inf_user_table_lookup_user_by_id ()</h3>
<pre class="programlisting"><a class="link" href="InfUser.html" title="InfUser"><span class="returnvalue">InfUser</span></a> * inf_user_table_lookup_user_by_id (<em class="parameter"><code><a class="link" href="InfUserTable.html" title="InfUserTable"><span class="type">InfUserTable</span></a> *user_table</code></em>,
<em class="parameter"><code><span class="type">guint</span> id</code></em>);</pre>
<p>
Returns the <a class="link" href="InfUser.html" title="InfUser"><span class="type">InfUser</span></a> with the given User ID in <em class="parameter"><code>user_table</code></em>.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_table</code></em> :</span></p></td>
<td>A <a class="link" href="InfUserTable.html" title="InfUserTable"><span class="type">InfUserTable</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>id</code></em> :</span></p></td>
<td>User ID to lookup.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>A <a class="link" href="InfUser.html" title="InfUser"><span class="type">InfUser</span></a>, or <code class="literal">NULL</code>.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="inf-user-table-lookup-user-by-name"></a><h3>inf_user_table_lookup_user_by_name ()</h3>
<pre class="programlisting"><a class="link" href="InfUser.html" title="InfUser"><span class="returnvalue">InfUser</span></a> * inf_user_table_lookup_user_by_name (<em class="parameter"><code><a class="link" href="InfUserTable.html" title="InfUserTable"><span class="type">InfUserTable</span></a> *user_table</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>);</pre>
<p>
Returns an <a class="link" href="InfUser.html" title="InfUser"><span class="type">InfUser</span></a> with the given name if there is one.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_table</code></em> :</span></p></td>
<td>A <a class="link" href="InfUserTable.html" title="InfUserTable"><span class="type">InfUserTable</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
<td>User name to lookup.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>A <a class="link" href="InfUser.html" title="InfUser"><span class="type">InfUser</span></a>, or <code class="literal">NULL</code>.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="inf-user-table-foreach-user"></a><h3>inf_user_table_foreach_user ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> inf_user_table_foreach_user (<em class="parameter"><code><a class="link" href="InfUserTable.html" title="InfUserTable"><span class="type">InfUserTable</span></a> *user_table</code></em>,
<em class="parameter"><code><a class="link" href="InfUserTable.html#InfUserTableForeachUserFunc" title="InfUserTableForeachUserFunc ()"><span class="type">InfUserTableForeachUserFunc</span></a> func</code></em>,
<em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>);</pre>
<p>
Calls the given function for each user in the user_table. You should not
add or remove users while this function is being executed.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_table</code></em> :</span></p></td>
<td>A <a class="link" href="InfUserTable.html" title="InfUserTable"><span class="type">InfUserTable</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>func</code></em> :</span></p></td>
<td>The function to call for each user.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td>User data to pass to the function.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="inf-user-table-foreach-local-user"></a><h3>inf_user_table_foreach_local_user ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> inf_user_table_foreach_local_user (<em class="parameter"><code><a class="link" href="InfUserTable.html" title="InfUserTable"><span class="type">InfUserTable</span></a> *user_table</code></em>,
<em class="parameter"><code><a class="link" href="InfUserTable.html#InfUserTableForeachUserFunc" title="InfUserTableForeachUserFunc ()"><span class="type">InfUserTableForeachUserFunc</span></a> func</code></em>,
<em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>);</pre>
<p>
Calls the given function for each local user in the user_table. A local
user is a user that has the <a class="link" href="InfUser.html#INF-USER-LOCAL:CAPS"><code class="literal">INF_USER_LOCAL</code></a> flag set and that has not
status <a class="link" href="InfUser.html#INF-USER-UNAVAILABLE:CAPS"><code class="literal">INF_USER_UNAVAILABLE</code></a>. You should not add or remove users while this
function is being executed.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_table</code></em> :</span></p></td>
<td>A <a class="link" href="InfUserTable.html" title="InfUserTable"><span class="type">InfUserTable</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>func</code></em> :</span></p></td>
<td>The function to call for each user.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td>User data to pass to the function.</td>
</tr>
</tbody>
</table></div>
</div>
</div>
<div class="refsect1">
<a name="InfUserTable.signal-details"></a><h2>Signal Details</h2>
<div class="refsect2">
<a name="InfUserTable-add-local-user"></a><h3>The <code class="literal">"add-local-user"</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span> user_function (<a class="link" href="InfUserTable.html" title="InfUserTable"><span class="type">InfUserTable</span></a> *user_table,
<a class="link" href="InfUser.html" title="InfUser"><span class="type">InfUser</span></a> *user,
<span class="type">gpointer</span> user_data) : <code class="literal">Run Last</code></pre>
<p>
This signal is emitted when a user is added to the user table and has the
<a class="link" href="InfUser.html#INF-USER-LOCAL:CAPS"><code class="literal">INF_USER_LOCAL</code></a> flag set. In this case, <a class="link" href="InfUserTable.html#InfUserTable-add-user" title='The "add-user" signal'><span class="type">"add-user"</span></a> is
emitted as well.
</p>
<p>
This signal is also emitted when an existing user receives the
<a class="link" href="InfUser.html#INF-USER-LOCAL:CAPS"><code class="literal">INF_USER_LOCAL</code></a> flag. This occurs when a user rejoins locally after
leaving the session (possibly having the <a class="link" href="InfUser.html#INF-USER-LOCAL:CAPS"><code class="literal">INF_USER_LOCAL</code></a> flag removed
during their absence). <a class="link" href="InfUserTable.html#InfUserTable-add-user" title='The "add-user" signal'><span class="type">"add-user"</span></a> is not emitted in this
case.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_table</code></em> :</span></p></td>
<td>The <a class="link" href="InfUserTable.html" title="InfUserTable"><span class="type">InfUserTable</span></a> in which <em class="parameter"><code>user</code></em> has been set as local</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user</code></em> :</span></p></td>
<td>The <a class="link" href="InfUser.html" title="InfUser"><span class="type">InfUser</span></a> that has set as local</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td>user data set when the signal handler was connected.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="InfUserTable-add-user"></a><h3>The <code class="literal">"add-user"</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span> user_function (<a class="link" href="InfUserTable.html" title="InfUserTable"><span class="type">InfUserTable</span></a> *user_table,
<a class="link" href="InfUser.html" title="InfUser"><span class="type">InfUser</span></a> *user,
<span class="type">gpointer</span> user_data) : <code class="literal">Run Last</code></pre>
<p>
This signal is emitted when <a class="link" href="InfUserTable.html#inf-user-table-add-user" title="inf_user_table_add_user ()"><code class="function">inf_user_table_add_user()</code></a> is called. Note
that this does not happen if <em class="parameter"><code>user</code></em> rejoins the session and has already
been added to <em class="parameter"><code>user_table</code></em> previously.
</p>
<p>
<a class="link" href="InfUserTable.html#InfUserTable-add-local-user" title='The "add-local-user" signal'><span class="type">"add-local-user"</span></a> may also be emitted at this point if
<em class="parameter"><code>user</code></em> has the <a class="link" href="InfUser.html#INF-USER-LOCAL:CAPS"><code class="literal">INF_USER_LOCAL</code></a> flag set.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_table</code></em> :</span></p></td>
<td>The <a class="link" href="InfUserTable.html" title="InfUserTable"><span class="type">InfUserTable</span></a> into which <em class="parameter"><code>user</code></em> has been added</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user</code></em> :</span></p></td>
<td>The <a class="link" href="InfUser.html" title="InfUser"><span class="type">InfUser</span></a> that has been added into <em class="parameter"><code>user_table</code></em>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td>user data set when the signal handler was connected.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="InfUserTable-remove-local-user"></a><h3>The <code class="literal">"remove-local-user"</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span> user_function (<a class="link" href="InfUserTable.html" title="InfUserTable"><span class="type">InfUserTable</span></a> *user_table,
<a class="link" href="InfUser.html" title="InfUser"><span class="type">InfUser</span></a> *user,
<span class="type">gpointer</span> user_data) : <code class="literal">Run Last</code></pre>
<p>
This signal is emitted when a user is removed from the user table and
had the <a class="link" href="InfUser.html#INF-USER-LOCAL:CAPS"><code class="literal">INF_USER_LOCAL</code></a> flag set. In this case,
<a class="link" href="InfUserTable.html#InfUserTable-remove-user" title='The "remove-user" signal'><span class="type">"remove-user"</span></a> is emitted as well.
</p>
<p>
This signal is also emitted when <em class="parameter"><code>user</code></em> loses the <a class="link" href="InfUser.html#INF-USER-LOCAL:CAPS"><code class="literal">INF_USER_LOCAL</code></a> flag.
This occurs when the local <em class="parameter"><code>user</code></em> leaves the session.
<a class="link" href="InfUserTable.html#InfUserTable-remove-user" title='The "remove-user" signal'><span class="type">"remove-user"</span></a> is not emitted and the status of <em class="parameter"><code>user</code></em> is set
to <a class="link" href="InfUser.html#INF-USER-UNAVAILABLE:CAPS"><code class="literal">INF_USER_UNAVAILABLE</code></a>.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_table</code></em> :</span></p></td>
<td>The <a class="link" href="InfUserTable.html" title="InfUserTable"><span class="type">InfUserTable</span></a> in which <em class="parameter"><code>user</code></em> is no longer local</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user</code></em> :</span></p></td>
<td>The <a class="link" href="InfUser.html" title="InfUser"><span class="type">InfUser</span></a> that is no longer local</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td>user data set when the signal handler was connected.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="InfUserTable-remove-user"></a><h3>The <code class="literal">"remove-user"</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span> user_function (<a class="link" href="InfUserTable.html" title="InfUserTable"><span class="type">InfUserTable</span></a> *user_table,
<a class="link" href="InfUser.html" title="InfUser"><span class="type">InfUser</span></a> *user,
<span class="type">gpointer</span> user_data) : <code class="literal">Run Last</code></pre>
<p>
This signal is emitted when <a class="link" href="InfUserTable.html#inf-user-table-remove-user" title="inf_user_table_remove_user ()"><code class="function">inf_user_table_remove_user()</code></a> is called. This
does not usually happen, as users leaving a session do not get removed
from the table.
</p>
<p>
<a class="link" href="InfUserTable.html#InfUserTable-remove-local-user" title='The "remove-local-user" signal'><span class="type">"remove-local-user"</span></a> may also be emitted at this point if
<em class="parameter"><code>user</code></em> has the <a class="link" href="InfUser.html#INF-USER-LOCAL:CAPS"><code class="literal">INF_USER_LOCAL</code></a> flag set.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_table</code></em> :</span></p></td>
<td>The <a class="link" href="InfUserTable.html" title="InfUserTable"><span class="type">InfUserTable</span></a> from which <em class="parameter"><code>user</code></em> has been remove</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user</code></em> :</span></p></td>
<td>The <a class="link" href="InfUser.html" title="InfUser"><span class="type">InfUser</span></a> that has been removed from <em class="parameter"><code>user_table</code></em>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td>user data set when the signal handler was connected.</td>
</tr>
</tbody>
</table></div>
</div>
</div>
<div class="refsect1">
<a name="InfUserTable.see-also"></a><h2>See Also</h2>
<a class="link" href="InfUser.html" title="InfUser"><span class="type">InfUser</span></a>, <a class="link" href="InfSession.html" title="InfSession"><span class="type">InfSession</span></a>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.19</div>
</body>
</html>
|