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
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>File Transfer Task: Spice-GTK Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="index.html" title="Spice-GTK Reference Manual">
<link rel="up" href="application-support.html" title="Application Support, from spice-client-glib">
<link rel="prev" href="spice-gtk-SpiceURI.html" title="SpiceURI">
<link rel="next" href="object-tree.html" title="Object Hierarchy">
<meta name="generator" content="GTK-Doc V1.24 (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="#SpiceFileTransferTask.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
<a href="#SpiceFileTransferTask.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties"> <span class="dim">|</span>
<a href="#SpiceFileTransferTask.properties" class="shortcut">Properties</a></span><span id="nav_signals"> <span class="dim">|</span>
<a href="#SpiceFileTransferTask.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="application-support.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="spice-gtk-SpiceURI.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="object-tree.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="SpiceFileTransferTask"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="SpiceFileTransferTask.top_of_page"></a>File Transfer Task</span></h2>
<p>File Transfer Task — Monitoring file transfers</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="SpiceFileTransferTask.stability-level"></a><h2>Stability Level</h2>
<acronym title="The intention of a Stable interface is to enable arbitrary third parties to
develop applications to these interfaces, release them, and have confidence that
they will run on all minor releases of the product (after the one in which the
interface was introduced, and within the same major release). Even at a major
release, incompatible changes are expected to be rare, and to have strong
justifications.
"><span class="acronym">Stable</span></acronym>, unless otherwise indicated
</div>
<div class="refsect1">
<a name="SpiceFileTransferTask.functions"></a><h2>Functions</h2>
<div class="informaltable"><table 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">double</span>
</td>
<td class="function_name">
<a class="link" href="SpiceFileTransferTask.html#spice-file-transfer-task-get-progress" title="spice_file_transfer_task_get_progress ()">spice_file_transfer_task_get_progress</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">char</span> *
</td>
<td class="function_name">
<a class="link" href="SpiceFileTransferTask.html#spice-file-transfer-task-get-filename" title="spice_file_transfer_task_get_filename ()">spice_file_transfer_task_get_filename</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="SpiceFileTransferTask.html#spice-file-transfer-task-cancel" title="spice_file_transfer_task_cancel ()">spice_file_transfer_task_cancel</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="SpiceFileTransferTask.properties"></a><h2>Properties</h2>
<div class="informaltable"><table border="0">
<colgroup>
<col width="150px" class="properties_type">
<col width="300px" class="properties_name">
<col width="200px" class="properties_flags">
</colgroup>
<tbody>
<tr>
<td class="property_type">
<a href="/usr/share/gtk-doc/html/gio/GCancellable.html"><span class="type">GCancellable</span></a> *</td>
<td class="property_name"><a class="link" href="SpiceFileTransferTask.html#SpiceFileTransferTask--cancellable" title="The “cancellable” property">cancellable</a></td>
<td class="property_flags">Read / Write / Construct Only</td>
</tr>
<tr>
<td class="property_type">
<a class="link" href="SpiceMainChannel.html" title="Main Channel"><span class="type">SpiceMainChannel</span></a> *</td>
<td class="property_name"><a class="link" href="SpiceFileTransferTask.html#SpiceFileTransferTask--channel" title="The “channel” property">channel</a></td>
<td class="property_flags">Read / Write / Construct Only</td>
</tr>
<tr>
<td class="property_type">
<a href="/usr/share/gtk-doc/html/gio/GFile.html"><span class="type">GFile</span></a> *</td>
<td class="property_name"><a class="link" href="SpiceFileTransferTask.html#SpiceFileTransferTask--file" title="The “file” property">file</a></td>
<td class="property_flags">Read / Write / Construct Only</td>
</tr>
<tr>
<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a></td>
<td class="property_name"><a class="link" href="SpiceFileTransferTask.html#SpiceFileTransferTask--id" title="The “id” property">id</a></td>
<td class="property_flags">Read / Write / Construct Only</td>
</tr>
<tr>
<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a></td>
<td class="property_name"><a class="link" href="SpiceFileTransferTask.html#SpiceFileTransferTask--progress" title="The “progress” property">progress</a></td>
<td class="property_flags">Read</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="SpiceFileTransferTask.signals"></a><h2>Signals</h2>
<div class="informaltable"><table 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="SpiceFileTransferTask.html#SpiceFileTransferTask-finished" title="The “finished” signal">finished</a></td>
<td class="signal_flags"><a href="/usr/share/gtk-doc/html/gobject/gobject-Signals.html#G-SIGNAL-RUN-FIRST:CAPS">Run First</a></td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="SpiceFileTransferTask.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="SpiceFileTransferTask.html#SpiceFileTransferTask-struct" title="struct SpiceFileTransferTask">SpiceFileTransferTask</a></td>
</tr>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="SpiceFileTransferTask.html#SpiceFileTransferTaskClass" title="struct SpiceFileTransferTaskClass">SpiceFileTransferTaskClass</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="SpiceFileTransferTask.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen"> <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject">GObject</a>
<span class="lineart">╰──</span> SpiceFileTransferTask
</pre>
</div>
<div class="refsect1">
<a name="SpiceFileTransferTask.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include <spice-client.h>
</pre>
</div>
<div class="refsect1">
<a name="SpiceFileTransferTask.description"></a><h2>Description</h2>
<p>SpiceFileTransferTask is an object that represents a particular file
transfer between the client and the guest. The properties and signals of the
object can be used to monitor the status and result of the transfer. The
Main Channel's <a class="link" href="SpiceMainChannel.html#SpiceMainChannel-new-file-transfer" title="The “new-file-transfer” signal"><span class="type">“new-file-transfer”</span></a> signal will be emitted
whenever a new file transfer task is initiated.</p>
</div>
<div class="refsect1">
<a name="SpiceFileTransferTask.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="spice-file-transfer-task-get-progress"></a><h3>spice_file_transfer_task_get_progress ()</h3>
<pre class="programlisting"><span class="returnvalue">double</span>
spice_file_transfer_task_get_progress (<em class="parameter"><code><a class="link" href="SpiceFileTransferTask.html" title="File Transfer Task"><span class="type">SpiceFileTransferTask</span></a> *self</code></em>);</pre>
<p>Convenience function for retrieving the current progress of this file
transfer task.</p>
<div class="refsect3">
<a name="id-1.2.5.8.11.2.5"></a><h4>Parameters</h4>
<div class="informaltable"><table 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>self</p></td>
<td class="parameter_description"><p>a file transfer task</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.5.8.11.2.6"></a><h4>Returns</h4>
<p> A percentage value between 0 and 100</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="spice-file-transfer-task-get-filename"></a><h3>spice_file_transfer_task_get_filename ()</h3>
<pre class="programlisting"><span class="returnvalue">char</span> *
spice_file_transfer_task_get_filename (<em class="parameter"><code><a class="link" href="SpiceFileTransferTask.html" title="File Transfer Task"><span class="type">SpiceFileTransferTask</span></a> *self</code></em>);</pre>
<p>Gets the name of the file being transferred in this task</p>
<div class="refsect3">
<a name="id-1.2.5.8.11.3.5"></a><h4>Parameters</h4>
<div class="informaltable"><table 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>self</p></td>
<td class="parameter_description"><p>a file transfer task</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.5.8.11.3.6"></a><h4>Returns</h4>
<p> The basename of the file. </p>
<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="spice-file-transfer-task-cancel"></a><h3>spice_file_transfer_task_cancel ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
spice_file_transfer_task_cancel (<em class="parameter"><code><a class="link" href="SpiceFileTransferTask.html" title="File Transfer Task"><span class="type">SpiceFileTransferTask</span></a> *self</code></em>);</pre>
<p>Cancels the file transfer task. Note that depending on how the file transfer
was initiated, multiple file transfer tasks may share a single
<span class="type">“cancellable”</span> object, so canceling one task may result
in the cancellation of other tasks.</p>
<div class="refsect3">
<a name="id-1.2.5.8.11.4.5"></a><h4>Parameters</h4>
<div class="informaltable"><table 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>self</p></td>
<td class="parameter_description"><p>a file transfer task</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
</div>
</div>
<div class="refsect1">
<a name="SpiceFileTransferTask.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="SpiceFileTransferTask-struct"></a><h3>struct SpiceFileTransferTask</h3>
<pre class="programlisting">struct SpiceFileTransferTask;</pre>
<p>The <span class="type">FileTransferTask</span> struct is opaque and should not be accessed directly.</p>
</div>
<hr>
<div class="refsect2">
<a name="SpiceFileTransferTaskClass"></a><h3>struct SpiceFileTransferTaskClass</h3>
<pre class="programlisting">struct SpiceFileTransferTaskClass {
GObjectClass parent_class;
};
</pre>
<p>Class structure for <a class="link" href="SpiceFileTransferTask.html" title="File Transfer Task"><span class="type">SpiceFileTransferTask</span></a>.</p>
<div class="refsect3">
<a name="id-1.2.5.8.12.3.5"></a><h4>Members</h4>
<div class="informaltable"><table 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><a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObjectClass"><span class="type">GObjectClass</span></a> <em class="structfield"><code><a name="SpiceFileTransferTaskClass.parent-class"></a>parent_class</code></em>;</p></td>
<td class="struct_member_description"><p>Parent class.</p></td>
<td class="struct_member_annotations"> </td>
</tr></tbody>
</table></div>
</div>
</div>
</div>
<div class="refsect1">
<a name="SpiceFileTransferTask.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="SpiceFileTransferTask--cancellable"></a><h3>The <code class="literal">“cancellable”</code> property</h3>
<pre class="programlisting"> “cancellable” <a href="/usr/share/gtk-doc/html/gio/GCancellable.html"><span class="type">GCancellable</span></a> *</pre>
<p>A cancellable object used to cancel the file transfer</p>
<p>Flags: Read / Write / Construct Only</p>
</div>
<hr>
<div class="refsect2">
<a name="SpiceFileTransferTask--channel"></a><h3>The <code class="literal">“channel”</code> property</h3>
<pre class="programlisting"> “channel” <a class="link" href="SpiceMainChannel.html" title="Main Channel"><span class="type">SpiceMainChannel</span></a> *</pre>
<p>The main channel that owns the file transfer task</p>
<p>Flags: Read / Write / Construct Only</p>
</div>
<hr>
<div class="refsect2">
<a name="SpiceFileTransferTask--file"></a><h3>The <code class="literal">“file”</code> property</h3>
<pre class="programlisting"> “file” <a href="/usr/share/gtk-doc/html/gio/GFile.html"><span class="type">GFile</span></a> *</pre>
<p>The file that is being transferred in this file transfer task</p>
<p>Flags: Read / Write / Construct Only</p>
</div>
<hr>
<div class="refsect2">
<a name="SpiceFileTransferTask--id"></a><h3>The <code class="literal">“id”</code> property</h3>
<pre class="programlisting"> “id” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a></pre>
<p>The ID of the file transfer task</p>
<p>Flags: Read / Write / Construct Only</p>
<p>Default value: 0</p>
</div>
<hr>
<div class="refsect2">
<a name="SpiceFileTransferTask--progress"></a><h3>The <code class="literal">“progress”</code> property</h3>
<pre class="programlisting"> “progress” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a></pre>
<p>The current state of the file transfer. This value indicates a
percentage, and ranges from 0 to 100. Listen for change notifications on
this property to be updated whenever the file transfer progress changes.</p>
<p>Flags: Read</p>
<p>Allowed values: [0,100]</p>
<p>Default value: 0</p>
</div>
</div>
<div class="refsect1">
<a name="SpiceFileTransferTask.signal-details"></a><h2>Signal Details</h2>
<div class="refsect2">
<a name="SpiceFileTransferTask-finished"></a><h3>The <code class="literal">“finished”</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
user_function (<a class="link" href="SpiceFileTransferTask.html" title="File Transfer Task"><span class="type">SpiceFileTransferTask</span></a> *task,
<a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> *error,
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data)</pre>
<p>The <a class="link" href="SpiceFileTransferTask.html#SpiceFileTransferTask-finished" title="The “finished” signal"><span class="type">“finished”</span></a> signal is emitted when the file
transfer has completed transferring to the guest.</p>
<div class="refsect3">
<a name="id-1.2.5.8.14.2.5"></a><h4>Parameters</h4>
<div class="informaltable"><table 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>task</p></td>
<td class="parameter_description"><p>the file transfer task that emitted the signal</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p> the error state of the transfer. Will be <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>
if the file transfer was successful. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></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: <a href="/usr/share/gtk-doc/html/gobject/gobject-Signals.html#G-SIGNAL-RUN-FIRST:CAPS">Run First</a></p>
</div>
</div>
<div class="refsect1">
<a name="SpiceFileTransferTask.see-also"></a><h2>See Also</h2>
<p><a class="link" href="SpiceMainChannel.html" title="Main Channel"><span class="type">SpiceMainChannel</span></a></p>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.24</div>
</body>
</html>
|
