WDS Go Dormant request: libqmi-glib Reference Manual

WDS Go Dormant request

Functions

QmiMessageWdsGoDormantOutput *	qmi_message_wds_go_dormant_output_ref ()
void	qmi_message_wds_go_dormant_output_unref ()
gboolean	qmi_message_wds_go_dormant_output_get_result ()
void	qmi_client_wds_go_dormant ()
QmiMessageWdsGoDormantOutput *	qmi_client_wds_go_dormant_finish ()

Types and Values

QmiMessageWdsGoDormantOutput

Object Hierarchy

    GBoxed
    ╰── QmiMessageWdsGoDormantOutput

Description

Functions

qmi_message_wds_go_dormant_output_ref ()

QmiMessageWdsGoDormantOutput *
qmi_message_wds_go_dormant_output_ref (QmiMessageWdsGoDormantOutput *self);

Atomically increments the reference count of self by one.

Parameters

self

a QmiMessageWdsGoDormantOutput.

Returns

the new reference to self .

Since: 1.18

qmi_message_wds_go_dormant_output_unref ()

void
qmi_message_wds_go_dormant_output_unref
                               (QmiMessageWdsGoDormantOutput *self);

Atomically decrements the reference count of self by one. If the reference count drops to 0, self is completely disposed.

Parameters

self

a QmiMessageWdsGoDormantOutput.

Since: 1.18

qmi_message_wds_go_dormant_output_get_result ()

gboolean
qmi_message_wds_go_dormant_output_get_result
                               (QmiMessageWdsGoDormantOutput *self,
                                GError **error);

Get the result of the QMI operation.

Parameters

self	a QmiMessageWdsGoDormantOutput.
error	Return location for error or `NULL`.

Returns

TRUE if the QMI operation succeeded, FALSE if error is set.

Since: 1.18

qmi_client_wds_go_dormant ()

void
qmi_client_wds_go_dormant (QmiClientWds *self,
                           gpointer unused,
                           guint timeout,
                           GCancellable *cancellable,
                           GAsyncReadyCallback callback,
                           gpointer user_data);

Asynchronously sends a Go Dormant request to the device.

When the operation is finished, callback will be invoked in the thread-default main loop of the thread you are calling this method from.

You can then call qmi_client_wds_go_dormant_finish() to get the result of the operation.

Parameters

self	a QmiClientWds.
unused	`NULL`. This message doesn't have any input bundle.
timeout	maximum time to wait for the method to complete, in seconds.
cancellable	a GCancellable or `NULL`.
callback	a GAsyncReadyCallback to call when the request is satisfied.
user_data	user data to pass to `callback` .

Since: 1.18

qmi_client_wds_go_dormant_finish ()

QmiMessageWdsGoDormantOutput *
qmi_client_wds_go_dormant_finish (QmiClientWds *self,
                                  GAsyncResult *res,
                                  GError **error);

Finishes an async operation started with qmi_client_wds_go_dormant().

Parameters

self	a QmiClientWds.
res	the GAsyncResult obtained from the GAsyncReadyCallback passed to `qmi_client_wds_go_dormant()`.
error	Return location for error or `NULL`.

Returns

a QmiMessageWdsGoDormantOutput, or NULL if error is set. The returned value should be freed with qmi_message_wds_go_dormant_output_unref().

Since: 1.18

Types and Values

QmiMessageWdsGoDormantOutput

typedef struct _QmiMessageWdsGoDormantOutput QmiMessageWdsGoDormantOutput;

The QmiMessageWdsGoDormantOutput structure contains private data and should only be accessed using the provided API.

Since: 1.18