UIM Send APDU response: libqmi-glib Reference Manual

UIM Send APDU response

UIM Send APDU response — Methods to manage the UIM Send APDU response.

Functions

QmiMessageUimSendApduInput *	qmi_message_uim_send_apdu_input_new ()
QmiMessageUimSendApduInput *	qmi_message_uim_send_apdu_input_ref ()
void	qmi_message_uim_send_apdu_input_unref ()
gboolean	qmi_message_uim_send_apdu_input_get_procedure_bytes ()
gboolean	qmi_message_uim_send_apdu_input_set_procedure_bytes ()
gboolean	qmi_message_uim_send_apdu_input_get_channel_id ()
gboolean	qmi_message_uim_send_apdu_input_set_channel_id ()
gboolean	qmi_message_uim_send_apdu_input_get_apdu ()
gboolean	qmi_message_uim_send_apdu_input_set_apdu ()
gboolean	qmi_message_uim_send_apdu_input_get_slot ()
gboolean	qmi_message_uim_send_apdu_input_set_slot ()
QmiMessageUimSendApduOutput *	qmi_message_uim_send_apdu_output_ref ()
void	qmi_message_uim_send_apdu_output_unref ()
gboolean	qmi_message_uim_send_apdu_output_get_apdu_response ()
gboolean	qmi_message_uim_send_apdu_output_get_result ()
QmiMessageUimSendApduOutput *	qmi_message_uim_send_apdu_response_parse ()
void	qmi_client_uim_send_apdu ()
QmiMessageUimSendApduOutput *	qmi_client_uim_send_apdu_finish ()

Types and Values

	QmiMessageUimSendApduInput
	QmiMessageUimSendApduOutput

Object Hierarchy

    GBoxed
    ├── QmiMessageUimSendApduInput
    ╰── QmiMessageUimSendApduOutput

Description

Collection of methods to create requests and parse responses of the UIM Send APDU message.

Functions

qmi_message_uim_send_apdu_input_new ()

QmiMessageUimSendApduInput *
qmi_message_uim_send_apdu_input_new (void);

Allocates a new QmiMessageUimSendApduInput.

Returns

the newly created QmiMessageUimSendApduInput. The returned value should be freed with qmi_message_uim_send_apdu_input_unref().

Since: 1.36

qmi_message_uim_send_apdu_input_ref ()

QmiMessageUimSendApduInput *
qmi_message_uim_send_apdu_input_ref (QmiMessageUimSendApduInput *self);

Atomically increments the reference count of self by one.

Parameters

self

a QmiMessageUimSendApduInput.

Returns

the new reference to self .

Since: 1.36

qmi_message_uim_send_apdu_input_unref ()

void
qmi_message_uim_send_apdu_input_unref (QmiMessageUimSendApduInput *self);

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

Parameters

self

a QmiMessageUimSendApduInput.

Since: 1.36

qmi_message_uim_send_apdu_input_get_procedure_bytes ()

gboolean
qmi_message_uim_send_apdu_input_get_procedure_bytes
                               (QmiMessageUimSendApduInput *self,
                                guint8 *value_procedure_bytes,
                                GError **error);

Get the 'Procedure bytes' field from self .

Parameters

self	a QmiMessageUimSendApduInput.
value_procedure_bytes	a placeholder for the output guint8, 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_uim_send_apdu_input_set_procedure_bytes ()

gboolean
qmi_message_uim_send_apdu_input_set_procedure_bytes
                               (QmiMessageUimSendApduInput *self,
                                guint8 value_procedure_bytes,
                                GError **error);

Set the 'Procedure bytes' field in the message.

Parameters

self	a QmiMessageUimSendApduInput.
value_procedure_bytes	a guint8.
error	Return location for error or `NULL`.

Returns

TRUE if value was successfully set, FALSE otherwise.

[skip]

Since: 1.36

qmi_message_uim_send_apdu_input_get_channel_id ()

gboolean
qmi_message_uim_send_apdu_input_get_channel_id
                               (QmiMessageUimSendApduInput *self,
                                guint8 *value_channel_id,
                                GError **error);

Get the 'Channel ID' field from self .

Parameters

self	a QmiMessageUimSendApduInput.
value_channel_id	a placeholder for the output guint8, 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_uim_send_apdu_input_set_channel_id ()

gboolean
qmi_message_uim_send_apdu_input_set_channel_id
                               (QmiMessageUimSendApduInput *self,
                                guint8 value_channel_id,
                                GError **error);

Set the 'Channel ID' field in the message.

Parameters

self	a QmiMessageUimSendApduInput.
value_channel_id	a guint8.
error	Return location for error or `NULL`.

Returns

TRUE if value was successfully set, FALSE otherwise.

[skip]

Since: 1.36

qmi_message_uim_send_apdu_input_get_apdu ()

gboolean
qmi_message_uim_send_apdu_input_get_apdu
                               (QmiMessageUimSendApduInput *self,
                                GArray **value_apdu,
                                GError **error);

Get the 'APDU' field from self .

Parameters

self	a QmiMessageUimSendApduInput.
value_apdu	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.36

qmi_message_uim_send_apdu_input_set_apdu ()

gboolean
qmi_message_uim_send_apdu_input_set_apdu
                               (QmiMessageUimSendApduInput *self,
                                GArray *value_apdu,
                                GError **error);

Set the 'APDU' field in the message.

Parameters

self	a QmiMessageUimSendApduInput.
value_apdu	a GArray of guint8 elements. A new reference to `value_apdu` 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.36

qmi_message_uim_send_apdu_input_get_slot ()

gboolean
qmi_message_uim_send_apdu_input_get_slot
                               (QmiMessageUimSendApduInput *self,
                                guint8 *value_slot,
                                GError **error);

Get the 'Slot' field from self .

Parameters

self	a QmiMessageUimSendApduInput.
value_slot	a placeholder for the output guint8, 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_uim_send_apdu_input_set_slot ()

gboolean
qmi_message_uim_send_apdu_input_set_slot
                               (QmiMessageUimSendApduInput *self,
                                guint8 value_slot,
                                GError **error);

Set the 'Slot' field in the message.

Parameters

self	a QmiMessageUimSendApduInput.
value_slot	a guint8.
error	Return location for error or `NULL`.

Returns

TRUE if value was successfully set, FALSE otherwise.

[skip]

Since: 1.36

qmi_message_uim_send_apdu_output_ref ()

QmiMessageUimSendApduOutput *
qmi_message_uim_send_apdu_output_ref (QmiMessageUimSendApduOutput *self);

Atomically increments the reference count of self by one.

Parameters

self

a QmiMessageUimSendApduOutput.

Returns

the new reference to self .

Since: 1.36

qmi_message_uim_send_apdu_output_unref ()

void
qmi_message_uim_send_apdu_output_unref
                               (QmiMessageUimSendApduOutput *self);

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

Parameters

self

a QmiMessageUimSendApduOutput.

Since: 1.36

qmi_message_uim_send_apdu_output_get_apdu_response ()

gboolean
qmi_message_uim_send_apdu_output_get_apdu_response
                               (QmiMessageUimSendApduOutput *self,
                                GArray **value_apdu_response,
                                GError **error);

Get the 'APDU Response' field from self .

Parameters

self	a QmiMessageUimSendApduOutput.
value_apdu_response	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.36

qmi_message_uim_send_apdu_output_get_result ()

gboolean
qmi_message_uim_send_apdu_output_get_result
                               (QmiMessageUimSendApduOutput *self,
                                GError **error);

Get the result of the QMI operation.

Parameters

self	a QmiMessageUimSendApduOutput.
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_uim_send_apdu_response_parse ()

QmiMessageUimSendApduOutput *
qmi_message_uim_send_apdu_response_parse
                               (QmiMessage *message,
                                GError **error);

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

Since: 1.36

qmi_client_uim_send_apdu ()

void
qmi_client_uim_send_apdu (QmiClientUim *self,
                          QmiMessageUimSendApduInput *input,
                          guint timeout,
                          GCancellable *cancellable,
                          GAsyncReadyCallback callback,
                          gpointer user_data);

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

Parameters

self	a QmiClientUim.
input	a QmiMessageUimSendApduInput.
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_uim_send_apdu_finish ()

QmiMessageUimSendApduOutput *
qmi_client_uim_send_apdu_finish (QmiClientUim *self,
                                 GAsyncResult *res,
                                 GError **error);

Finishes an async operation started with qmi_client_uim_send_apdu().

Parameters

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

Returns

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

Since: 1.36

Types and Values

QmiMessageUimSendApduInput

typedef struct _QmiMessageUimSendApduInput QmiMessageUimSendApduInput;

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

Since: 1.36

QmiMessageUimSendApduOutput

typedef struct _QmiMessageUimSendApduOutput QmiMessageUimSendApduOutput;

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

Since: 1.36