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
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>TpStreamTubeChannel</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="index.html" title="telepathy-glib API Reference Manual">
<link rel="up" href="ch-client.html" title="Client-side proxies">
<link rel="prev" href="telepathy-glib-account-channel-request.html" title="TpAccountChannelRequest">
<link rel="next" href="telepathy-glib-stream-tube-connection.html" title="TpStreamTubeConnection">
<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="telepathy-glib-account-channel-request.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch-client.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">telepathy-glib API Reference Manual</th>
<td><a accesskey="n" href="telepathy-glib-stream-tube-connection.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#telepathy-glib-stream-tube-channel.synopsis" class="shortcut">Top</a>
|
<a href="#telepathy-glib-stream-tube-channel.description" class="shortcut">Description</a>
|
<a href="#telepathy-glib-stream-tube-channel.object-hierarchy" class="shortcut">Object Hierarchy</a>
|
<a href="#telepathy-glib-stream-tube-channel.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
|
<a href="#telepathy-glib-stream-tube-channel.properties" class="shortcut">Properties</a>
|
<a href="#telepathy-glib-stream-tube-channel.signals" class="shortcut">Signals</a>
</td></tr>
</table>
<div class="refentry">
<a name="telepathy-glib-stream-tube-channel"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="telepathy-glib-stream-tube-channel.top_of_page"></a>TpStreamTubeChannel</span></h2>
<p>TpStreamTubeChannel — proxy object for a stream tube channel</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="telepathy-glib-stream-tube-channel.synopsis"></a><h2>Synopsis</h2>
<a name="TpStreamTubeChannel"></a><pre class="synopsis">
#include <telepathy-glib/telepathy-glib.h>
struct <a class="link" href="telepathy-glib-stream-tube-channel.html#TpStreamTubeChannel-struct" title="struct TpStreamTubeChannel">TpStreamTubeChannel</a>;
struct <a class="link" href="telepathy-glib-stream-tube-channel.html#TpStreamTubeChannelClass" title="struct TpStreamTubeChannelClass">TpStreamTubeChannelClass</a>;
<span class="returnvalue">void</span> <a class="link" href="telepathy-glib-stream-tube-channel.html#tp-stream-tube-channel-accept-async" title="tp_stream_tube_channel_accept_async ()">tp_stream_tube_channel_accept_async</a> (<em class="parameter"><code><a class="link" href="telepathy-glib-stream-tube-channel.html#TpStreamTubeChannel"><span class="type">TpStreamTubeChannel</span></a> *self</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/gio/unstable/GAsyncResult.html#GAsyncReadyCallback"><span class="type">GAsyncReadyCallback</span></a> callback</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>);
<a class="link" href="telepathy-glib-stream-tube-connection.html#TpStreamTubeConnection"><span class="returnvalue">TpStreamTubeConnection</span></a> * <a class="link" href="telepathy-glib-stream-tube-channel.html#tp-stream-tube-channel-accept-finish" title="tp_stream_tube_channel_accept_finish ()">tp_stream_tube_channel_accept_finish</a>
(<em class="parameter"><code><a class="link" href="telepathy-glib-stream-tube-channel.html#TpStreamTubeChannel"><span class="type">TpStreamTubeChannel</span></a> *self</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/gio/unstable/GAsyncResult.html"><span class="type">GAsyncResult</span></a> *result</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
<a href="http://library.gnome.org/devel/glib/unstable/glib-Hash-Tables.html#GHashTable"><span class="returnvalue">GHashTable</span></a> * <a class="link" href="telepathy-glib-stream-tube-channel.html#tp-stream-tube-channel-get-parameters" title="tp_stream_tube_channel_get_parameters ()">tp_stream_tube_channel_get_parameters</a>
(<em class="parameter"><code><a class="link" href="telepathy-glib-stream-tube-channel.html#TpStreamTubeChannel"><span class="type">TpStreamTubeChannel</span></a> *self</code></em>);
<a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#GVariant"><span class="returnvalue">GVariant</span></a> * <a class="link" href="telepathy-glib-stream-tube-channel.html#tp-stream-tube-channel-dup-parameters-vardict" title="tp_stream_tube_channel_dup_parameters_vardict ()">tp_stream_tube_channel_dup_parameters_vardict</a>
(<em class="parameter"><code><a class="link" href="telepathy-glib-stream-tube-channel.html#TpStreamTubeChannel"><span class="type">TpStreamTubeChannel</span></a> *self</code></em>);
const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * <a class="link" href="telepathy-glib-stream-tube-channel.html#tp-stream-tube-channel-get-service" title="tp_stream_tube_channel_get_service ()">tp_stream_tube_channel_get_service</a> (<em class="parameter"><code><a class="link" href="telepathy-glib-stream-tube-channel.html#TpStreamTubeChannel"><span class="type">TpStreamTubeChannel</span></a> *self</code></em>);
<a class="link" href="telepathy-glib-stream-tube-channel.html#TpStreamTubeChannel"><span class="returnvalue">TpStreamTubeChannel</span></a> * <a class="link" href="telepathy-glib-stream-tube-channel.html#tp-stream-tube-channel-new" title="tp_stream_tube_channel_new ()">tp_stream_tube_channel_new</a> (<em class="parameter"><code><a class="link" href="telepathy-glib-connection.html#TpConnection"><span class="type">TpConnection</span></a> *conn</code></em>,
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *object_path</code></em>,
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Hash-Tables.html#GHashTable"><span class="type">GHashTable</span></a> *immutable_properties</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
<span class="returnvalue">void</span> <a class="link" href="telepathy-glib-stream-tube-channel.html#tp-stream-tube-channel-offer-async" title="tp_stream_tube_channel_offer_async ()">tp_stream_tube_channel_offer_async</a> (<em class="parameter"><code><a class="link" href="telepathy-glib-stream-tube-channel.html#TpStreamTubeChannel"><span class="type">TpStreamTubeChannel</span></a> *self</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Hash-Tables.html#GHashTable"><span class="type">GHashTable</span></a> *params</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/gio/unstable/GAsyncResult.html#GAsyncReadyCallback"><span class="type">GAsyncReadyCallback</span></a> callback</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>);
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="telepathy-glib-stream-tube-channel.html#tp-stream-tube-channel-offer-finish" title="tp_stream_tube_channel_offer_finish ()">tp_stream_tube_channel_offer_finish</a> (<em class="parameter"><code><a class="link" href="telepathy-glib-stream-tube-channel.html#TpStreamTubeChannel"><span class="type">TpStreamTubeChannel</span></a> *self</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/gio/unstable/GAsyncResult.html"><span class="type">GAsyncResult</span></a> *result</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="telepathy-glib-stream-tube-channel.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
<a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
+----<a class="link" href="telepathy-glib-proxy.html#TpProxy">TpProxy</a>
+----<a class="link" href="telepathy-glib-channel.html#TpChannel">TpChannel</a>
+----TpStreamTubeChannel
</pre>
</div>
<div class="refsect1">
<a name="telepathy-glib-stream-tube-channel.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
<p>
TpStreamTubeChannel implements
<a class="link" href="TpChannelIface.html" title="TpChannelIface">TpChannelIface</a>.</p>
</div>
<div class="refsect1">
<a name="telepathy-glib-stream-tube-channel.properties"></a><h2>Properties</h2>
<pre class="synopsis">
"<a class="link" href="telepathy-glib-stream-tube-channel.html#TpStreamTubeChannel--parameters" title='The "parameters" property'>parameters</a>" <span class="type">GHashTable_gchararray+GValue_*</span> : Read
"<a class="link" href="telepathy-glib-stream-tube-channel.html#TpStreamTubeChannel--parameters-vardict" title='The "parameters-vardict" property'>parameters-vardict</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#GVariant"><span class="type">GVariant</span></a>* : Read
"<a class="link" href="telepathy-glib-stream-tube-channel.html#TpStreamTubeChannel--service" title='The "service" property'>service</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read
</pre>
</div>
<div class="refsect1">
<a name="telepathy-glib-stream-tube-channel.signals"></a><h2>Signals</h2>
<pre class="synopsis">
"<a class="link" href="telepathy-glib-stream-tube-channel.html#TpStreamTubeChannel-incoming" title='The "incoming" signal'>incoming</a>" : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a>
</pre>
</div>
<div class="refsect1">
<a name="telepathy-glib-stream-tube-channel.description"></a><h2>Description</h2>
<p>
<a class="link" href="telepathy-glib-stream-tube-channel.html#TpStreamTubeChannel"><span class="type">TpStreamTubeChannel</span></a> is a sub-class of <a class="link" href="telepathy-glib-channel.html#TpChannel"><span class="type">TpChannel</span></a> providing convenient API
to offer and accept a stream tube.
</p>
</div>
<div class="refsect1">
<a name="telepathy-glib-stream-tube-channel.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="TpStreamTubeChannel-struct"></a><h3>struct TpStreamTubeChannel</h3>
<pre class="programlisting">struct TpStreamTubeChannel;</pre>
<p>
Data structure representing a <a class="link" href="telepathy-glib-stream-tube-channel.html#TpStreamTubeChannel"><span class="type">TpStreamTubeChannel</span></a>.
</p>
<p class="since">Since 0.13.2</p>
</div>
<hr>
<div class="refsect2">
<a name="TpStreamTubeChannelClass"></a><h3>struct TpStreamTubeChannelClass</h3>
<pre class="programlisting">struct TpStreamTubeChannelClass {
};
</pre>
<p>
The class of a <a class="link" href="telepathy-glib-stream-tube-channel.html#TpStreamTubeChannel"><span class="type">TpStreamTubeChannel</span></a>.
</p>
<p class="since">Since 0.13.2</p>
</div>
<hr>
<div class="refsect2">
<a name="tp-stream-tube-channel-accept-async"></a><h3>tp_stream_tube_channel_accept_async ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> tp_stream_tube_channel_accept_async (<em class="parameter"><code><a class="link" href="telepathy-glib-stream-tube-channel.html#TpStreamTubeChannel"><span class="type">TpStreamTubeChannel</span></a> *self</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/gio/unstable/GAsyncResult.html#GAsyncReadyCallback"><span class="type">GAsyncReadyCallback</span></a> callback</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>);</pre>
<p>
Accept an incoming stream tube. When the tube has been accepted, <em class="parameter"><code>callback</code></em>
will be called. You can then call <a class="link" href="telepathy-glib-stream-tube-channel.html#tp-stream-tube-channel-accept-finish" title="tp_stream_tube_channel_accept_finish ()"><code class="function">tp_stream_tube_channel_accept_finish()</code></a>
to get a <a class="link" href="telepathy-glib-stream-tube-connection.html#TpStreamTubeConnection"><span class="type">TpStreamTubeConnection</span></a> connected to the tube.
</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>self</code></em> :</span></p></td>
<td>an incoming <a class="link" href="telepathy-glib-stream-tube-channel.html#TpStreamTubeChannel"><span class="type">TpStreamTubeChannel</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>callback</code></em> :</span></p></td>
<td>a callback to call when the tube has been accepted</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td>data to pass to <em class="parameter"><code>callback</code></em>
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 0.13.2</p>
</div>
<hr>
<div class="refsect2">
<a name="tp-stream-tube-channel-accept-finish"></a><h3>tp_stream_tube_channel_accept_finish ()</h3>
<pre class="programlisting"><a class="link" href="telepathy-glib-stream-tube-connection.html#TpStreamTubeConnection"><span class="returnvalue">TpStreamTubeConnection</span></a> * tp_stream_tube_channel_accept_finish
(<em class="parameter"><code><a class="link" href="telepathy-glib-stream-tube-channel.html#TpStreamTubeChannel"><span class="type">TpStreamTubeChannel</span></a> *self</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/gio/unstable/GAsyncResult.html"><span class="type">GAsyncResult</span></a> *result</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
<p>
Finishes accepting an incoming stream tube. The returned
<a class="link" href="telepathy-glib-stream-tube-connection.html#TpStreamTubeConnection"><span class="type">TpStreamTubeConnection</span></a> can then be used to exchange data through the tube.
</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>self</code></em> :</span></p></td>
<td>a <a class="link" href="telepathy-glib-stream-tube-channel.html#TpStreamTubeChannel"><span class="type">TpStreamTubeChannel</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>result</code></em> :</span></p></td>
<td>a <a href="http://library.gnome.org/devel/gio/unstable/GAsyncResult.html"><span class="type">GAsyncResult</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td>a <a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> to fill</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a newly created <a class="link" href="telepathy-glib-stream-tube-connection.html#TpStreamTubeConnection"><span class="type">TpStreamTubeConnection</span></a>. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 0.13.2</p>
</div>
<hr>
<div class="refsect2">
<a name="tp-stream-tube-channel-get-parameters"></a><h3>tp_stream_tube_channel_get_parameters ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Hash-Tables.html#GHashTable"><span class="returnvalue">GHashTable</span></a> * tp_stream_tube_channel_get_parameters
(<em class="parameter"><code><a class="link" href="telepathy-glib-stream-tube-channel.html#TpStreamTubeChannel"><span class="type">TpStreamTubeChannel</span></a> *self</code></em>);</pre>
<p>
Return the <a class="link" href="telepathy-glib-stream-tube-channel.html#TpStreamTubeChannel--parameters" title='The "parameters" property'><span class="type">"parameters"</span></a> property
</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>self</code></em> :</span></p></td>
<td>a <a class="link" href="telepathy-glib-stream-tube-channel.html#TpStreamTubeChannel"><span class="type">TpStreamTubeChannel</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the value of <a class="link" href="telepathy-glib-stream-tube-channel.html#TpStreamTubeChannel--parameters" title='The "parameters" property'><span class="type">"parameters"</span></a>. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>][<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> utf8 GObject.Value]</span>
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 0.13.2</p>
</div>
<hr>
<div class="refsect2">
<a name="tp-stream-tube-channel-dup-parameters-vardict"></a><h3>tp_stream_tube_channel_dup_parameters_vardict ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#GVariant"><span class="returnvalue">GVariant</span></a> * tp_stream_tube_channel_dup_parameters_vardict
(<em class="parameter"><code><a class="link" href="telepathy-glib-stream-tube-channel.html#TpStreamTubeChannel"><span class="type">TpStreamTubeChannel</span></a> *self</code></em>);</pre>
<p>
Return the parameters of the dbus-tube channel in a variant of
type <a href="http://library.gnome.org/devel/glib/unstable/glib-GVariantType.html#G-VARIANT-TYPE-VARDICT:CAPS"><code class="literal">G_VARIANT_TYPE_VARDICT</code></a> whose keys are strings representing
parameter names and values are variants representing corresponding
parameter values set by the offerer when offering this channel.
</p>
<p>
The GVariant returned is <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if this is an outgoing tube that has not
yet been offered or the parameters property has not been set.
</p>
<p>
Use <a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#g-variant-lookup"><code class="function">g_variant_lookup()</code></a>, <a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#g-variant-lookup-value"><code class="function">g_variant_lookup_value()</code></a>, or <a class="link" href="telepathy-glib-vardict.html#tp-vardict-get-uint32" title="tp_vardict_get_uint32 ()"><code class="function">tp_vardict_get_uint32()</code></a>
and similar functions for convenient access to the values.
</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>self</code></em> :</span></p></td>
<td>a <a class="link" href="telepathy-glib-stream-tube-channel.html#TpStreamTubeChannel"><span class="type">TpStreamTubeChannel</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a new reference to a <a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#GVariant"><span class="type">GVariant</span></a>. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 0.19.10</p>
</div>
<hr>
<div class="refsect2">
<a name="tp-stream-tube-channel-get-service"></a><h3>tp_stream_tube_channel_get_service ()</h3>
<pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * tp_stream_tube_channel_get_service (<em class="parameter"><code><a class="link" href="telepathy-glib-stream-tube-channel.html#TpStreamTubeChannel"><span class="type">TpStreamTubeChannel</span></a> *self</code></em>);</pre>
<p>
Return the <a class="link" href="telepathy-glib-stream-tube-channel.html#TpStreamTubeChannel--service" title='The "service" property'><span class="type">"service"</span></a> property
</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>self</code></em> :</span></p></td>
<td>a <a class="link" href="telepathy-glib-stream-tube-channel.html#TpStreamTubeChannel"><span class="type">TpStreamTubeChannel</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the value of <a class="link" href="telepathy-glib-stream-tube-channel.html#TpStreamTubeChannel--service" title='The "service" property'><span class="type">"service"</span></a>. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 0.13.2</p>
</div>
<hr>
<div class="refsect2">
<a name="tp-stream-tube-channel-new"></a><h3>tp_stream_tube_channel_new ()</h3>
<pre class="programlisting"><a class="link" href="telepathy-glib-stream-tube-channel.html#TpStreamTubeChannel"><span class="returnvalue">TpStreamTubeChannel</span></a> * tp_stream_tube_channel_new (<em class="parameter"><code><a class="link" href="telepathy-glib-connection.html#TpConnection"><span class="type">TpConnection</span></a> *conn</code></em>,
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *object_path</code></em>,
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Hash-Tables.html#GHashTable"><span class="type">GHashTable</span></a> *immutable_properties</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">tp_stream_tube_channel_new</code> is deprecated and should not be used in newly-written code. Use <a class="link" href="telepathy-glib-simple-client-factory.html#tp-simple-client-factory-ensure-channel" title="tp_simple_client_factory_ensure_channel ()"><code class="function">tp_simple_client_factory_ensure_channel()</code></a> instead.</p>
</div>
<p>
Creates a new <a class="link" href="telepathy-glib-stream-tube-channel.html#TpStreamTubeChannel"><span class="type">TpStreamTubeChannel</span></a> proxy object from the provided path and
properties. Most developers will not need to use this function; use
<a class="link" href="telepathy-glib-automatic-proxy-factory.html#TpAutomaticProxyFactory"><span class="type">TpAutomaticProxyFactory</span></a> to automatically create <a class="link" href="telepathy-glib-stream-tube-channel.html#TpStreamTubeChannel"><span class="type">TpStreamTubeChannel</span></a> proxy
objects.
</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>conn</code></em> :</span></p></td>
<td>a <a class="link" href="telepathy-glib-connection.html#TpConnection"><span class="type">TpConnection</span></a>; may not be <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>object_path</code></em> :</span></p></td>
<td>the object path of the channel; may not be <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>immutable_properties</code></em> :</span></p></td>
<td>the immutable properties of the channel,
as signalled by the NewChannel D-Bus signal or returned by the
CreateChannel and EnsureChannel D-Bus methods: a mapping from
strings (D-Bus interface name + "." + property name) to <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a> instances. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>][<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> utf8 GObject.Value]</span>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td>used to indicate the error if <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> is returned</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a newly-created <a class="link" href="telepathy-glib-stream-tube-channel.html#TpStreamTubeChannel"><span class="type">TpStreamTubeChannel</span></a> proxy. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 0.13.2</p>
</div>
<hr>
<div class="refsect2">
<a name="tp-stream-tube-channel-offer-async"></a><h3>tp_stream_tube_channel_offer_async ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> tp_stream_tube_channel_offer_async (<em class="parameter"><code><a class="link" href="telepathy-glib-stream-tube-channel.html#TpStreamTubeChannel"><span class="type">TpStreamTubeChannel</span></a> *self</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Hash-Tables.html#GHashTable"><span class="type">GHashTable</span></a> *params</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/gio/unstable/GAsyncResult.html#GAsyncReadyCallback"><span class="type">GAsyncReadyCallback</span></a> callback</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>);</pre>
<p>
Offer an outgoing stream tube. When the tube has been offered, <em class="parameter"><code>callback</code></em>
will be called. You can then call <a class="link" href="telepathy-glib-stream-tube-channel.html#tp-stream-tube-channel-offer-finish" title="tp_stream_tube_channel_offer_finish ()"><code class="function">tp_stream_tube_channel_offer_finish()</code></a>
to get the result of the operation.
</p>
<p>
You have to connect to the <a class="link" href="telepathy-glib-stream-tube-channel.html#TpStreamTubeChannel-incoming" title='The "incoming" signal'><span class="type">"incoming"</span></a> signal to get a
<a class="link" href="telepathy-glib-stream-tube-connection.html#TpStreamTubeConnection"><span class="type">TpStreamTubeConnection</span></a> each time a contact establishes a connection to
the tube.
</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>self</code></em> :</span></p></td>
<td>an outgoing <a class="link" href="telepathy-glib-stream-tube-channel.html#TpStreamTubeChannel"><span class="type">TpStreamTubeChannel</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>params</code></em> :</span></p></td>
<td>parameters of the tube, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>][<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>callback</code></em> :</span></p></td>
<td>a callback to call when the tube has been offered</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td>data to pass to <em class="parameter"><code>callback</code></em>
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 0.13.2</p>
</div>
<hr>
<div class="refsect2">
<a name="tp-stream-tube-channel-offer-finish"></a><h3>tp_stream_tube_channel_offer_finish ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> tp_stream_tube_channel_offer_finish (<em class="parameter"><code><a class="link" href="telepathy-glib-stream-tube-channel.html#TpStreamTubeChannel"><span class="type">TpStreamTubeChannel</span></a> *self</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/gio/unstable/GAsyncResult.html"><span class="type">GAsyncResult</span></a> *result</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
<p>
Finishes offering an outgoing stream tube.
</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>self</code></em> :</span></p></td>
<td>a <a class="link" href="telepathy-glib-stream-tube-channel.html#TpStreamTubeChannel"><span class="type">TpStreamTubeChannel</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>result</code></em> :</span></p></td>
<td>a <a href="http://library.gnome.org/devel/gio/unstable/GAsyncResult.html"><span class="type">GAsyncResult</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td>a <a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> to fill</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> when a Tube has been successfully offered; <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> otherwise</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 0.13.2</p>
</div>
</div>
<div class="refsect1">
<a name="telepathy-glib-stream-tube-channel.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="TpStreamTubeChannel--parameters"></a><h3>The <code class="literal">"parameters"</code> property</h3>
<pre class="programlisting"> "parameters" <span class="type">GHashTable_gchararray+GValue_*</span> : Read</pre>
<p>
A string to <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"><span class="type">GValue</span></a> <a href="http://library.gnome.org/devel/glib/unstable/glib-Hash-Tables.html#GHashTable"><span class="type">GHashTable</span></a> representing the parameters of the tube.
</p>
<p>
Will be <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> for outgoing tubes until the tube has been offered.
</p>
<p>
In high-level language bindings, use
<a class="link" href="telepathy-glib-stream-tube-channel.html#TpStreamTubeChannel--parameters-vardict" title='The "parameters-vardict" property'><span class="type">"parameters-vardict"</span></a> or
<a class="link" href="telepathy-glib-stream-tube-channel.html#tp-stream-tube-channel-dup-parameters-vardict" title="tp_stream_tube_channel_dup_parameters_vardict ()"><code class="function">tp_stream_tube_channel_dup_parameters_vardict()</code></a> to get the same
information in a more convenient format.
</p>
<p class="since">Since 0.13.2</p>
</div>
<hr>
<div class="refsect2">
<a name="TpStreamTubeChannel--parameters-vardict"></a><h3>The <code class="literal">"parameters-vardict"</code> property</h3>
<pre class="programlisting"> "parameters-vardict" <a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#GVariant"><span class="type">GVariant</span></a>* : Read</pre>
<p>
A <a href="http://library.gnome.org/devel/glib/unstable/glib-GVariantType.html#G-VARIANT-TYPE-VARDICT:CAPS"><code class="literal">G_VARIANT_TYPE_VARDICT</code></a> representing the parameters of the tube.
</p>
<p>
Will be <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> for outgoing tubes until the tube has been offered.
</p>
<p>Allowed values: GVariant<a{sv}></p>
<p>Default value: NULL</p>
<p class="since">Since 0.19.10</p>
</div>
<hr>
<div class="refsect2">
<a name="TpStreamTubeChannel--service"></a><h3>The <code class="literal">"service"</code> property</h3>
<pre class="programlisting"> "service" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read</pre>
<p>
A string representing the service name that will be used over the tube.
</p>
<p>Default value: NULL</p>
<p class="since">Since 0.13.2</p>
</div>
</div>
<div class="refsect1">
<a name="telepathy-glib-stream-tube-channel.signal-details"></a><h2>Signal Details</h2>
<div class="refsect2">
<a name="TpStreamTubeChannel-incoming"></a><h3>The <code class="literal">"incoming"</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span> user_function (<a class="link" href="telepathy-glib-stream-tube-channel.html#TpStreamTubeChannel"><span class="type">TpStreamTubeChannel</span></a> *self,
<a class="link" href="telepathy-glib-stream-tube-connection.html#TpStreamTubeConnection"><span class="type">TpStreamTubeConnection</span></a> *tube_connection,
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data) : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a></pre>
<p>
The ::incoming signal is emitted on offered Tubes when a new incoming
connection is made from a remote user (one accepting the Tube).
</p>
<p>
Consumers of this signal must take their own references to
<em class="parameter"><code>tube_connection</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>self</code></em> :</span></p></td>
<td>the <a class="link" href="telepathy-glib-stream-tube-channel.html#TpStreamTubeChannel"><span class="type">TpStreamTubeChannel</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>tube_connection</code></em> :</span></p></td>
<td>the <a class="link" href="telepathy-glib-stream-tube-connection.html#TpStreamTubeConnection"><span class="type">TpStreamTubeConnection</span></a> for the connection</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>
<div class="footer">
<hr>
Generated by GTK-Doc V1.19</div>
</body>
</html>
|
