WMS Get Message Protocol response: libqmi-glib Reference Manual

WMS Get Message Protocol response

WMS Get Message Protocol response — Methods to manage the WMS Get Message Protocol response.

Functions

QmiMessageWmsGetMessageProtocolOutput *	qmi_message_wms_get_message_protocol_output_ref ()
void	qmi_message_wms_get_message_protocol_output_unref ()
gboolean	qmi_message_wms_get_message_protocol_output_get_result ()
gboolean	qmi_message_wms_get_message_protocol_output_get_message_protocol ()
QmiMessageWmsGetMessageProtocolOutput *	qmi_message_wms_get_message_protocol_response_parse ()
void	qmi_client_wms_get_message_protocol ()
QmiMessageWmsGetMessageProtocolOutput *	qmi_client_wms_get_message_protocol_finish ()

Types and Values

QmiMessageWmsGetMessageProtocolOutput

Object Hierarchy

    GBoxed
    ╰── QmiMessageWmsGetMessageProtocolOutput

Description

Collection of methods to create requests and parse responses of the WMS Get Message Protocol message.

Functions

qmi_message_wms_get_message_protocol_output_ref ()

QmiMessageWmsGetMessageProtocolOutput *
qmi_message_wms_get_message_protocol_output_ref
                               (QmiMessageWmsGetMessageProtocolOutput *self);

Atomically increments the reference count of self by one.

Parameters

self

a QmiMessageWmsGetMessageProtocolOutput.

Returns

the new reference to self .

Since: 1.0

qmi_message_wms_get_message_protocol_output_unref ()

void
qmi_message_wms_get_message_protocol_output_unref
                               (QmiMessageWmsGetMessageProtocolOutput *self);

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

Parameters

self

a QmiMessageWmsGetMessageProtocolOutput.

Since: 1.0

qmi_message_wms_get_message_protocol_output_get_result ()

gboolean
qmi_message_wms_get_message_protocol_output_get_result
                               (QmiMessageWmsGetMessageProtocolOutput *self,
                                GError **error);

Get the result of the QMI operation.

Parameters

self	a QmiMessageWmsGetMessageProtocolOutput.
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_wms_get_message_protocol_output_get_message_protocol ()

gboolean
qmi_message_wms_get_message_protocol_output_get_message_protocol
                               (QmiMessageWmsGetMessageProtocolOutput *self,
                                QmiWmsMessageProtocol *value_message_protocol,
                                GError **error);

Get the 'Message Protocol' field from self .

Parameters

self	a QmiMessageWmsGetMessageProtocolOutput.
value_message_protocol	a placeholder for the output QmiWmsMessageProtocol, 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.0

qmi_message_wms_get_message_protocol_response_parse ()

QmiMessageWmsGetMessageProtocolOutput *
qmi_message_wms_get_message_protocol_response_parse
                               (QmiMessage *message,
                                GError **error);

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

Since: 1.34

qmi_client_wms_get_message_protocol ()

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

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

Parameters

self	a QmiClientWms.
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_wms_get_message_protocol_finish ()

QmiMessageWmsGetMessageProtocolOutput *
qmi_client_wms_get_message_protocol_finish
                               (QmiClientWms *self,
                                GAsyncResult *res,
                                GError **error);

Finishes an async operation started with qmi_client_wms_get_message_protocol().

Parameters

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

Returns

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

Since: 1.0

Types and Values

QmiMessageWmsGetMessageProtocolOutput

typedef struct _QmiMessageWmsGetMessageProtocolOutput QmiMessageWmsGetMessageProtocolOutput;

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

Since: 1.0