File: classTp_1_1OutgoingFileTransferChannel.html

package info (click to toggle)
telepathy-qt4 0.3.6-1
  • links: PTS, VCS
  • area: main
  • in suites: squeeze
  • size: 14,260 kB
  • ctags: 12,185
  • sloc: cpp: 29,241; xml: 23,692; ansic: 16,079; sh: 10,327; python: 3,080; makefile: 1,553
file content (229 lines) | stat: -rw-r--r-- 14,126 bytes parent folder | download
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
<?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::OutgoingFileTransferChannel 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">&nbsp;&nbsp;</td>
<td class="postheader" valign="center">
<a href="index.html">
<font color="#004faf">Home</font></a>&nbsp;&middot;
<a href="classes.html">
<font color="#004faf">All Classes</font></a>&nbsp;&middot;
<a href="namespaces.html">
<font color="#004faf">All Namespaces</font></a>&nbsp;&middot;
<a href="modules.html">
<font color="#004faf">Modules</font></a>&nbsp;&middot;
<a href="functions.html">
<font color="#004faf">Functions</font></a>&nbsp;&middot;
<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_1OutgoingFileTransferChannel.html">OutgoingFileTransferChannel</a>
  </div>
<div class="contents">
<h1>Tp::OutgoingFileTransferChannel Class Reference<br/>
<small>
[<a class="el" href="group__clientchannel.html">Channel proxies</a>]</small>
</h1><!-- doxytag: class="Tp::OutgoingFileTransferChannel" --><!-- doxytag: inherits="Tp::FileTransferChannel" -->
<p>The <a class="el" href="classTp_1_1OutgoingFileTransferChannel.html" title="The OutgoingFileTransferChannel class provides an object representing a Telepathy...">OutgoingFileTransferChannel</a> class provides an object representing a Telepathy channel of type FileTransfer for outgoing file transfers.  
<a href="#_details">More...</a></p>

<p><code>#include &lt;<a class="el" href="outgoing-file-transfer-channel_8h_source.html">TelepathyQt4/OutgoingFileTransferChannel</a>&gt;</code></p>

<p>Inherits <a class="el" href="classTp_1_1FileTransferChannel.html">Tp::FileTransferChannel</a>.</p>

<p><a href="classTp_1_1OutgoingFileTransferChannel-members.html">List of all members.</a></p>
<h2>Public Member Functions</h2>
<ul>
<li>virtual <a class="el" href="classTp_1_1OutgoingFileTransferChannel.html#a0a0f0b03b7ecb01d7956c15419850b09">~OutgoingFileTransferChannel</a> ()
<li><a class="el" href="classTp_1_1PendingOperation.html">PendingOperation</a> * <a class="el" href="classTp_1_1OutgoingFileTransferChannel.html#a19cc9cd68441c5d6e260eab8d9ca2d1b">provideFile</a> (QIODevice *input)
</ul>
<h2>Static Public Member Functions</h2>
<ul>
<li>static <br class="typebreak"/>
<a class="el" href="classTp_1_1SharedPtr.html">OutgoingFileTransferChannelPtr</a> <a class="el" href="classTp_1_1OutgoingFileTransferChannel.html#a92d1221187f9df07306e7b843452743a">create</a> (const <a class="el" href="classTp_1_1SharedPtr.html">ConnectionPtr</a> &amp;connection, const QString &amp;objectPath, const QVariantMap &amp;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_1OutgoingFileTransferChannel.html#af5a53b23a870cb4893d15eaad616f7b6">FeatureCore</a>
</ul>
<h2>Protected Member Functions</h2>
<ul>
<li><a class="el" href="classTp_1_1OutgoingFileTransferChannel.html#a5330f752001d1aa5776373f641c6019b">OutgoingFileTransferChannel</a> (const <a class="el" href="classTp_1_1SharedPtr.html">ConnectionPtr</a> &amp;connection, const QString &amp;objectPath, const QVariantMap &amp;immutableProperties)
</ul>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>The <a class="el" href="classTp_1_1OutgoingFileTransferChannel.html" title="The OutgoingFileTransferChannel class provides an object representing a Telepathy...">OutgoingFileTransferChannel</a> class provides an object representing a Telepathy channel of type FileTransfer for outgoing file transfers. </p>
<hr/><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a0a0f0b03b7ecb01d7956c15419850b09"></a><!-- doxytag: member="Tp::OutgoingFileTransferChannel::~OutgoingFileTransferChannel" ref="a0a0f0b03b7ecb01d7956c15419850b09" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">Tp::OutgoingFileTransferChannel::~OutgoingFileTransferChannel </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Class destructor. </p>

</div>
</div>
<a class="anchor" id="a5330f752001d1aa5776373f641c6019b"></a><!-- doxytag: member="Tp::OutgoingFileTransferChannel::OutgoingFileTransferChannel" ref="a5330f752001d1aa5776373f641c6019b" args="(const ConnectionPtr &amp;connection, const QString &amp;objectPath, const QVariantMap &amp;immutableProperties)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">Tp::OutgoingFileTransferChannel::OutgoingFileTransferChannel </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classTp_1_1SharedPtr.html">ConnectionPtr</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>connection</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const QString &amp;&nbsp;</td>
          <td class="paramname"> <em>objectPath</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const QVariantMap &amp;&nbsp;</td>
          <td class="paramname"> <em>immutableProperties</em></td><td>&nbsp;</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 outgoing 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>&nbsp;</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>&nbsp;</td><td>Path to the object on the service. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>immutableProperties</em>&nbsp;</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="a92d1221187f9df07306e7b843452743a"></a><!-- doxytag: member="Tp::OutgoingFileTransferChannel::create" ref="a92d1221187f9df07306e7b843452743a" args="(const ConnectionPtr &amp;connection, const QString &amp;objectPath, const QVariantMap &amp;immutableProperties)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classTp_1_1SharedPtr.html">OutgoingFileTransferChannelPtr</a> Tp::OutgoingFileTransferChannel::create </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classTp_1_1SharedPtr.html">ConnectionPtr</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>connection</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const QString &amp;&nbsp;</td>
          <td class="paramname"> <em>objectPath</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const QVariantMap &amp;&nbsp;</td>
          <td class="paramname"> <em>immutableProperties</em></td><td>&nbsp;</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_1OutgoingFileTransferChannel.html" title="The OutgoingFileTransferChannel class provides an object representing a Telepathy...">OutgoingFileTransferChannel</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>&nbsp;</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>&nbsp;</td><td>The object path of this channel. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>immutableProperties</em>&nbsp;</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_1FileTransferChannel.html#abc5e5967f512675521c323b480bae955">Tp::FileTransferChannel</a>.</p>

</div>
</div>
<a class="anchor" id="a19cc9cd68441c5d6e260eab8d9ca2d1b"></a><!-- doxytag: member="Tp::OutgoingFileTransferChannel::provideFile" ref="a19cc9cd68441c5d6e260eab8d9ca2d1b" args="(QIODevice *input)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classTp_1_1PendingOperation.html">PendingOperation</a> * Tp::OutgoingFileTransferChannel::provideFile </td>
          <td>(</td>
          <td class="paramtype">QIODevice *&nbsp;</td>
          <td class="paramname"> <em>input</em></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Provide the file for an outgoing file transfer which has been offered. The state will change to FileTransferStateOpen as soon as the transfer starts. The given input device should not be destroyed until the <a class="el" href="classTp_1_1FileTransferChannel.html#af5eaf95fce467175709bc9a677a99823">state()</a> changes to FileTransferStateCompleted or FileTransferStateCancelled. If input is a sequential device QIODevice::isSequential(), it should be closed when no more data is available, so we know when to stop reading.</p>
<p>Only the primary handler of a file transfer channel may call this method.</p>
<p>This method requires <a class="el" href="classTp_1_1FileTransferChannel.html#a5f5f0af9fa83ed14c097670c05b0ed71">FileTransferChannel::FeatureCore</a> to be enabled.</p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>input</em>&nbsp;</td><td>A QIODevice object where the data will be read from. </td></tr>
  </table>
  </dd>
</dl>
<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>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classTp_1_1FileTransferChannel.html#ae7bab5a3817ce7c036509b3548c59d8b">stateChanged()</a>, <a class="el" href="classTp_1_1FileTransferChannel.html#af5eaf95fce467175709bc9a677a99823">state()</a>, <a class="el" href="classTp_1_1FileTransferChannel.html#a60f72666dfef89e088ae3a0b0f48f74d">stateReason()</a> </dd></dl>

</div>
</div>
<hr/><h2>Member Data Documentation</h2>
<a class="anchor" id="af5a53b23a870cb4893d15eaad616f7b6"></a><!-- doxytag: member="Tp::OutgoingFileTransferChannel::FeatureCore" ref="af5a53b23a870cb4893d15eaad616f7b6" 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_1OutgoingFileTransferChannel.html#af5a53b23a870cb4893d15eaad616f7b6">Tp::OutgoingFileTransferChannel::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_1OutgoingFileTransferChannel.html" title="The OutgoingFileTransferChannel class provides an object representing a Telepathy...">OutgoingFileTransferChannel</a> object usable.</p>
<p>Note that this feature must be enabled in order to use most <a class="el" href="classTp_1_1OutgoingFileTransferChannel.html" title="The OutgoingFileTransferChannel class provides an object representing a Telepathy...">OutgoingFileTransferChannel</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_1FileTransferChannel.html#a5f5f0af9fa83ed14c097670c05b0ed71">Tp::FileTransferChannel</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 &copy; 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>