libinfinity-0.6-doc 0.6.7-2 / usr / share / gtk-doc / html / libinfinity-0.6 / InfCommunicationMethod.html

This file is indexed.

/usr/share/gtk-doc/html/libinfinity-0.6/InfCommunicationMethod.html is in libinfinity-0.6-doc 0.6.7-2.

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
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>InfCommunicationMethod: libinfinity-0.6 Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="index.html" title="libinfinity-0.6 Reference Manual">
<link rel="up" href="ch06.html" title="Network abstraction">
<link rel="prev" href="InfCommunicationFactory.html" title="InfCommunicationFactory">
<link rel="next" href="InfCommunicationRegistry.html" title="InfCommunicationRegistry">
<meta name="generator" content="GTK-Doc V1.25 (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="5"><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="#InfCommunicationMethod.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span> 
                  <a href="#InfCommunicationMethod.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_prerequisites">  <span class="dim">|</span> 
                  <a href="#InfCommunicationMethod.prerequisites" class="shortcut">Prerequisites</a></span><span id="nav_implementations">  <span class="dim">|</span> 
                  <a href="#InfCommunicationMethod.implementations" class="shortcut">Known Implementations</a></span><span id="nav_signals">  <span class="dim">|</span> 
                  <a href="#InfCommunicationMethod.signals" class="shortcut">Signals</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="ch06.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="InfCommunicationFactory.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="InfCommunicationRegistry.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="InfCommunicationMethod"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="InfCommunicationMethod.top_of_page"></a>InfCommunicationMethod</span></h2>
<p>InfCommunicationMethod — Network communication method</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="InfCommunicationMethod.stability-level"></a><h2>Stability Level</h2>
<a href="http://foldoc.org/Unstable"><span class="acronym">Unstable</span></a>, unless otherwise indicated
</div>
<div class="refsect1">
<a name="InfCommunicationMethod.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" 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">void</span>
</td>
<td class="function_name">
<a class="link" href="InfCommunicationMethod.html#inf-communication-method-add-member" title="inf_communication_method_add_member ()">inf_communication_method_add_member</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="InfCommunicationMethod.html#inf-communication-method-remove-member" title="inf_communication_method_remove_member ()">inf_communication_method_remove_member</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="InfCommunicationMethod.html#inf-communication-method-is-member" title="inf_communication_method_is_member ()">inf_communication_method_is_member</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="InfCommunicationMethod.html#inf-communication-method-send-single" title="inf_communication_method_send_single ()">inf_communication_method_send_single</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="InfCommunicationMethod.html#inf-communication-method-send-all" title="inf_communication_method_send_all ()">inf_communication_method_send_all</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="InfCommunicationMethod.html#inf-communication-method-cancel-messages" title="inf_communication_method_cancel_messages ()">inf_communication_method_cancel_messages</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="InfCommunicationObject.html#InfCommunicationScope" title="enum InfCommunicationScope"><span class="returnvalue">InfCommunicationScope</span></a>
</td>
<td class="function_name">
<a class="link" href="InfCommunicationMethod.html#inf-communication-method-received" title="inf_communication_method_received ()">inf_communication_method_received</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="InfCommunicationMethod.html#inf-communication-method-enqueued" title="inf_communication_method_enqueued ()">inf_communication_method_enqueued</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="InfCommunicationMethod.html#inf-communication-method-sent" title="inf_communication_method_sent ()">inf_communication_method_sent</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="InfCommunicationMethod.signals"></a><h2>Signals</h2>
<div class="informaltable"><table class="informaltable" border="0">
<colgroup>
<col width="150px" class="signals_return">
<col width="300px" class="signals_name">
<col width="200px" class="signals_flags">
</colgroup>
<tbody>
<tr>
<td class="signal_type"><span class="returnvalue">void</span></td>
<td class="signal_name"><a class="link" href="InfCommunicationMethod.html#InfCommunicationMethod-add-member" title="The “add-member” signal">add-member</a></td>
<td class="signal_flags">Run Last</td>
</tr>
<tr>
<td class="signal_type"><span class="returnvalue">void</span></td>
<td class="signal_name"><a class="link" href="InfCommunicationMethod.html#InfCommunicationMethod-remove-member" title="The “remove-member” signal">remove-member</a></td>
<td class="signal_flags">Run Last</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="InfCommunicationMethod.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table class="informaltable" 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="InfCommunicationMethod.html#InfCommunicationMethod-struct" title="InfCommunicationMethod">InfCommunicationMethod</a></td>
</tr>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="InfCommunicationMethod.html#InfCommunicationMethodIface" title="struct InfCommunicationMethodIface">InfCommunicationMethodIface</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="InfCommunicationMethod.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen">    <a href="/usr/share/gtk-doc/html/gobject/GTypeModule.html">GInterface</a>
    <span class="lineart">╰──</span> InfCommunicationMethod
</pre>
</div>
<div class="refsect1">
<a name="InfCommunicationMethod.prerequisites"></a><h2>Prerequisites</h2>
<p>
InfCommunicationMethod requires
 GObject.</p>
</div>
<div class="refsect1">
<a name="InfCommunicationMethod.implementations"></a><h2>Known Implementations</h2>
<p>
InfCommunicationMethod is implemented by
 <a class="link" href="InfCommunicationCentralMethod.html" title="InfCommunicationCentralMethod">InfCommunicationCentralMethod</a>.</p>
</div>
<div class="refsect1">
<a name="InfCommunicationMethod.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include &lt;libinfinity/communication/inf-communication-method.h&gt;
</pre>
</div>
<div class="refsect1">
<a name="InfCommunicationMethod.description"></a><h2>Description</h2>
<p>A <a class="link" href="InfCommunicationMethod.html" title="InfCommunicationMethod"><span class="type">InfCommunicationMethod</span></a> specifies how messages are transferred between
group members on the same network. So one method handles all connections
on a specific network for the group.</p>
</div>
<div class="refsect1">
<a name="InfCommunicationMethod.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="inf-communication-method-add-member"></a><h3>inf_communication_method_add_member ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
inf_communication_method_add_member (<em class="parameter"><code><a class="link" href="InfCommunicationMethod.html" title="InfCommunicationMethod"><span class="type">InfCommunicationMethod</span></a> *method</code></em>,
                                     <em class="parameter"><code><a class="link" href="InfXmlConnection.html" title="InfXmlConnection"><span class="type">InfXmlConnection</span></a> *connection</code></em>);</pre>
<p>Adds a new connection to the group. The network of <em class="parameter"><code>connection</code></em>
 must match
the network the method is handling, and <em class="parameter"><code>connection</code></em>
 must not already be
a member of the group (see <a class="link" href="InfCommunicationMethod.html#inf-communication-method-is-member" title="inf_communication_method_is_member ()"><code class="function">inf_communication_method_is_member()</code></a>).</p>
<div class="refsect3">
<a name="inf-communication-method-add-member.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" 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>method</p></td>
<td class="parameter_description"><p>A <a class="link" href="InfCommunicationMethod.html" title="InfCommunicationMethod"><span class="type">InfCommunicationMethod</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>connection</p></td>
<td class="parameter_description"><p>The <a class="link" href="InfXmlConnection.html" title="InfXmlConnection"><span class="type">InfXmlConnection</span></a> to add.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="inf-communication-method-remove-member"></a><h3>inf_communication_method_remove_member ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
inf_communication_method_remove_member
                               (<em class="parameter"><code><a class="link" href="InfCommunicationMethod.html" title="InfCommunicationMethod"><span class="type">InfCommunicationMethod</span></a> *method</code></em>,
                                <em class="parameter"><code><a class="link" href="InfXmlConnection.html" title="InfXmlConnection"><span class="type">InfXmlConnection</span></a> *connection</code></em>);</pre>
<p>Removes a connection from the group. <em class="parameter"><code>connection</code></em>
 needs to be a member of
the group (see <a class="link" href="InfCommunicationMethod.html#inf-communication-method-is-member" title="inf_communication_method_is_member ()"><code class="function">inf_communication_method_is_member()</code></a>).</p>
<div class="refsect3">
<a name="inf-communication-method-remove-member.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" 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>method</p></td>
<td class="parameter_description"><p>A <a class="link" href="InfCommunicationMethod.html" title="InfCommunicationMethod"><span class="type">InfCommunicationMethod</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>connection</p></td>
<td class="parameter_description"><p>The <a class="link" href="InfXmlConnection.html" title="InfXmlConnection"><span class="type">InfXmlConnection</span></a> to remove.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="inf-communication-method-is-member"></a><h3>inf_communication_method_is_member ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
inf_communication_method_is_member (<em class="parameter"><code><a class="link" href="InfCommunicationMethod.html" title="InfCommunicationMethod"><span class="type">InfCommunicationMethod</span></a> *method</code></em>,
                                    <em class="parameter"><code><a class="link" href="InfXmlConnection.html" title="InfXmlConnection"><span class="type">InfXmlConnection</span></a> *connection</code></em>);</pre>
<p>Returns whether <em class="parameter"><code>connection</code></em>
 was added to the group via
<a class="link" href="InfCommunicationMethod.html#inf-communication-method-add-member" title="inf_communication_method_add_member ()"><code class="function">inf_communication_method_add_member()</code></a>.</p>
<div class="refsect3">
<a name="inf-communication-method-is-member.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" 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>method</p></td>
<td class="parameter_description"><p>A <a class="link" href="InfCommunicationMethod.html" title="InfCommunicationMethod"><span class="type">InfCommunicationMethod</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>connection</p></td>
<td class="parameter_description"><p>A <a class="link" href="InfXmlConnection.html" title="InfXmlConnection"><span class="type">InfXmlConnection</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="inf-communication-method-is-member.returns"></a><h4>Returns</h4>
<p> Whether <em class="parameter"><code>connection</code></em>
is a member of the group.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="inf-communication-method-send-single"></a><h3>inf_communication_method_send_single ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
inf_communication_method_send_single (<em class="parameter"><code><a class="link" href="InfCommunicationMethod.html" title="InfCommunicationMethod"><span class="type">InfCommunicationMethod</span></a> *method</code></em>,
                                      <em class="parameter"><code><a class="link" href="InfXmlConnection.html" title="InfXmlConnection"><span class="type">InfXmlConnection</span></a> *connection</code></em>,
                                      <em class="parameter"><code><span class="type">xmlNodePtr</span> xml</code></em>);</pre>
<p>Sends an XML message to <em class="parameter"><code>connection</code></em>
. This function takes ownership of <em class="parameter"><code>xml</code></em>
.</p>
<div class="refsect3">
<a name="inf-communication-method-send-single.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" 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>method</p></td>
<td class="parameter_description"><p>A <a class="link" href="InfCommunicationMethod.html" title="InfCommunicationMethod"><span class="type">InfCommunicationMethod</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>connection</p></td>
<td class="parameter_description"><p>A <a class="link" href="InfXmlConnection.html" title="InfXmlConnection"><span class="type">InfXmlConnection</span></a> that is a group member.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>xml</p></td>
<td class="parameter_description"><p>The message to send.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="inf-communication-method-send-all"></a><h3>inf_communication_method_send_all ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
inf_communication_method_send_all (<em class="parameter"><code><a class="link" href="InfCommunicationMethod.html" title="InfCommunicationMethod"><span class="type">InfCommunicationMethod</span></a> *method</code></em>,
                                   <em class="parameter"><code><span class="type">xmlNodePtr</span> xml</code></em>);</pre>
<p>Sends an XML message to all group members on this network. This function
takes ownership of <em class="parameter"><code>xml</code></em>
.</p>
<div class="refsect3">
<a name="inf-communication-method-send-all.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" 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>method</p></td>
<td class="parameter_description"><p>A <a class="link" href="InfCommunicationMethod.html" title="InfCommunicationMethod"><span class="type">InfCommunicationMethod</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>xml</p></td>
<td class="parameter_description"><p>The message to send.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="inf-communication-method-cancel-messages"></a><h3>inf_communication_method_cancel_messages ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
inf_communication_method_cancel_messages
                               (<em class="parameter"><code><a class="link" href="InfCommunicationMethod.html" title="InfCommunicationMethod"><span class="type">InfCommunicationMethod</span></a> *method</code></em>,
                                <em class="parameter"><code><a class="link" href="InfXmlConnection.html" title="InfXmlConnection"><span class="type">InfXmlConnection</span></a> *connection</code></em>);</pre>
<p>This function stops all messages to be sent to <em class="parameter"><code>connection</code></em>
 that have not
yet been sent.</p>
<div class="refsect3">
<a name="inf-communication-method-cancel-messages.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" 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>method</p></td>
<td class="parameter_description"><p>A <a class="link" href="InfCommunicationMethod.html" title="InfCommunicationMethod"><span class="type">InfCommunicationMethod</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>connection</p></td>
<td class="parameter_description"><p>A <a class="link" href="InfXmlConnection.html" title="InfXmlConnection"><span class="type">InfXmlConnection</span></a> that is a group member.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="inf-communication-method-received"></a><h3>inf_communication_method_received ()</h3>
<pre class="programlisting"><a class="link" href="InfCommunicationObject.html#InfCommunicationScope" title="enum InfCommunicationScope"><span class="returnvalue">InfCommunicationScope</span></a>
inf_communication_method_received (<em class="parameter"><code><a class="link" href="InfCommunicationMethod.html" title="InfCommunicationMethod"><span class="type">InfCommunicationMethod</span></a> *method</code></em>,
                                   <em class="parameter"><code><a class="link" href="InfXmlConnection.html" title="InfXmlConnection"><span class="type">InfXmlConnection</span></a> *connection</code></em>,
                                   <em class="parameter"><code><span class="type">xmlNodePtr</span> xml</code></em>);</pre>
<p>This function is called by the <a class="link" href="InfCommunicationRegistry.html" title="InfCommunicationRegistry"><span class="type">InfCommunicationRegistry</span></a> if data has been
received on registered connections
(see <a class="link" href="InfCommunicationRegistry.html#inf-communication-registry-register" title="inf_communication_registry_register ()"><code class="function">inf_communication_registry_register()</code></a>).</p>
<p>This function returns the scope of the message. If the scope is
<a class="link" href="InfCommunicationObject.html#INF-COMMUNICATION-SCOPE-GROUP:CAPS"><code class="literal">INF_COMMUNICATION_SCOPE_GROUP</code></a> then the registry relays the message to
other connections on different networks (if any).</p>
<div class="refsect3">
<a name="inf-communication-method-received.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" 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>method</p></td>
<td class="parameter_description"><p>A <a class="link" href="InfCommunicationMethod.html" title="InfCommunicationMethod"><span class="type">InfCommunicationMethod</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>connection</p></td>
<td class="parameter_description"><p>A <a class="link" href="InfXmlConnection.html" title="InfXmlConnection"><span class="type">InfXmlConnection</span></a> that is a group member.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>xml</p></td>
<td class="parameter_description"><p>The received message.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="inf-communication-method-received.returns"></a><h4>Returns</h4>
<p> The scope of the message.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="inf-communication-method-enqueued"></a><h3>inf_communication_method_enqueued ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
inf_communication_method_enqueued (<em class="parameter"><code><a class="link" href="InfCommunicationMethod.html" title="InfCommunicationMethod"><span class="type">InfCommunicationMethod</span></a> *method</code></em>,
                                   <em class="parameter"><code><a class="link" href="InfXmlConnection.html" title="InfXmlConnection"><span class="type">InfXmlConnection</span></a> *connection</code></em>,
                                   <em class="parameter"><code><span class="type">xmlNodePtr</span> xml</code></em>);</pre>
<p>This function is called by the <a class="link" href="InfCommunicationRegistry.html" title="InfCommunicationRegistry"><span class="type">InfCommunicationRegistry</span></a> if data has been
enqueued on registered connections
(see <a class="link" href="InfCommunicationRegistry.html#inf-communication-registry-register" title="inf_communication_registry_register ()"><code class="function">inf_communication_registry_register()</code></a>).</p>
<div class="refsect3">
<a name="inf-communication-method-enqueued.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" 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>method</p></td>
<td class="parameter_description"><p>A <a class="link" href="InfCommunicationMethod.html" title="InfCommunicationMethod"><span class="type">InfCommunicationMethod</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>connection</p></td>
<td class="parameter_description"><p>A <a class="link" href="InfXmlConnection.html" title="InfXmlConnection"><span class="type">InfXmlConnection</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>xml</p></td>
<td class="parameter_description"><p>The enqueued message.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="inf-communication-method-sent"></a><h3>inf_communication_method_sent ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
inf_communication_method_sent (<em class="parameter"><code><a class="link" href="InfCommunicationMethod.html" title="InfCommunicationMethod"><span class="type">InfCommunicationMethod</span></a> *method</code></em>,
                               <em class="parameter"><code><a class="link" href="InfXmlConnection.html" title="InfXmlConnection"><span class="type">InfXmlConnection</span></a> *connection</code></em>,
                               <em class="parameter"><code><span class="type">xmlNodePtr</span> xml</code></em>);</pre>
<p>This function is called by the <a class="link" href="InfCommunicationRegistry.html" title="InfCommunicationRegistry"><span class="type">InfCommunicationRegistry</span></a> if data has been
sent on registered connections (see <a class="link" href="InfCommunicationRegistry.html#inf-communication-registry-register" title="inf_communication_registry_register ()"><code class="function">inf_communication_registry_register()</code></a>).</p>
<div class="refsect3">
<a name="inf-communication-method-sent.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" 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>method</p></td>
<td class="parameter_description"><p>A <a class="link" href="InfCommunicationMethod.html" title="InfCommunicationMethod"><span class="type">InfCommunicationMethod</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>connection</p></td>
<td class="parameter_description"><p>A <a class="link" href="InfXmlConnection.html" title="InfXmlConnection"><span class="type">InfXmlConnection</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>xml</p></td>
<td class="parameter_description"><p>The sent message.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="refsect1">
<a name="InfCommunicationMethod.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="InfCommunicationMethod-struct"></a><h3>InfCommunicationMethod</h3>
<pre class="programlisting">typedef struct _InfCommunicationMethod InfCommunicationMethod;</pre>
<p><a class="link" href="InfCommunicationMethod.html" title="InfCommunicationMethod"><span class="type">InfCommunicationMethod</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="InfCommunicationMethodIface"></a><h3>struct InfCommunicationMethodIface</h3>
<pre class="programlisting">struct InfCommunicationMethodIface {
  /* Signals */
  void (*add_member)(InfCommunicationMethod* method,
                     InfXmlConnection* connection);
  void (*remove_member)(InfCommunicationMethod* method,
                        InfXmlConnection* connection);

  /* Virtual functions */
  gboolean (*is_member)(InfCommunicationMethod* method,
                        InfXmlConnection* connection);

  void (*send_single)(InfCommunicationMethod* method,
                      InfXmlConnection* connection,
                      xmlNodePtr xml);
  void (*send_all)(InfCommunicationMethod* method,
                   xmlNodePtr xml);
  void (*cancel_messages)(InfCommunicationMethod* method,
                          InfXmlConnection* connection);

  InfCommunicationScope (*received)(InfCommunicationMethod* method,
                                    InfXmlConnection* connection,
                                    xmlNodePtr xml);
  void (*enqueued)(InfCommunicationMethod* method,
                   InfXmlConnection* connection,
                   xmlNodePtr xml);
  void (*sent)(InfCommunicationMethod* method,
               InfXmlConnection* connection,
               xmlNodePtr xml);
};
</pre>
<p>The default signal handlers of virtual methods of <a class="link" href="InfCommunicationMethod.html" title="InfCommunicationMethod"><span class="type">InfCommunicationMethod</span></a>.
These implement communication within a <a class="link" href="InfCommunicationGroup.html" title="InfCommunicationGroup"><span class="type">InfCommunicationGroup</span></a>.</p>
<div class="refsect3">
<a name="InfCommunicationMethodIface.members"></a><h4>Members</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="300px" class="struct_members_name">
<col class="struct_members_description">
<col width="200px" class="struct_members_annotations">
</colgroup>
<tbody>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="InfCommunicationMethodIface.add-member"></a>add_member</code></em> ()</p></td>
<td class="struct_member_description"><p>Default signal handler of the
<a class="link" href="InfCommunicationMethod.html#InfCommunicationMethod-add-member" title="The “add-member” signal"><span class="type">“add-member”</span></a> signal.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="InfCommunicationMethodIface.remove-member"></a>remove_member</code></em> ()</p></td>
<td class="struct_member_description"><p>Default signal handler of the
<a class="link" href="InfCommunicationMethod.html#InfCommunicationMethod-remove-member" title="The “remove-member” signal"><span class="type">“remove-member”</span></a> signal.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="InfCommunicationMethodIface.is-member"></a>is_member</code></em> ()</p></td>
<td class="struct_member_description"><p>Returns whether the given connection is a member of the group.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="InfCommunicationMethodIface.send-single"></a>send_single</code></em> ()</p></td>
<td class="struct_member_description"><p>Sends a message to a single connection. Takes ownership of
<em class="parameter"><code>xml</code></em>
.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="InfCommunicationMethodIface.send-all"></a>send_all</code></em> ()</p></td>
<td class="struct_member_description"><p>Sends a message to all group members, except <em class="parameter"><code>except</code></em>
. Takes
ownership of <em class="parameter"><code>xml</code></em>
.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="InfCommunicationMethodIface.cancel-messages"></a>cancel_messages</code></em> ()</p></td>
<td class="struct_member_description"><p>Cancel sending messages that have not yet been sent
to the given connection.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="InfCommunicationMethodIface.received"></a>received</code></em> ()</p></td>
<td class="struct_member_description"><p>Handles reception of a message from a registered connection.
This normally includes informing a group's NetObject and forwarding the
message to other group members.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="InfCommunicationMethodIface.enqueued"></a>enqueued</code></em> ()</p></td>
<td class="struct_member_description"><p>Handles when a message has been enqueued to be sent on a
registered connection.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="InfCommunicationMethodIface.sent"></a>sent</code></em> ()</p></td>
<td class="struct_member_description"><p>Handles when a message has been sent to a registered connection.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="refsect1">
<a name="InfCommunicationMethod.signal-details"></a><h2>Signal Details</h2>
<div class="refsect2">
<a name="InfCommunicationMethod-add-member"></a><h3>The <code class="literal">“add-member”</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
user_function (<a class="link" href="InfCommunicationMethod.html" title="InfCommunicationMethod"><span class="type">InfCommunicationMethod</span></a> *method,
               <a class="link" href="InfXmlConnection.html" title="InfXmlConnection"><span class="type">InfXmlConnection</span></a>       *connection,
               <span class="type">gpointer</span>                user_data)</pre>
<p>This signal is emitted whenever a new connection has been added to the
group on the network this method handles.</p>
<div class="refsect3">
<a name="InfCommunicationMethod-add-member.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" 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>method</p></td>
<td class="parameter_description"><p>The <a class="link" href="InfCommunicationMethod.html" title="InfCommunicationMethod"><span class="type">InfCommunicationMethod</span></a> emitting the signal.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>connection</p></td>
<td class="parameter_description"><p>The <a class="link" href="InfXmlConnection.html" title="InfXmlConnection"><span class="type">InfXmlConnection</span></a> that was added.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p>Flags: Run Last</p>
</div>
<hr>
<div class="refsect2">
<a name="InfCommunicationMethod-remove-member"></a><h3>The <code class="literal">“remove-member”</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
user_function (<a class="link" href="InfCommunicationMethod.html" title="InfCommunicationMethod"><span class="type">InfCommunicationMethod</span></a> *method,
               <a class="link" href="InfXmlConnection.html" title="InfXmlConnection"><span class="type">InfXmlConnection</span></a>       *connection,
               <span class="type">gpointer</span>                user_data)</pre>
<p>This signal is emitted whenever a connection has been removed from the
group on the network this method handles.</p>
<div class="refsect3">
<a name="InfCommunicationMethod-remove-member.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" 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>method</p></td>
<td class="parameter_description"><p>The <a class="link" href="InfCommunicationMethod.html" title="InfCommunicationMethod"><span class="type">InfCommunicationMethod</span></a> emitting the signal.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>connection</p></td>
<td class="parameter_description"><p>The <a class="link" href="InfXmlConnection.html" title="InfXmlConnection"><span class="type">InfXmlConnection</span></a> that was removed.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p>Flags: Run Last</p>
</div>
</div>
<div class="refsect1">
<a name="InfCommunicationMethod.see-also"></a><h2>See Also</h2>
<p><a class="link" href="InfCommunicationManager.html" title="InfCommunicationManager"><span class="type">InfCommunicationManager</span></a></p>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.25</div>
</body>
</html>

APT Browse - Built by Thomas Orozco.