Top |
Progress notification system for asynchronous operationsProgress notification system for asynchronous operations — Values representing progress |
OstreeAsyncProgress * | ostree_async_progress_new () |
OstreeAsyncProgress * | ostree_async_progress_new_and_connect () |
void | ostree_async_progress_copy_state () |
char * | ostree_async_progress_get_status () |
void | ostree_async_progress_get () |
GVariant * | ostree_async_progress_get_variant () |
guint | ostree_async_progress_get_uint () |
guint64 | ostree_async_progress_get_uint64 () |
void | ostree_async_progress_set_status () |
void | ostree_async_progress_set () |
void | ostree_async_progress_set_variant () |
void | ostree_async_progress_set_uint () |
void | ostree_async_progress_set_uint64 () |
void | ostree_async_progress_finish () |
For many asynchronous operations, it's desirable for callers to be able to watch their status as they progress. For example, an user interface calling an asynchronous download operation will want to be able to see the total number of bytes downloaded.
This class provides a mechanism for callees of asynchronous operations to communicate back with callers. It transparently handles thread safety, ensuring that the progress change notification occurs in the thread-default context of the calling operation.
The ostree_async_progress_get_status()
and ostree_async_progress_set_status()
methods get and set a well-known status
key of type G_VARIANT_TYPE_STRING
.
This key may be accessed using the other OstreeAsyncProgress methods, but it
must always have the correct type.
OstreeAsyncProgress * ostree_async_progress_new_and_connect (void (*changed) (OstreeAsyncProgress *self, gpointer user_data)
,gpointer user_data
);
[skip]
void ostree_async_progress_copy_state (OstreeAsyncProgress *self
,OstreeAsyncProgress *dest
);
Atomically copies all the state from self
to dest
, without invoking the
callback.
This is used for proxying progress objects across different GMainContexts.
Since: 2019.6
char *
ostree_async_progress_get_status (OstreeAsyncProgress *self
);
Get the human-readable status string from the OstreeAsyncProgress. This
operation is thread-safe. The retuned value may be NULL
if no status is
set.
This is a convenience function to get the well-known status
key.
Since: 2017.6
void ostree_async_progress_get (OstreeAsyncProgress *self
,...
);
Get the values corresponding to zero or more keys from the
OstreeAsyncProgress. Each key is specified in @... as the key name, followed
by a GVariant format string, followed by the necessary arguments for that
format string, just as for g_variant_get()
. After those arguments is the
next key name. The varargs list must be NULL
-terminated.
Each format string must make deep copies of its value, as the values stored in the OstreeAsyncProgress may be freed from another thread after this function returns.
This operation is thread-safe, and all the keys are queried atomically.
1 2 3 4 5 6 7 8 9 10 11 |
guint32 outstanding_fetches; guint64 bytes_received; g_autofree gchar *status = NULL; g_autoptr(GVariant) refs_variant = NULL; ostree_async_progress_get (progress, "outstanding-fetches", "u", &outstanding_fetches, "bytes-received", "t", &bytes_received, "status", "s", &status, "refs", "@a{ss}", &refs_variant, NULL); |
Since: 2017.6
GVariant * ostree_async_progress_get_variant (OstreeAsyncProgress *self
,const char *key
);
Look up a key in the OstreeAsyncProgress and return the GVariant associated with it. The lookup is thread-safe.
Since: 2017.6
guint ostree_async_progress_get_uint (OstreeAsyncProgress *self
,const char *key
);
guint64 ostree_async_progress_get_uint64 (OstreeAsyncProgress *self
,const char *key
);
void ostree_async_progress_set_status (OstreeAsyncProgress *self
,const char *status
);
Set the human-readable status string for the OstreeAsyncProgress. This
operation is thread-safe. NULL
may be passed to clear the status.
This is a convenience function to set the well-known status
key.
Since: 2017.6
void ostree_async_progress_set (OstreeAsyncProgress *self
,...
);
Set the values for zero or more keys in the OstreeAsyncProgress. Each key is
specified in @... as the key name, followed by a GVariant format string,
followed by the necessary arguments for that format string, just as for
g_variant_new()
. After those arguments is the next key name. The varargs list
must be NULL
-terminated.
g_variant_ref_sink() will be called as appropriate on the GVariant parameters, so they may be floating.
This operation is thread-safe, and all the keys are set atomically.
1 2 3 4 5 6 7 8 9 |
guint32 outstanding_fetches = 15; guint64 bytes_received = 1000; ostree_async_progress_set (progress, "outstanding-fetches", "u", outstanding_fetches, "bytes-received", "t", bytes_received, "status", "s", "Updated status", "refs", "@a{ss}", g_variant_new_parsed ("@a{ss} {}"), NULL); |
Since: 2017.6
void ostree_async_progress_set_variant (OstreeAsyncProgress *self
,const char *key
,GVariant *value
);
Assign a new value
to the given key
, replacing any existing value. The
operation is thread-safe. value
may be a floating reference;
g_variant_ref_sink()
will be called on it.
Any watchers of the OstreeAsyncProgress will be notified of the change if
value
differs from the existing value for key
.
Since: 2017.6
void ostree_async_progress_set_uint (OstreeAsyncProgress *self
,const char *key
,guint value
);
void ostree_async_progress_set_uint64 (OstreeAsyncProgress *self
,const char *key
,guint64 value
);
void
ostree_async_progress_finish (OstreeAsyncProgress *self
);
Process any pending signals, ensuring the main context is cleared of sources used by this object. Also ensures that no further events will be queued.