DMS Get Model response: libqmi-glib Reference Manual

DMS Get Model response

DMS Get Model response — Methods to manage the DMS Get Model response.

Functions

QmiMessageDmsGetModelOutput *	qmi_message_dms_get_model_output_ref ()
void	qmi_message_dms_get_model_output_unref ()
gboolean	qmi_message_dms_get_model_output_get_result ()
gboolean	qmi_message_dms_get_model_output_get_model ()
QmiMessageDmsGetModelOutput *	qmi_message_dms_get_model_response_parse ()
void	qmi_client_dms_get_model ()
QmiMessageDmsGetModelOutput *	qmi_client_dms_get_model_finish ()

Types and Values

QmiMessageDmsGetModelOutput

Object Hierarchy

    GBoxed
    ╰── QmiMessageDmsGetModelOutput

Description

Collection of methods to create requests and parse responses of the DMS Get Model message.

Functions

qmi_message_dms_get_model_output_ref ()

QmiMessageDmsGetModelOutput *
qmi_message_dms_get_model_output_ref (QmiMessageDmsGetModelOutput *self);

Atomically increments the reference count of self by one.

Parameters

self

a QmiMessageDmsGetModelOutput.

Returns

the new reference to self .

Since: 1.0

qmi_message_dms_get_model_output_unref ()

void
qmi_message_dms_get_model_output_unref
                               (QmiMessageDmsGetModelOutput *self);

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

Parameters

self

a QmiMessageDmsGetModelOutput.

Since: 1.0

qmi_message_dms_get_model_output_get_result ()

gboolean
qmi_message_dms_get_model_output_get_result
                               (QmiMessageDmsGetModelOutput *self,
                                GError **error);

Get the result of the QMI operation.

Parameters

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

Returns

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

[skip]

Since: 1.0

qmi_message_dms_get_model_output_get_model ()

gboolean
qmi_message_dms_get_model_output_get_model
                               (QmiMessageDmsGetModelOutput *self,
                                const gchar **value_model,
                                GError **error);

Get the 'Model' field from self .

Parameters

self	a QmiMessageDmsGetModelOutput.
value_model	a placeholder for the output constant string, or `NULL` if not required.	[out][optional][transfer none]
error	Return location for error or `NULL`.

Returns

TRUE if the field is found, FALSE otherwise.

[skip]

Since: 1.0

qmi_message_dms_get_model_response_parse ()

QmiMessageDmsGetModelOutput *
qmi_message_dms_get_model_response_parse
                               (QmiMessage *message,
                                GError **error);

Parses a QmiMessage and builds a QmiMessageDmsGetModelOutput out of it. The operation fails if the message is of the wrong type.

Parameters

message	a QmiMessage.
error	return location for error or `NULL`.

Returns

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

Since: 1.34

qmi_client_dms_get_model ()

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

Asynchronously sends a Get Model 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_dms_get_model_finish() to get the result of the operation.

Parameters

self	a QmiClientDms.
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.0

qmi_client_dms_get_model_finish ()

QmiMessageDmsGetModelOutput *
qmi_client_dms_get_model_finish (QmiClientDms *self,
                                 GAsyncResult *res,
                                 GError **error);

Finishes an async operation started with qmi_client_dms_get_model().

Parameters

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

Returns

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

Since: 1.0

Types and Values

QmiMessageDmsGetModelOutput

typedef struct _QmiMessageDmsGetModelOutput QmiMessageDmsGetModelOutput;

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

Since: 1.0