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
|
<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html
PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<title>TelepathyQt4: Tp::FileTransferChannel Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr>
<td width="1"> </td>
<td class="postheader" valign="center">
<a href="index.html">
<font color="#004faf">Home</font></a> ·
<a href="classes.html">
<font color="#004faf">All Classes</font></a> ·
<a href="namespaces.html">
<font color="#004faf">All Namespaces</font></a> ·
<a href="modules.html">
<font color="#004faf">Modules</font></a> ·
<a href="functions.html">
<font color="#004faf">Functions</font></a> ·
<a href="files.html">
<font color="#004faf">Files</font></a>
</td>
</tr>
</table>
</body>
</html>
<!-- Generated by Doxygen 1.6.3 -->
<div class="navpath"><a class="el" href="namespaceTp.html">Tp</a>::<a class="el" href="classTp_1_1FileTransferChannel.html">FileTransferChannel</a>
</div>
<div class="contents">
<h1>Tp::FileTransferChannel Class Reference<br/>
<small>
[<a class="el" href="group__clientchannel.html">Channel proxies</a>]</small>
</h1><!-- doxytag: class="Tp::FileTransferChannel" --><!-- doxytag: inherits="Tp::Channel" -->
<p>The <a class="el" href="classTp_1_1FileTransferChannel.html" title="The FileTransferChannel class provides an object representing a Telepathy channel...">FileTransferChannel</a> class provides an object representing a Telepathy channel of type FileTransfer.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="file-transfer-channel_8h_source.html">TelepathyQt4/FileTransferChannel</a>></code></p>
<p>Inherits <a class="el" href="classTp_1_1Channel.html">Tp::Channel</a>.</p>
<p>Inherited by <a class="el" href="classTp_1_1IncomingFileTransferChannel.html">Tp::IncomingFileTransferChannel</a>, and <a class="el" href="classTp_1_1OutgoingFileTransferChannel.html">Tp::OutgoingFileTransferChannel</a>.</p>
<p><a href="classTp_1_1FileTransferChannel-members.html">List of all members.</a></p>
<h2>Signals</h2>
<ul>
<li>void <a class="el" href="classTp_1_1FileTransferChannel.html#ae7bab5a3817ce7c036509b3548c59d8b">stateChanged</a> (Tp::FileTransferState state, Tp::FileTransferStateChangeReason reason)
<li>void <a class="el" href="classTp_1_1FileTransferChannel.html#a1625963b2ed309a3b559ec1a34e47788">initialOffsetDefined</a> (qulonglong initialOffset)
<li>void <a class="el" href="classTp_1_1FileTransferChannel.html#ab5e1fc0317125ba466988f3f11c47ca0">transferredBytesChanged</a> (qulonglong count)
</ul>
<h2>Public Member Functions</h2>
<ul>
<li>virtual <a class="el" href="classTp_1_1FileTransferChannel.html#acae3f8a38d02f05ad8752981f5c4d5c5">~FileTransferChannel</a> ()
<li>FileTransferState <a class="el" href="classTp_1_1FileTransferChannel.html#af5eaf95fce467175709bc9a677a99823">state</a> () const
<li>FileTransferStateChangeReason <a class="el" href="classTp_1_1FileTransferChannel.html#a60f72666dfef89e088ae3a0b0f48f74d">stateReason</a> () const
<li>QString <a class="el" href="classTp_1_1FileTransferChannel.html#a0b641c616449a894ff960d463748c383">fileName</a> () const
<li>QString <a class="el" href="classTp_1_1FileTransferChannel.html#aacfbbfd5b51c4da2641ccc8c353188c9">contentType</a> () const
<li>qulonglong <a class="el" href="classTp_1_1FileTransferChannel.html#abb67c974edd4363cace18283d29cbbce">size</a> () const
<li>FileHashType <a class="el" href="classTp_1_1FileTransferChannel.html#a1481e951ea766d1422859347cf64a182">contentHashType</a> () const
<li>QString <a class="el" href="classTp_1_1FileTransferChannel.html#aa5dfb852c95bba3241e75da21e8e3ff3">contentHash</a> () const
<li>QString <a class="el" href="classTp_1_1FileTransferChannel.html#aa0113985b9f3eaf249ebc7f90a2bd72a">description</a> () const
<li>QDateTime <a class="el" href="classTp_1_1FileTransferChannel.html#a6710729f5b777cb039b5b6fb62ddf836">lastModificationTime</a> () const
<li>qulonglong <a class="el" href="classTp_1_1FileTransferChannel.html#a34dbec4a30c0d73d1f8861a3500af57d">initialOffset</a> () const
<li>qulonglong <a class="el" href="classTp_1_1FileTransferChannel.html#a7bcbf39ec7d92537bbda507e9cf07a7c">transferredBytes</a> () const
<li><a class="el" href="classTp_1_1PendingOperation.html">PendingOperation</a> * <a class="el" href="classTp_1_1FileTransferChannel.html#a02cd4e2fd045b474e488b87fbe6c1f07">cancel</a> ()
</ul>
<h2>Static Public Member Functions</h2>
<ul>
<li>static <a class="el" href="classTp_1_1SharedPtr.html">FileTransferChannelPtr</a> <a class="el" href="classTp_1_1FileTransferChannel.html#abc5e5967f512675521c323b480bae955">create</a> (const <a class="el" href="classTp_1_1SharedPtr.html">ConnectionPtr</a> &connection, const QString &objectPath, const QVariantMap &immutableProperties)
</ul>
<h2>Static Public Attributes</h2>
<ul>
<li>static const <a class="el" href="classTp_1_1Feature.html">Feature</a> <a class="el" href="classTp_1_1FileTransferChannel.html#a5f5f0af9fa83ed14c097670c05b0ed71">FeatureCore</a>
</ul>
<h2>Protected Member Functions</h2>
<ul>
<li><a class="el" href="classTp_1_1FileTransferChannel.html#a050706d4d39a79286fb05e4e9889ad87">FileTransferChannel</a> (const <a class="el" href="classTp_1_1SharedPtr.html">ConnectionPtr</a> &connection, const QString &objectPath, const QVariantMap &immutableProperties)
<li>SupportedSocketMap <a class="el" href="classTp_1_1FileTransferChannel.html#a497872a3f691722f20654937b5cbea90">availableSocketTypes</a> () const
<li>virtual void <a class="el" href="classTp_1_1FileTransferChannel.html#aa86326ced6b70b4d1b26e1f784167df7">connectToHost</a> ()
<li>bool <a class="el" href="classTp_1_1FileTransferChannel.html#a7d40e3566345990a25a4f84f5189ab89">isConnected</a> () const
<li>void <a class="el" href="classTp_1_1FileTransferChannel.html#a34305944fca0868033cfae04512d4a4b">setConnected</a> ()
<li>bool <a class="el" href="classTp_1_1FileTransferChannel.html#a6a6d65f672214327340a44fee3fffd3d">isFinished</a> () const
<li>virtual void <a class="el" href="classTp_1_1FileTransferChannel.html#a08527165099e8d671437727144871e9d">setFinished</a> ()
</ul>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>The <a class="el" href="classTp_1_1FileTransferChannel.html" title="The FileTransferChannel class provides an object representing a Telepathy channel...">FileTransferChannel</a> class provides an object representing a Telepathy channel of type FileTransfer. </p>
<p>For more specialized file transfer classes, please refer to <a class="el" href="classTp_1_1OutgoingFileTransferChannel.html" title="The OutgoingFileTransferChannel class provides an object representing a Telepathy...">OutgoingFileTransferChannel</a> and <a class="el" href="classTp_1_1IncomingFileTransferChannel.html" title="The IncomingFileTransferChannel class provides an object representing a Telepathy...">IncomingFileTransferChannel</a>. </p>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="acae3f8a38d02f05ad8752981f5c4d5c5"></a><!-- doxytag: member="Tp::FileTransferChannel::~FileTransferChannel" ref="acae3f8a38d02f05ad8752981f5c4d5c5" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Tp::FileTransferChannel::~FileTransferChannel </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Class destructor. </p>
</div>
</div>
<a class="anchor" id="a050706d4d39a79286fb05e4e9889ad87"></a><!-- doxytag: member="Tp::FileTransferChannel::FileTransferChannel" ref="a050706d4d39a79286fb05e4e9889ad87" args="(const ConnectionPtr &connection, const QString &objectPath, const QVariantMap &immutableProperties)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Tp::FileTransferChannel::FileTransferChannel </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classTp_1_1SharedPtr.html">ConnectionPtr</a> & </td>
<td class="paramname"> <em>connection</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const QString & </td>
<td class="paramname"> <em>objectPath</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const QVariantMap & </td>
<td class="paramname"> <em>immutableProperties</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Construct a new file transfer channel associated with the given <em>objectPath</em> on the same service as the given <em>connection</em>.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>connection</em> </td><td><a class="el" href="classTp_1_1Connection.html" title="The Connection class provides an object representing a Telepathy connection.">Connection</a> owning this channel, and specifying the service. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>objectPath</em> </td><td>Path to the object on the service. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>immutableProperties</em> </td><td>The immutable properties of the channel. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="abc5e5967f512675521c323b480bae955"></a><!-- doxytag: member="Tp::FileTransferChannel::create" ref="abc5e5967f512675521c323b480bae955" args="(const ConnectionPtr &connection, const QString &objectPath, const QVariantMap &immutableProperties)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classTp_1_1SharedPtr.html">FileTransferChannelPtr</a> Tp::FileTransferChannel::create </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classTp_1_1SharedPtr.html">ConnectionPtr</a> & </td>
<td class="paramname"> <em>connection</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const QString & </td>
<td class="paramname"> <em>objectPath</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const QVariantMap & </td>
<td class="paramname"> <em>immutableProperties</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Create a new <a class="el" href="classTp_1_1FileTransferChannel.html" title="The FileTransferChannel class provides an object representing a Telepathy channel...">FileTransferChannel</a> object.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>connection</em> </td><td><a class="el" href="classTp_1_1Connection.html" title="The Connection class provides an object representing a Telepathy connection.">Connection</a> owning this channel, and specifying the service. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>objectPath</em> </td><td>The object path of this channel. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>immutableProperties</em> </td><td>The immutable properties of this channel. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>A StreamedMediaChannelPtr object pointing to the newly created <a class="el" href="classTp_1_1StreamedMediaChannel.html" title="The StreamedMediaChannel class provides an object representing a Telepathy channel...">StreamedMediaChannel</a> object. </dd></dl>
<p>Reimplemented from <a class="el" href="classTp_1_1Channel.html#ab9e80e6c7d574f9f853cf6c47801da72">Tp::Channel</a>.</p>
<p>Reimplemented in <a class="el" href="classTp_1_1IncomingFileTransferChannel.html#aafd81dd707b1d9c150e3ff21f93d9b2f">Tp::IncomingFileTransferChannel</a>, and <a class="el" href="classTp_1_1OutgoingFileTransferChannel.html#a92d1221187f9df07306e7b843452743a">Tp::OutgoingFileTransferChannel</a>.</p>
</div>
</div>
<a class="anchor" id="af5eaf95fce467175709bc9a677a99823"></a><!-- doxytag: member="Tp::FileTransferChannel::state" ref="af5eaf95fce467175709bc9a677a99823" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">FileTransferState Tp::FileTransferChannel::state </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return the state of the file transfer as described by the FileTransferState enum.</p>
<p>This method requires <a class="el" href="classTp_1_1FileTransferChannel.html#a5f5f0af9fa83ed14c097670c05b0ed71">FileTransferChannel::FeatureCore</a> to be enabled.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>The state of the file transfer. </dd></dl>
</div>
</div>
<a class="anchor" id="a60f72666dfef89e088ae3a0b0f48f74d"></a><!-- doxytag: member="Tp::FileTransferChannel::stateReason" ref="a60f72666dfef89e088ae3a0b0f48f74d" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">FileTransferStateChangeReason Tp::FileTransferChannel::stateReason </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return the for the state change as described by the FileTransferStateChangeReason enum.</p>
<p>This method requires <a class="el" href="classTp_1_1FileTransferChannel.html#a5f5f0af9fa83ed14c097670c05b0ed71">FileTransferChannel::FeatureCore</a> to be enabled.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>The reason for the state change. </dd></dl>
</div>
</div>
<a class="anchor" id="a0b641c616449a894ff960d463748c383"></a><!-- doxytag: member="Tp::FileTransferChannel::fileName" ref="a0b641c616449a894ff960d463748c383" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">QString Tp::FileTransferChannel::fileName </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return the name of the file on the sender's side. This is given as a suggested filename for the receiver. This cannot change once the channel has been created.</p>
<p>This property should be the basename of the file being sent. For example, if the sender sends the file /home/user/monkey.pdf then this property should be set to monkey.pdf.</p>
<p>This method requires <a class="el" href="classTp_1_1FileTransferChannel.html#a5f5f0af9fa83ed14c097670c05b0ed71">FileTransferChannel::FeatureCore</a> to be enabled.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>Suggested filename for the receiver. </dd></dl>
</div>
</div>
<a class="anchor" id="aacfbbfd5b51c4da2641ccc8c353188c9"></a><!-- doxytag: member="Tp::FileTransferChannel::contentType" ref="aacfbbfd5b51c4da2641ccc8c353188c9" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">QString Tp::FileTransferChannel::contentType </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return the file's MIME type. This cannot change once the channel has been created.</p>
<p>This method requires <a class="el" href="classTp_1_1FileTransferChannel.html#a5f5f0af9fa83ed14c097670c05b0ed71">FileTransferChannel::FeatureCore</a> to be enabled.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>The file's MIME type. </dd></dl>
</div>
</div>
<a class="anchor" id="abb67c974edd4363cace18283d29cbbce"></a><!-- doxytag: member="Tp::FileTransferChannel::size" ref="abb67c974edd4363cace18283d29cbbce" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">qulonglong Tp::FileTransferChannel::size </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The size of the file. This cannot change once the channel has been created.</p>
<p>Note that the size is not guaranteed to be exactly right for incoming files. This is merely a hint and should not be used to know when the transfer finished.</p>
<p>For unknown sizes the return value can be UINT64_MAX.</p>
<p>This method requires <a class="el" href="classTp_1_1FileTransferChannel.html#a5f5f0af9fa83ed14c097670c05b0ed71">FileTransferChannel::FeatureCore</a> to be enabled.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>The size of the file. </dd></dl>
</div>
</div>
<a class="anchor" id="a1481e951ea766d1422859347cf64a182"></a><!-- doxytag: member="Tp::FileTransferChannel::contentHashType" ref="a1481e951ea766d1422859347cf64a182" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">FileHashType Tp::FileTransferChannel::contentHashType </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return the type of the <a class="el" href="classTp_1_1FileTransferChannel.html#aa5dfb852c95bba3241e75da21e8e3ff3">contentHash()</a>.</p>
<p>This method requires <a class="el" href="classTp_1_1FileTransferChannel.html#a5f5f0af9fa83ed14c097670c05b0ed71">FileTransferChannel::FeatureCore</a> to be enabled.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>The type of the <a class="el" href="classTp_1_1FileTransferChannel.html#aa5dfb852c95bba3241e75da21e8e3ff3">contentHash()</a>. </dd></dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classTp_1_1FileTransferChannel.html#aa5dfb852c95bba3241e75da21e8e3ff3">contentHash()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="aa5dfb852c95bba3241e75da21e8e3ff3"></a><!-- doxytag: member="Tp::FileTransferChannel::contentHash" ref="aa5dfb852c95bba3241e75da21e8e3ff3" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">QString Tp::FileTransferChannel::contentHash </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return the hash of the contents of the file transfer, of type described in the value of the <a class="el" href="classTp_1_1FileTransferChannel.html#a1481e951ea766d1422859347cf64a182">contentHashType()</a>.</p>
<p>Its value MUST correspond to the appropriate type of the <a class="el" href="classTp_1_1FileTransferChannel.html#a1481e951ea766d1422859347cf64a182">contentHashType()</a>. If the <a class="el" href="classTp_1_1FileTransferChannel.html#a1481e951ea766d1422859347cf64a182">contentHashType()</a> is set to FileHashTypeNone, then the returned value is an empty string.</p>
<p>This method requires <a class="el" href="classTp_1_1FileTransferChannel.html#a5f5f0af9fa83ed14c097670c05b0ed71">FileTransferChannel::FeatureCore</a> to be enabled.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>Hash of the contents of the file transfer. </dd></dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classTp_1_1FileTransferChannel.html#a1481e951ea766d1422859347cf64a182">contentHashType()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="aa0113985b9f3eaf249ebc7f90a2bd72a"></a><!-- doxytag: member="Tp::FileTransferChannel::description" ref="aa0113985b9f3eaf249ebc7f90a2bd72a" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">QString Tp::FileTransferChannel::description </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return the description of the file transfer. This cannot change once the channel has been created.</p>
<p>This method requires <a class="el" href="classTp_1_1FileTransferChannel.html#a5f5f0af9fa83ed14c097670c05b0ed71">FileTransferChannel::FeatureCore</a> to be enabled.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>The description of the file transfer. </dd></dl>
</div>
</div>
<a class="anchor" id="a6710729f5b777cb039b5b6fb62ddf836"></a><!-- doxytag: member="Tp::FileTransferChannel::lastModificationTime" ref="a6710729f5b777cb039b5b6fb62ddf836" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">QDateTime Tp::FileTransferChannel::lastModificationTime </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return the last modification time of the file being transferred. This cannot change once the channel has been created.</p>
<p>This method requires <a class="el" href="classTp_1_1FileTransferChannel.html#a5f5f0af9fa83ed14c097670c05b0ed71">FileTransferChannel::FeatureCore</a> to be enabled.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>The last modification time of the file being transferred. </dd></dl>
</div>
</div>
<a class="anchor" id="a34dbec4a30c0d73d1f8861a3500af57d"></a><!-- doxytag: member="Tp::FileTransferChannel::initialOffset" ref="a34dbec4a30c0d73d1f8861a3500af57d" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">qulonglong Tp::FileTransferChannel::initialOffset </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return the offset in bytes from which the file will be sent.</p>
<p>This method requires <a class="el" href="classTp_1_1FileTransferChannel.html#a5f5f0af9fa83ed14c097670c05b0ed71">FileTransferChannel::FeatureCore</a> to be enabled.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>The offset in bytes from where the file should be sent. </dd></dl>
</div>
</div>
<a class="anchor" id="a7bcbf39ec7d92537bbda507e9cf07a7c"></a><!-- doxytag: member="Tp::FileTransferChannel::transferredBytes" ref="a7bcbf39ec7d92537bbda507e9cf07a7c" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">qulonglong Tp::FileTransferChannel::transferredBytes </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return the number of bytes that have been transferred. This will be updated as the file transfer continues.</p>
<p>This method requires <a class="el" href="classTp_1_1FileTransferChannel.html#a5f5f0af9fa83ed14c097670c05b0ed71">FileTransferChannel::FeatureCore</a> to be enabled.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>Number of bytes that have been transferred. </dd></dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classTp_1_1FileTransferChannel.html#ab5e1fc0317125ba466988f3f11c47ca0">transferredBytesChanged()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a02cd4e2fd045b474e488b87fbe6c1f07"></a><!-- doxytag: member="Tp::FileTransferChannel::cancel" ref="a02cd4e2fd045b474e488b87fbe6c1f07" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classTp_1_1PendingOperation.html">PendingOperation</a> * Tp::FileTransferChannel::cancel </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Cancel a file transfer.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>A <a class="el" href="classTp_1_1PendingOperation.html" title="Abstract base class for pending asynchronous operations.">PendingOperation</a> object which will emit <a class="el" href="classTp_1_1PendingOperation.html#addbb8c4462019ffdf19095a31da0cc7a">PendingOperation::finished</a> when the call has finished. </dd></dl>
</div>
</div>
<a class="anchor" id="ae7bab5a3817ce7c036509b3548c59d8b"></a><!-- doxytag: member="Tp::FileTransferChannel::stateChanged" ref="ae7bab5a3817ce7c036509b3548c59d8b" args="(Tp::FileTransferState state, Tp::FileTransferStateChangeReason reason)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Tp::FileTransferChannel::stateChanged </td>
<td>(</td>
<td class="paramtype">Tp::FileTransferState </td>
<td class="paramname"> <em>state</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">Tp::FileTransferStateChangeReason </td>
<td class="paramname"> <em>reason</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [signal]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a1625963b2ed309a3b559ec1a34e47788"></a><!-- doxytag: member="Tp::FileTransferChannel::initialOffsetDefined" ref="a1625963b2ed309a3b559ec1a34e47788" args="(qulonglong initialOffset)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Tp::FileTransferChannel::initialOffsetDefined </td>
<td>(</td>
<td class="paramtype">qulonglong </td>
<td class="paramname"> <em>initialOffset</em></td>
<td> ) </td>
<td><code> [signal]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="ab5e1fc0317125ba466988f3f11c47ca0"></a><!-- doxytag: member="Tp::FileTransferChannel::transferredBytesChanged" ref="ab5e1fc0317125ba466988f3f11c47ca0" args="(qulonglong count)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Tp::FileTransferChannel::transferredBytesChanged </td>
<td>(</td>
<td class="paramtype">qulonglong </td>
<td class="paramname"> <em>count</em></td>
<td> ) </td>
<td><code> [signal]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a497872a3f691722f20654937b5cbea90"></a><!-- doxytag: member="Tp::FileTransferChannel::availableSocketTypes" ref="a497872a3f691722f20654937b5cbea90" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">SupportedSocketMap Tp::FileTransferChannel::availableSocketTypes </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return a mapping from address types (members of SocketAddressType) to arrays of access-control type (members of SocketAccessControl) that the connection manager supports for sockets with that address type. For simplicity, if a CM supports offering a particular type of file transfer, it is assumed to support accepting it. All connection Managers support at least SocketAddressTypeIPv4.</p>
<p>This method requires <a class="el" href="classTp_1_1FileTransferChannel.html#a5f5f0af9fa83ed14c097670c05b0ed71">FileTransferChannel::FeatureCore</a> to be enabled.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>A mapping from address types to arrays of access-control type. </dd></dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classTp_1_1FileTransferChannel.html#ab5e1fc0317125ba466988f3f11c47ca0">transferredBytesChanged()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="aa86326ced6b70b4d1b26e1f784167df7"></a><!-- doxytag: member="Tp::FileTransferChannel::connectToHost" ref="aa86326ced6b70b4d1b26e1f784167df7" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Tp::FileTransferChannel::connectToHost </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Protected virtual method called when the state becomes FileTransferStateOpen.</p>
<p>Specialized classes should reimplement this method and call <a class="el" href="classTp_1_1FileTransferChannel.html#a34305944fca0868033cfae04512d4a4b">setConnected()</a> when the connection is established.</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classTp_1_1FileTransferChannel.html#a34305944fca0868033cfae04512d4a4b">setConnected()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a7d40e3566345990a25a4f84f5189ab89"></a><!-- doxytag: member="Tp::FileTransferChannel::isConnected" ref="a7d40e3566345990a25a4f84f5189ab89" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Tp::FileTransferChannel::isConnected </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return whether a connection has been established.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>Whether a connection has been established. </dd></dl>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classTp_1_1FileTransferChannel.html#a34305944fca0868033cfae04512d4a4b">setConnected()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a34305944fca0868033cfae04512d4a4b"></a><!-- doxytag: member="Tp::FileTransferChannel::setConnected" ref="a34305944fca0868033cfae04512d4a4b" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Tp::FileTransferChannel::setConnected </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Indicate whether a connection has been established.</p>
<p>Specialized classes that reimplement <a class="el" href="classTp_1_1FileTransferChannel.html#aa86326ced6b70b4d1b26e1f784167df7">connectToHost()</a> must call this method once the connection has been established or <a class="el" href="classTp_1_1FileTransferChannel.html#a08527165099e8d671437727144871e9d">setFinished()</a> if an error occurred.</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classTp_1_1FileTransferChannel.html#a7d40e3566345990a25a4f84f5189ab89">isConnected()</a>, <a class="el" href="classTp_1_1FileTransferChannel.html#aa86326ced6b70b4d1b26e1f784167df7">connectToHost()</a>, <a class="el" href="classTp_1_1FileTransferChannel.html#a08527165099e8d671437727144871e9d">setFinished()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="a6a6d65f672214327340a44fee3fffd3d"></a><!-- doxytag: member="Tp::FileTransferChannel::isFinished" ref="a6a6d65f672214327340a44fee3fffd3d" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Tp::FileTransferChannel::isFinished </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return whether sending/receiving has finished.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>Whether sending/receiving has finished. </dd></dl>
</div>
</div>
<a class="anchor" id="a08527165099e8d671437727144871e9d"></a><!-- doxytag: member="Tp::FileTransferChannel::setFinished" ref="a08527165099e8d671437727144871e9d" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Tp::FileTransferChannel::setFinished </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Protected virtual method called when an error occurred and the transfer should finish.</p>
<p>Specialized classes should reimplement this method and close the IO devices and do all the needed cleanup.</p>
<p>Note that for specialized classes that reimplement <a class="el" href="classTp_1_1FileTransferChannel.html#aa86326ced6b70b4d1b26e1f784167df7">connectToHost()</a> and set <a class="el" href="classTp_1_1FileTransferChannel.html#a7d40e3566345990a25a4f84f5189ab89">isConnected()</a> to true, the state will not change to FileTransferStateCompleted once the state change is received.</p>
<p>When finished sending/receiving the specialized class MUST call this method and then the state will change to the latest pending state. </p>
</div>
</div>
<hr/><h2>Member Data Documentation</h2>
<a class="anchor" id="a5f5f0af9fa83ed14c097670c05b0ed71"></a><!-- doxytag: member="Tp::FileTransferChannel::FeatureCore" ref="a5f5f0af9fa83ed14c097670c05b0ed71" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classTp_1_1Feature.html">Feature</a> <a class="el" href="classTp_1_1FileTransferChannel.html#a5f5f0af9fa83ed14c097670c05b0ed71">Tp::FileTransferChannel::FeatureCore</a><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p><a class="el" href="classTp_1_1Feature.html">Feature</a> representing the core that needs to become ready to make the <a class="el" href="classTp_1_1FileTransferChannel.html" title="The FileTransferChannel class provides an object representing a Telepathy channel...">FileTransferChannel</a> object usable.</p>
<p>Note that this feature must be enabled in order to use most <a class="el" href="classTp_1_1FileTransferChannel.html" title="The FileTransferChannel class provides an object representing a Telepathy channel...">FileTransferChannel</a> methods. See specific methods documentation for more details.</p>
<p>When calling <a class="el" href="classTp_1_1ReadyObject.html#a344fc63eaef5278cbf938eaa1ed4c635">isReady()</a>, <a class="el" href="classTp_1_1ReadyObject.html#ac02393f99a46725a4ffee32caaec13cc">becomeReady()</a>, this feature is implicitly added to the requested features. </p>
<p>Reimplemented from <a class="el" href="classTp_1_1Channel.html#a83c71f5ebefd137981583d8a1ba6773d">Tp::Channel</a>.</p>
<p>Reimplemented in <a class="el" href="classTp_1_1IncomingFileTransferChannel.html#acfa3edfc8e92758318b00454b6efd946">Tp::IncomingFileTransferChannel</a>, and <a class="el" href="classTp_1_1OutgoingFileTransferChannel.html#af5a53b23a870cb4893d15eaad616f7b6">Tp::OutgoingFileTransferChannel</a>.</p>
</div>
</div>
</div>
<p /><address><hr /><div align="center">
<table width="100%" cellspacing="0" border="0"><tr class="address">
<td width="30%">Copyright © 2008-2010 Collabora Ltd. and Nokia Corporation</td>
<td width="30%" align="right"><div align="right">Telepathy-Qt4 0.3.6</div></td>
</tr></table></div></address>
</body>
</html>
|
