IMSA Bind response: libqmi-glib Reference Manual

IMSA Bind response

IMSA Bind response — Methods to manage the IMSA Bind response.

Functions

QmiMessageImsaBindInput *	qmi_message_imsa_bind_input_new ()
QmiMessageImsaBindInput *	qmi_message_imsa_bind_input_ref ()
void	qmi_message_imsa_bind_input_unref ()
gboolean	qmi_message_imsa_bind_input_get_binding ()
gboolean	qmi_message_imsa_bind_input_set_binding ()
QmiMessageImsaBindOutput *	qmi_message_imsa_bind_output_ref ()
void	qmi_message_imsa_bind_output_unref ()
gboolean	qmi_message_imsa_bind_output_get_result ()
QmiMessageImsaBindOutput *	qmi_message_imsa_bind_response_parse ()
void	qmi_client_imsa_bind ()
QmiMessageImsaBindOutput *	qmi_client_imsa_bind_finish ()

Types and Values

	QmiMessageImsaBindInput
	QmiMessageImsaBindOutput

Object Hierarchy

    GBoxed
    ├── QmiMessageImsaBindInput
    ╰── QmiMessageImsaBindOutput

Description

Collection of methods to create requests and parse responses of the IMSA Bind message.

Functions

qmi_message_imsa_bind_input_new ()

QmiMessageImsaBindInput *
qmi_message_imsa_bind_input_new (void);

Allocates a new QmiMessageImsaBindInput.

Returns

the newly created QmiMessageImsaBindInput. The returned value should be freed with qmi_message_imsa_bind_input_unref().

Since: 1.36

qmi_message_imsa_bind_input_ref ()

QmiMessageImsaBindInput *
qmi_message_imsa_bind_input_ref (QmiMessageImsaBindInput *self);

Atomically increments the reference count of self by one.

Parameters

self

a QmiMessageImsaBindInput.

Returns

the new reference to self .

Since: 1.36

qmi_message_imsa_bind_input_unref ()

void
qmi_message_imsa_bind_input_unref (QmiMessageImsaBindInput *self);

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

Parameters

self

a QmiMessageImsaBindInput.

Since: 1.36

qmi_message_imsa_bind_input_get_binding ()

gboolean
qmi_message_imsa_bind_input_get_binding
                               (QmiMessageImsaBindInput *self,
                                guint32 *value_binding,
                                GError **error);

Get the 'Binding' field from self .

Parameters

self	a QmiMessageImsaBindInput.
value_binding	a placeholder for the output guint32, or `NULL` if not required.	[out][optional]
error	Return location for error or `NULL`.

Returns

TRUE if the field is found, FALSE otherwise.

[skip]

Since: 1.36

qmi_message_imsa_bind_input_set_binding ()

gboolean
qmi_message_imsa_bind_input_set_binding
                               (QmiMessageImsaBindInput *self,
                                guint32 value_binding,
                                GError **error);

Set the 'Binding' field in the message.

Parameters

self	a QmiMessageImsaBindInput.
value_binding	a guint32.
error	Return location for error or `NULL`.

Returns

TRUE if value was successfully set, FALSE otherwise.

[skip]

Since: 1.36

qmi_message_imsa_bind_output_ref ()

QmiMessageImsaBindOutput *
qmi_message_imsa_bind_output_ref (QmiMessageImsaBindOutput *self);

Atomically increments the reference count of self by one.

Parameters

self

a QmiMessageImsaBindOutput.

Returns

the new reference to self .

Since: 1.36

qmi_message_imsa_bind_output_unref ()

void
qmi_message_imsa_bind_output_unref (QmiMessageImsaBindOutput *self);

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

Parameters

self

a QmiMessageImsaBindOutput.

Since: 1.36

qmi_message_imsa_bind_output_get_result ()

gboolean
qmi_message_imsa_bind_output_get_result
                               (QmiMessageImsaBindOutput *self,
                                GError **error);

Get the result of the QMI operation.

Parameters

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

Returns

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

[skip]

Since: 1.36

qmi_message_imsa_bind_response_parse ()

QmiMessageImsaBindOutput *
qmi_message_imsa_bind_response_parse (QmiMessage *message,
                                      GError **error);

Parses a QmiMessage and builds a QmiMessageImsaBindOutput 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 QmiMessageImsaBindOutput, or NULL if error is set. The returned value should be freed with qmi_message_imsa_bind_output_unref().

Since: 1.36

qmi_client_imsa_bind ()

void
qmi_client_imsa_bind (QmiClientImsa *self,
                      QmiMessageImsaBindInput *input,
                      guint timeout,
                      GCancellable *cancellable,
                      GAsyncReadyCallback callback,
                      gpointer user_data);

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

Parameters

self	a QmiClientImsa.
input	a QmiMessageImsaBindInput.
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.36

qmi_client_imsa_bind_finish ()

QmiMessageImsaBindOutput *
qmi_client_imsa_bind_finish (QmiClientImsa *self,
                             GAsyncResult *res,
                             GError **error);

Finishes an async operation started with qmi_client_imsa_bind().

Parameters

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

Returns

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

Since: 1.36

Types and Values

QmiMessageImsaBindInput

typedef struct _QmiMessageImsaBindInput QmiMessageImsaBindInput;

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

Since: 1.36

QmiMessageImsaBindOutput

typedef struct _QmiMessageImsaBindOutput QmiMessageImsaBindOutput;

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

Since: 1.36