SpiceClientGLib.FileTransferTask¶

Subclasses:: None

Methods¶

Inherited:: GObject.Object (37)
Structs:: GObject.ObjectClass (5)

	`cancel` ()
	`get_filename` ()
	`get_progress` ()
	`get_total_bytes` ()
	`get_transferred_bytes` ()

Virtual Methods¶

Inherited:: GObject.Object (7)

Properties¶

Name	Type	Flags	Short Description
`cancellable`	`Gio.Cancellable`	r/w/co	The object used to cancel the task
`channel`	`SpiceClientGLib.MainChannel`	r/w/co	The channel transferring the file
`file`	`Gio.File`	r/w/co	The file being transferred
`id`	`int`	r/w/co	The id of the task
`progress`	`float`	r	The percentage of the file transferred
`total-bytes`	`int`	r	The size in bytes of the file transferred
`transferred-bytes`	`int`	r	The number of bytes transferred

Signals¶

Inherited:: GObject.Object (1)

Name	Short Description
`finished`

Fields¶

Inherited:: GObject.Object (1)

Class Details¶

class SpiceClientGLib.FileTransferTask(**kwargs)¶

Bases:: GObject.Object
Abstract:: No
Structure:: SpiceClientGLib.FileTransferTaskClass

cancel()¶

get_filename()¶

Return type:: str

get_progress()¶

Return type:: float

get_total_bytes()¶

Return type:: int

get_transferred_bytes()¶

Return type:: int

Signal Details¶

SpiceClientGLib.FileTransferTask.signals.finished(file_transfer_task, object)¶

Signal Name:

finished

Flags:

RUN_FIRST

Parameters:

file_transfer_task (SpiceClientGLib.FileTransferTask) – The object which received the signal
object (GLib.Error) –

Property Details¶

SpiceClientGLib.FileTransferTask.props.cancellable¶

Name:: cancellable
Type:: Gio.Cancellable
Default Value:: None
Flags:: READABLE, WRITABLE, CONSTRUCT_ONLY

The object used to cancel the task

SpiceClientGLib.FileTransferTask.props.channel¶

Name:: channel
Type:: SpiceClientGLib.MainChannel
Default Value:: None
Flags:: READABLE, WRITABLE, CONSTRUCT_ONLY

The channel transferring the file

SpiceClientGLib.FileTransferTask.props.file¶

Name:: file
Type:: Gio.File
Default Value:: None
Flags:: READABLE, WRITABLE, CONSTRUCT_ONLY

The file being transferred

SpiceClientGLib.FileTransferTask.props.id¶

Name:: id
Type:: int
Default Value:: 0
Flags:: READABLE, WRITABLE, CONSTRUCT_ONLY

The id of the task

SpiceClientGLib.FileTransferTask.props.progress¶

Name:: progress
Type:: float
Default Value:: 0.0
Flags:: READABLE

The percentage of the file transferred

SpiceClientGLib.FileTransferTask.props.total_bytes¶

Name:: total-bytes
Type:: int
Default Value:: 0
Flags:: READABLE

The size in bytes of the file transferred

SpiceClientGLib.FileTransferTask.props.transferred_bytes¶

Name:: transferred-bytes
Type:: int
Default Value:: 0
Flags:: READABLE

The number of bytes transferred