ATR Send response: libqmi-glib Reference Manual

## ATR Send response ATR Send response — Methods to manage the ATR Send response. |

## Functions

QmiMessageAtrSendInput * | qmi_message_atr_send_input_new ()
QmiMessageAtrSendInput * | qmi_message_atr_send_input_ref ()
void | qmi_message_atr_send_input_unref ()
gboolean | qmi_message_atr_send_input_get_message ()
gboolean | qmi_message_atr_send_input_set_message ()
QmiMessageAtrSendOutput * | qmi_message_atr_send_output_ref ()
void | qmi_message_atr_send_output_unref ()
gboolean | qmi_message_atr_send_output_get_result ()
QmiMessageAtrSendOutput * | qmi_message_atr_send_response_parse ()
void | qmi_client_atr_send ()
QmiMessageAtrSendOutput * | qmi_client_atr_send_finish ()

## Types and Values

| QmiMessageAtrSendInput
| QmiMessageAtrSendOutput

## Object Hierarchy

        GBoxed
        ├── QmiMessageAtrSendInput
        ╰── QmiMessageAtrSendOutput

## Description

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

## Functions

### qmi_message_atr_send_input_new ()

    QmiMessageAtrSendInput *
    qmi_message_atr_send_input_new (void);

Allocates a new QmiMessageAtrSendInput.

#### Returns

the newly created QmiMessageAtrSendInput. The returned value should be freed with `qmi_message_atr_send_input_unref()`.

Since: 1.34

### qmi_message_atr_send_input_ref ()

    QmiMessageAtrSendInput *
    qmi_message_atr_send_input_ref (QmiMessageAtrSendInput *self);

Atomically increments the reference count of `self` by one.

#### Parameters

self | a QmiMessageAtrSendInput. |

#### Returns

the new reference to `self` .

Since: 1.34

### qmi_message_atr_send_input_unref ()

    void
    qmi_message_atr_send_input_unref (QmiMessageAtrSendInput *self);

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

#### Parameters

self | a QmiMessageAtrSendInput. |

Since: 1.34

### qmi_message_atr_send_input_get_message ()

    gboolean
    qmi_message_atr_send_input_get_message
                                   (QmiMessageAtrSendInput *self,
                                    const gchar **value_message,
                                    GError **error);

Get the 'Message' field from `self` .

#### Parameters

self | a QmiMessageAtrSendInput. |
value_message | 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.34

### qmi_message_atr_send_input_set_message ()

    gboolean
    qmi_message_atr_send_input_set_message
                                   (QmiMessageAtrSendInput *self,
                                    const gchar *value_message,
                                    GError **error);

Set the 'Message' field in the message.

#### Parameters

self | a QmiMessageAtrSendInput. |
value_message | a constant string with a maximum length of 1024 characters. |
error | Return location for error or `NULL`. |

#### Returns

`TRUE` if `value` was successfully set, `FALSE` otherwise.

[skip]

Since: 1.34

### qmi_message_atr_send_output_ref ()

    QmiMessageAtrSendOutput *
    qmi_message_atr_send_output_ref (QmiMessageAtrSendOutput *self);

Atomically increments the reference count of `self` by one.

#### Parameters

self | a QmiMessageAtrSendOutput. |

#### Returns

the new reference to `self` .

Since: 1.34

### qmi_message_atr_send_output_unref ()

    void
    qmi_message_atr_send_output_unref (QmiMessageAtrSendOutput *self);

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

#### Parameters

self | a QmiMessageAtrSendOutput. |

Since: 1.34

### qmi_message_atr_send_output_get_result ()

    gboolean
    qmi_message_atr_send_output_get_result
                                   (QmiMessageAtrSendOutput *self,
                                    GError **error);

Get the result of the QMI operation.

#### Parameters

self | a QmiMessageAtrSendOutput. |
error | Return location for error or `NULL`. |

#### Returns

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

[skip]

Since: 1.34

### qmi_message_atr_send_response_parse ()

    QmiMessageAtrSendOutput *
    qmi_message_atr_send_response_parse (QmiMessage *message,
                                         GError **error);

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

Since: 1.34

### qmi_client_atr_send ()

    void
    qmi_client_atr_send (QmiClientAtr *self,
                         QmiMessageAtrSendInput *input,
                         guint timeout,
                         GCancellable *cancellable,
                         GAsyncReadyCallback callback,
                         gpointer user_data);

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

#### Parameters

self | a QmiClientAtr. |
input | a QmiMessageAtrSendInput. |
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.34

### qmi_client_atr_send_finish ()

    QmiMessageAtrSendOutput *
    qmi_client_atr_send_finish (QmiClientAtr *self,
                                GAsyncResult *res,
                                GError **error);

Finishes an async operation started with `qmi_client_atr_send()`.

#### Parameters

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

#### Returns

a QmiMessageAtrSendOutput, or `NULL` if `error` is set. The returned value should be freed with `qmi_message_atr_send_output_unref()`.

Since: 1.34

## Types and Values

### QmiMessageAtrSendInput

    typedef struct _QmiMessageAtrSendInput QmiMessageAtrSendInput;

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

Since: 1.34

### QmiMessageAtrSendOutput

    typedef struct _QmiMessageAtrSendOutput QmiMessageAtrSendOutput;

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

Since: 1.34