KaimingTransactionProgress

KaimingTransactionProgress — Progress of an operation

Functions

Signals

Types and Values

Object Hierarchy

    GObject
    ╰── KaimingTransactionProgress

Description

KaimingTransactionProgress is an object that represents the progress of a single operation in a transaction. You obtain a KaimingTransactionProgress with the “new-operation” signal.

Functions

kaiming_transaction_progress_get_is_estimating ()

gboolean
kaiming_transaction_progress_get_is_estimating
                               (KaimingTransactionProgress *self);

Gets whether the progress is currently estimating

Parameters

Returns

whether we're estimating


kaiming_transaction_progress_get_progress ()

int
kaiming_transaction_progress_get_progress
                               (KaimingTransactionProgress *self);

Gets the current progress.

Parameters

Returns

the current progress, as an integer between 0 and 100


kaiming_transaction_progress_get_status ()

char *
kaiming_transaction_progress_get_status
                               (KaimingTransactionProgress *self);

Gets the current status string

Parameters

Returns

the current status.

[transfer full]


kaiming_transaction_progress_set_update_frequency ()

void
kaiming_transaction_progress_set_update_frequency
                               (KaimingTransactionProgress *self,
                                guint update_interval);

Sets how often progress should be updated.

Parameters

self

a KaimingTransactionProgress

 

update_interval

the update interval, in milliseconds

 

kaiming_transaction_progress_get_bytes_transferred ()

guint64
kaiming_transaction_progress_get_bytes_transferred
                               (KaimingTransactionProgress *self);

Gets the number of bytes that have been transferred.

Parameters

Returns

the number of bytes transferred

Since: 1.1.2


kaiming_transaction_progress_get_start_time ()

guint64
kaiming_transaction_progress_get_start_time
                               (KaimingTransactionProgress *self);

Gets the time at which this operation has started, as monotonic time.

Parameters

Returns

the start time

Since: 1.1.2

Types and Values

KaimingTransactionProgress

typedef struct _KaimingTransactionProgress KaimingTransactionProgress;

Signal Details

The “changed” signal

void
user_function (KaimingTransactionProgress *object,
               gpointer                    user_data)

Emitted when some detail of the progress object changes, you can call the various methods to get the current status.

Parameters

object

A KaimingTransactionProgress

 

user_data

user data set when the signal handler was connected.

 

Flags: Run Last