PDS Set AGPS Config response: libqmi-glib Reference Manual

PDS Set AGPS Config response

PDS Set AGPS Config response — Methods to manage the PDS Set AGPS Config response.

Functions

QmiMessagePdsSetAgpsConfigInput *	qmi_message_pds_set_agps_config_input_new ()
QmiMessagePdsSetAgpsConfigInput *	qmi_message_pds_set_agps_config_input_ref ()
void	qmi_message_pds_set_agps_config_input_unref ()
gboolean	qmi_message_pds_set_agps_config_input_get_network_mode ()
gboolean	qmi_message_pds_set_agps_config_input_set_network_mode ()
gboolean	qmi_message_pds_set_agps_config_input_get_location_server_url ()
gboolean	qmi_message_pds_set_agps_config_input_set_location_server_url ()
gboolean	qmi_message_pds_set_agps_config_input_get_location_server_address ()
gboolean	qmi_message_pds_set_agps_config_input_set_location_server_address ()
QmiMessagePdsSetAgpsConfigOutput *	qmi_message_pds_set_agps_config_output_ref ()
void	qmi_message_pds_set_agps_config_output_unref ()
gboolean	qmi_message_pds_set_agps_config_output_get_result ()
QmiMessagePdsSetAgpsConfigOutput *	qmi_message_pds_set_agps_config_response_parse ()
void	qmi_client_pds_set_agps_config ()
QmiMessagePdsSetAgpsConfigOutput *	qmi_client_pds_set_agps_config_finish ()

Types and Values

	QmiMessagePdsSetAgpsConfigInput
	QmiMessagePdsSetAgpsConfigOutput

Object Hierarchy

    GBoxed
    ├── QmiMessagePdsSetAgpsConfigInput
    ╰── QmiMessagePdsSetAgpsConfigOutput

Description

Collection of methods to create requests and parse responses of the PDS Set AGPS Config message.

Functions

qmi_message_pds_set_agps_config_input_new ()

QmiMessagePdsSetAgpsConfigInput *
qmi_message_pds_set_agps_config_input_new
                               (void);

Allocates a new QmiMessagePdsSetAgpsConfigInput.

Returns

the newly created QmiMessagePdsSetAgpsConfigInput. The returned value should be freed with qmi_message_pds_set_agps_config_input_unref().

Since: 1.12

qmi_message_pds_set_agps_config_input_ref ()

QmiMessagePdsSetAgpsConfigInput *
qmi_message_pds_set_agps_config_input_ref
                               (QmiMessagePdsSetAgpsConfigInput *self);

Atomically increments the reference count of self by one.

Parameters

self

a QmiMessagePdsSetAgpsConfigInput.

Returns

the new reference to self .

Since: 1.12

qmi_message_pds_set_agps_config_input_unref ()

void
qmi_message_pds_set_agps_config_input_unref
                               (QmiMessagePdsSetAgpsConfigInput *self);

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

Parameters

self

a QmiMessagePdsSetAgpsConfigInput.

Since: 1.12

qmi_message_pds_set_agps_config_input_get_network_mode ()

gboolean
qmi_message_pds_set_agps_config_input_get_network_mode
                               (QmiMessagePdsSetAgpsConfigInput *self,
                                QmiPdsNetworkMode *value_network_mode,
                                GError **error);

Get the 'Network Mode' field from self .

Parameters

self	a QmiMessagePdsSetAgpsConfigInput.
value_network_mode	a placeholder for the output QmiPdsNetworkMode, 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.12

qmi_message_pds_set_agps_config_input_set_network_mode ()

gboolean
qmi_message_pds_set_agps_config_input_set_network_mode
                               (QmiMessagePdsSetAgpsConfigInput *self,
                                QmiPdsNetworkMode value_network_mode,
                                GError **error);

Set the 'Network Mode' field in the message.

Parameters

self	a QmiMessagePdsSetAgpsConfigInput.
value_network_mode	a QmiPdsNetworkMode.
error	Return location for error or `NULL`.

Returns

TRUE if value was successfully set, FALSE otherwise.

[skip]

Since: 1.12

qmi_message_pds_set_agps_config_input_get_location_server_url ()

gboolean
qmi_message_pds_set_agps_config_input_get_location_server_url
                               (QmiMessagePdsSetAgpsConfigInput *self,
                                GArray **value_location_server_url,
                                GError **error);

Get the 'Location Server URL' field from self .

Parameters

self	a QmiMessagePdsSetAgpsConfigInput.
value_location_server_url	a placeholder for the output GArray of guint8 elements, or `NULL` if not required. Do not free it, it is owned by `self` .	[out][optional][element-type guint8][transfer none]
error	Return location for error or `NULL`.

Returns

TRUE if the field is found, FALSE otherwise.

[skip]

Since: 1.12

qmi_message_pds_set_agps_config_input_set_location_server_url ()

gboolean
qmi_message_pds_set_agps_config_input_set_location_server_url
                               (QmiMessagePdsSetAgpsConfigInput *self,
                                GArray *value_location_server_url,
                                GError **error);

Set the 'Location Server URL' field in the message.

Parameters

self	a QmiMessagePdsSetAgpsConfigInput.
value_location_server_url	a GArray of guint8 elements. A new reference to `value_location_server_url` will be taken, so the caller must make sure the array was created with the correct GDestroyNotify as clear function for each element in the array.	[in][element-type guint8][transfer none]
error	Return location for error or `NULL`.

Returns

TRUE if value was successfully set, FALSE otherwise.

[skip]

Since: 1.12

qmi_message_pds_set_agps_config_input_get_location_server_address ()

gboolean
qmi_message_pds_set_agps_config_input_get_location_server_address
                               (QmiMessagePdsSetAgpsConfigInput *self,
                                guint32 *value_location_server_address_ip,
                                guint32 *value_location_server_address_port,
                                GError **error);

Get the 'Location Server Address' field from self .

Parameters

self	a QmiMessagePdsSetAgpsConfigInput.
value_location_server_address_ip	a placeholder for the output guint32, or `NULL` if not required.	[out][optional]
value_location_server_address_port	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.12

qmi_message_pds_set_agps_config_input_set_location_server_address ()

gboolean
qmi_message_pds_set_agps_config_input_set_location_server_address
                               (QmiMessagePdsSetAgpsConfigInput *self,
                                guint32 value_location_server_address_ip,
                                guint32 value_location_server_address_port,
                                GError **error);

Set the 'Location Server Address' field in the message.

Parameters

self	a QmiMessagePdsSetAgpsConfigInput.
value_location_server_address_ip	a guint32.
value_location_server_address_port	a guint32.
error	Return location for error or `NULL`.

Returns

TRUE if value was successfully set, FALSE otherwise.

[skip]

Since: 1.12

qmi_message_pds_set_agps_config_output_ref ()

QmiMessagePdsSetAgpsConfigOutput *
qmi_message_pds_set_agps_config_output_ref
                               (QmiMessagePdsSetAgpsConfigOutput *self);

Atomically increments the reference count of self by one.

Parameters

self

a QmiMessagePdsSetAgpsConfigOutput.

Returns

the new reference to self .

Since: 1.12

qmi_message_pds_set_agps_config_output_unref ()

void
qmi_message_pds_set_agps_config_output_unref
                               (QmiMessagePdsSetAgpsConfigOutput *self);

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

Parameters

self

a QmiMessagePdsSetAgpsConfigOutput.

Since: 1.12

qmi_message_pds_set_agps_config_output_get_result ()

gboolean
qmi_message_pds_set_agps_config_output_get_result
                               (QmiMessagePdsSetAgpsConfigOutput *self,
                                GError **error);

Get the result of the QMI operation.

Parameters

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

Returns

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

[skip]

Since: 1.12

qmi_message_pds_set_agps_config_response_parse ()

QmiMessagePdsSetAgpsConfigOutput *
qmi_message_pds_set_agps_config_response_parse
                               (QmiMessage *message,
                                GError **error);

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

Since: 1.34

qmi_client_pds_set_agps_config ()

void
qmi_client_pds_set_agps_config (QmiClientPds *self,
                                QmiMessagePdsSetAgpsConfigInput *input,
                                guint timeout,
                                GCancellable *cancellable,
                                GAsyncReadyCallback callback,
                                gpointer user_data);

Asynchronously sends a Set AGPS Config 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_pds_set_agps_config_finish() to get the result of the operation.

Parameters

self	a QmiClientPds.
input	a QmiMessagePdsSetAgpsConfigInput.
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.12

qmi_client_pds_set_agps_config_finish ()

QmiMessagePdsSetAgpsConfigOutput *
qmi_client_pds_set_agps_config_finish (QmiClientPds *self,
                                       GAsyncResult *res,
                                       GError **error);

Finishes an async operation started with qmi_client_pds_set_agps_config().

Parameters

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

Returns

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

Since: 1.12

Types and Values

QmiMessagePdsSetAgpsConfigInput

typedef struct _QmiMessagePdsSetAgpsConfigInput QmiMessagePdsSetAgpsConfigInput;

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

Since: 1.12

QmiMessagePdsSetAgpsConfigOutput

typedef struct _QmiMessagePdsSetAgpsConfigOutput QmiMessagePdsSetAgpsConfigOutput;

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

Since: 1.12