NAS Get Signal Strength response: libqmi-glib Reference Manual

## NAS Get Signal Strength response NAS Get Signal Strength response — Methods to manage the NAS Get Signal Strength response. |

## Functions

QmiMessageNasGetSignalStrengthInput * | qmi_message_nas_get_signal_strength_input_new ()
QmiMessageNasGetSignalStrengthInput * | qmi_message_nas_get_signal_strength_input_ref ()
void | qmi_message_nas_get_signal_strength_input_unref ()
gboolean | qmi_message_nas_get_signal_strength_input_get_request_mask ()
gboolean | qmi_message_nas_get_signal_strength_input_set_request_mask ()
QmiMessageNasGetSignalStrengthOutput * | qmi_message_nas_get_signal_strength_output_ref ()
void | qmi_message_nas_get_signal_strength_output_unref ()
gboolean | qmi_message_nas_get_signal_strength_output_get_lte_rsrp ()
gboolean | qmi_message_nas_get_signal_strength_output_get_lte_snr ()
gboolean | qmi_message_nas_get_signal_strength_output_get_rsrq ()
gboolean | qmi_message_nas_get_signal_strength_output_get_error_rate_list ()
gboolean | qmi_message_nas_get_signal_strength_output_get_error_rate_list_gir ()
gboolean | qmi_message_nas_get_signal_strength_output_get_sinr ()
gboolean | qmi_message_nas_get_signal_strength_output_get_io ()
gboolean | qmi_message_nas_get_signal_strength_output_get_ecio_list ()
gboolean | qmi_message_nas_get_signal_strength_output_get_ecio_list_gir ()
gboolean | qmi_message_nas_get_signal_strength_output_get_rssi_list ()
gboolean | qmi_message_nas_get_signal_strength_output_get_rssi_list_gir ()
gboolean | qmi_message_nas_get_signal_strength_output_get_strength_list ()
gboolean | qmi_message_nas_get_signal_strength_output_get_strength_list_gir ()
gboolean | qmi_message_nas_get_signal_strength_output_get_result ()
gboolean | qmi_message_nas_get_signal_strength_output_get_signal_strength ()
QmiMessageNasGetSignalStrengthOutput * | qmi_message_nas_get_signal_strength_response_parse ()
void | qmi_client_nas_get_signal_strength ()
QmiMessageNasGetSignalStrengthOutput * | qmi_client_nas_get_signal_strength_finish ()

## Types and Values

| QmiMessageNasGetSignalStrengthInput
| QmiMessageNasGetSignalStrengthOutput
| QmiMessageNasGetSignalStrengthOutputErrorRateListElement
| QmiMessageNasGetSignalStrengthOutputEcioListElement
| QmiMessageNasGetSignalStrengthOutputRssiListElement
| QmiMessageNasGetSignalStrengthOutputStrengthListElement

## Object Hierarchy

        GBoxed
        ├── QmiMessageNasGetSignalStrengthInput
        ├── QmiMessageNasGetSignalStrengthOutput
        ├── QmiMessageNasGetSignalStrengthOutputEcioListElement
        ├── QmiMessageNasGetSignalStrengthOutputErrorRateListElement
        ├── QmiMessageNasGetSignalStrengthOutputRssiListElement
        ╰── QmiMessageNasGetSignalStrengthOutputStrengthListElement

## Description

Collection of methods to create requests and parse responses of the NAS Get Signal Strength message.

## Functions

### qmi_message_nas_get_signal_strength_input_new ()

    QmiMessageNasGetSignalStrengthInput *
    qmi_message_nas_get_signal_strength_input_new
                                   (void);

Allocates a new QmiMessageNasGetSignalStrengthInput.

#### Returns

the newly created QmiMessageNasGetSignalStrengthInput. The returned value should be freed with `qmi_message_nas_get_signal_strength_input_unref()`.

Since: 1.0

### qmi_message_nas_get_signal_strength_input_ref ()

    QmiMessageNasGetSignalStrengthInput *
    qmi_message_nas_get_signal_strength_input_ref
                                   (QmiMessageNasGetSignalStrengthInput *self);

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

#### Parameters

self | a QmiMessageNasGetSignalStrengthInput. |

#### Returns

the new reference to `self` .

Since: 1.0

### qmi_message_nas_get_signal_strength_input_unref ()

    void
    qmi_message_nas_get_signal_strength_input_unref
                                   (QmiMessageNasGetSignalStrengthInput *self);

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

#### Parameters

self | a QmiMessageNasGetSignalStrengthInput. |

Since: 1.0

### qmi_message_nas_get_signal_strength_input_get_request_mask ()

    gboolean
    qmi_message_nas_get_signal_strength_input_get_request_mask
                                   (QmiMessageNasGetSignalStrengthInput *self,
                                    QmiNasSignalStrengthRequest *value_request_mask,
                                    GError **error);

Get the 'Request Mask' field from `self` .

#### Parameters

self | a QmiMessageNasGetSignalStrengthInput. |
value_request_mask | a placeholder for the output QmiNasSignalStrengthRequest, 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_nas_get_signal_strength_input_set_request_mask ()

    gboolean
    qmi_message_nas_get_signal_strength_input_set_request_mask
                                   (QmiMessageNasGetSignalStrengthInput *self,
                                    QmiNasSignalStrengthRequest value_request_mask,
                                    GError **error);

Set the 'Request Mask' field in the message.

#### Parameters

self | a QmiMessageNasGetSignalStrengthInput. |
value_request_mask | a QmiNasSignalStrengthRequest. |
error | Return location for error or `NULL`. |

#### Returns

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

[skip]

Since: 1.0

### qmi_message_nas_get_signal_strength_output_ref ()

    QmiMessageNasGetSignalStrengthOutput *
    qmi_message_nas_get_signal_strength_output_ref
                                   (QmiMessageNasGetSignalStrengthOutput *self);

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

#### Parameters

self | a QmiMessageNasGetSignalStrengthOutput. |

#### Returns

the new reference to `self` .

Since: 1.0

### qmi_message_nas_get_signal_strength_output_unref ()

    void
    qmi_message_nas_get_signal_strength_output_unref
                                   (QmiMessageNasGetSignalStrengthOutput *self);

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

#### Parameters

self | a QmiMessageNasGetSignalStrengthOutput. |

Since: 1.0

### qmi_message_nas_get_signal_strength_output_get_lte_rsrp ()

    gboolean
    qmi_message_nas_get_signal_strength_output_get_lte_rsrp
                                   (QmiMessageNasGetSignalStrengthOutput *self,
                                    gint16 *value_lte_rsrp,
                                    GError **error);

Get the 'LTE RSRP' field from `self` .

#### Parameters

self | a QmiMessageNasGetSignalStrengthOutput. |
value_lte_rsrp | a placeholder for the output gint16, 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_nas_get_signal_strength_output_get_lte_snr ()

    gboolean
    qmi_message_nas_get_signal_strength_output_get_lte_snr
                                   (QmiMessageNasGetSignalStrengthOutput *self,
                                    gint16 *value_lte_snr,
                                    GError **error);

Get the 'LTE SNR' field from `self` .

#### Parameters

self | a QmiMessageNasGetSignalStrengthOutput. |
value_lte_snr | a placeholder for the output gint16, 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_nas_get_signal_strength_output_get_rsrq ()

    gboolean
    qmi_message_nas_get_signal_strength_output_get_rsrq
                                   (QmiMessageNasGetSignalStrengthOutput *self,
                                    gint8 *value_rsrq_rsrq,
                                    QmiNasRadioInterface *value_rsrq_radio_interface,
                                    GError **error);

Get the 'RSRQ' field from `self` .

#### Parameters

self | a QmiMessageNasGetSignalStrengthOutput. |
value_rsrq_rsrq | a placeholder for the output gint8, or `NULL` if not required. | [out][optional]
value_rsrq_radio_interface | a placeholder for the output QmiNasRadioInterface, 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_nas_get_signal_strength_output_get_error_rate_list ()

    gboolean
    qmi_message_nas_get_signal_strength_output_get_error_rate_list
                                   (QmiMessageNasGetSignalStrengthOutput *self,
                                    GArray **value_error_rate_list,
                                    GError **error);

Get the 'Error Rate List' field from `self` .

[skip]

#### Parameters

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

#### Returns

`TRUE` if the field is found, `FALSE` otherwise.

[skip]

Since: 1.0

### qmi_message_nas_get_signal_strength_output_get_error_rate_list_gir ()

    gboolean
    qmi_message_nas_get_signal_strength_output_get_error_rate_list_gir
                                   (QmiMessageNasGetSignalStrengthOutput *self,
                                    GPtrArray **value_error_rate_list_ptr,
                                    GError **error);

Get the 'Error Rate List' field from `self` .

Version of `qmi_message_nas_get_signal_strength_output_get_error_rate_list()` using arrays of pointers to structs instead of arrays of structs, for easier binding in other languages.

[rename-to qmi_message_nas_get_signal_strength_output_get_error_rate_list]

#### Parameters

self | a QmiMessageNasGetSignalStrengthOutput. |
value_error_rate_list_ptr | a placeholder for the output array of QmiMessageNasGetSignalStrengthOutputErrorRateListElement elements, or `NULL` if not required. Do not free or modify it, it is owned by `self` . | [out][optional][element-type QmiMessageNasGetSignalStrengthOutputErrorRateListElement][transfer none]
error | Return location for error or `NULL`. |

#### Returns

`TRUE` if the field is found, `FALSE` otherwise.

[skip]

Since: 1.32

### qmi_message_nas_get_signal_strength_output_get_sinr ()

    gboolean
    qmi_message_nas_get_signal_strength_output_get_sinr
                                   (QmiMessageNasGetSignalStrengthOutput *self,
                                    QmiNasEvdoSinrLevel *value_sinr,
                                    GError **error);

Get the 'SINR' field from `self` .

#### Parameters

self | a QmiMessageNasGetSignalStrengthOutput. |
value_sinr | a placeholder for the output QmiNasEvdoSinrLevel, 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_nas_get_signal_strength_output_get_io ()

    gboolean
    qmi_message_nas_get_signal_strength_output_get_io
                                   (QmiMessageNasGetSignalStrengthOutput *self,
                                    gint32 *value_io,
                                    GError **error);

Get the 'IO' field from `self` .

#### Parameters

self | a QmiMessageNasGetSignalStrengthOutput. |
value_io | a placeholder for the output gint32, 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_nas_get_signal_strength_output_get_ecio_list ()

    gboolean
    qmi_message_nas_get_signal_strength_output_get_ecio_list
                                   (QmiMessageNasGetSignalStrengthOutput *self,
                                    GArray **value_ecio_list,
                                    GError **error);

Get the 'ECIO List' field from `self` .

[skip]

#### Parameters

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

#### Returns

`TRUE` if the field is found, `FALSE` otherwise.

[skip]

Since: 1.0

### qmi_message_nas_get_signal_strength_output_get_ecio_list_gir ()

    gboolean
    qmi_message_nas_get_signal_strength_output_get_ecio_list_gir
                                   (QmiMessageNasGetSignalStrengthOutput *self,
                                    GPtrArray **value_ecio_list_ptr,
                                    GError **error);

Get the 'ECIO List' field from `self` .

Version of `qmi_message_nas_get_signal_strength_output_get_ecio_list()` using arrays of pointers to structs instead of arrays of structs, for easier binding in other languages.

[rename-to qmi_message_nas_get_signal_strength_output_get_ecio_list]

#### Parameters

self | a QmiMessageNasGetSignalStrengthOutput. |
value_ecio_list_ptr | a placeholder for the output array of QmiMessageNasGetSignalStrengthOutputEcioListElement elements, or `NULL` if not required. Do not free or modify it, it is owned by `self` . | [out][optional][element-type QmiMessageNasGetSignalStrengthOutputEcioListElement][transfer none]
error | Return location for error or `NULL`. |

#### Returns

`TRUE` if the field is found, `FALSE` otherwise.

[skip]

Since: 1.32

### qmi_message_nas_get_signal_strength_output_get_rssi_list ()

    gboolean
    qmi_message_nas_get_signal_strength_output_get_rssi_list
                                   (QmiMessageNasGetSignalStrengthOutput *self,
                                    GArray **value_rssi_list,
                                    GError **error);

Get the 'RSSI List' field from `self` .

[skip]

#### Parameters

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

#### Returns

`TRUE` if the field is found, `FALSE` otherwise.

[skip]

Since: 1.0

### qmi_message_nas_get_signal_strength_output_get_rssi_list_gir ()

    gboolean
    qmi_message_nas_get_signal_strength_output_get_rssi_list_gir
                                   (QmiMessageNasGetSignalStrengthOutput *self,
                                    GPtrArray **value_rssi_list_ptr,
                                    GError **error);

Get the 'RSSI List' field from `self` .

Version of `qmi_message_nas_get_signal_strength_output_get_rssi_list()` using arrays of pointers to structs instead of arrays of structs, for easier binding in other languages.

[rename-to qmi_message_nas_get_signal_strength_output_get_rssi_list]

#### Parameters

self | a QmiMessageNasGetSignalStrengthOutput. |
value_rssi_list_ptr | a placeholder for the output array of QmiMessageNasGetSignalStrengthOutputRssiListElement elements, or `NULL` if not required. Do not free or modify it, it is owned by `self` . | [out][optional][element-type QmiMessageNasGetSignalStrengthOutputRssiListElement][transfer none]
error | Return location for error or `NULL`. |

#### Returns

`TRUE` if the field is found, `FALSE` otherwise.

[skip]

Since: 1.32

### qmi_message_nas_get_signal_strength_output_get_strength_list ()

    gboolean
    qmi_message_nas_get_signal_strength_output_get_strength_list
                                   (QmiMessageNasGetSignalStrengthOutput *self,
                                    GArray **value_strength_list,
                                    GError **error);

Get the 'Strength List' field from `self` .

[skip]

#### Parameters

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

#### Returns

`TRUE` if the field is found, `FALSE` otherwise.

[skip]

Since: 1.0

### qmi_message_nas_get_signal_strength_output_get_strength_list_gir ()

    gboolean
    qmi_message_nas_get_signal_strength_output_get_strength_list_gir
                                   (QmiMessageNasGetSignalStrengthOutput *self,
                                    GPtrArray **value_strength_list_ptr,
                                    GError **error);

Get the 'Strength List' field from `self` .

Version of `qmi_message_nas_get_signal_strength_output_get_strength_list()` using arrays of pointers to structs instead of arrays of structs, for easier binding in other languages.

[rename-to qmi_message_nas_get_signal_strength_output_get_strength_list]

#### Parameters

self | a QmiMessageNasGetSignalStrengthOutput. |
value_strength_list_ptr | a placeholder for the output array of QmiMessageNasGetSignalStrengthOutputStrengthListElement elements, or `NULL` if not required. Do not free or modify it, it is owned by `self` . | [out][optional][element-type QmiMessageNasGetSignalStrengthOutputStrengthListElement][transfer none]
error | Return location for error or `NULL`. |

#### Returns

`TRUE` if the field is found, `FALSE` otherwise.

[skip]

Since: 1.32

### qmi_message_nas_get_signal_strength_output_get_result ()

    gboolean
    qmi_message_nas_get_signal_strength_output_get_result
                                   (QmiMessageNasGetSignalStrengthOutput *self,
                                    GError **error);

Get the result of the QMI operation.

#### Parameters

self | a QmiMessageNasGetSignalStrengthOutput. |
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_nas_get_signal_strength_output_get_signal_strength ()

    gboolean
    qmi_message_nas_get_signal_strength_output_get_signal_strength
                                   (QmiMessageNasGetSignalStrengthOutput *self,
                                    gint8 *value_signal_strength_strength,
                                    QmiNasRadioInterface *value_signal_strength_radio_interface,
                                    GError **error);

Get the 'Signal Strength' field from `self` .

#### Parameters

self | a QmiMessageNasGetSignalStrengthOutput. |
value_signal_strength_strength | a placeholder for the output gint8, or `NULL` if not required. | [out][optional]
value_signal_strength_radio_interface | a placeholder for the output QmiNasRadioInterface, 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_nas_get_signal_strength_response_parse ()

    QmiMessageNasGetSignalStrengthOutput *
    qmi_message_nas_get_signal_strength_response_parse
                                   (QmiMessage *message,
                                    GError **error);

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

Since: 1.34

### qmi_client_nas_get_signal_strength ()

    void
    qmi_client_nas_get_signal_strength (QmiClientNas *self,
                                        QmiMessageNasGetSignalStrengthInput *input,
                                        guint timeout,
                                        GCancellable *cancellable,
                                        GAsyncReadyCallback callback,
                                        gpointer user_data);

Asynchronously sends a Get Signal Strength 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_nas_get_signal_strength_finish()` to get the result of the operation.

#### Parameters

self | a QmiClientNas. |
input | a QmiMessageNasGetSignalStrengthInput. |
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_nas_get_signal_strength_finish ()

    QmiMessageNasGetSignalStrengthOutput *
    qmi_client_nas_get_signal_strength_finish
                                   (QmiClientNas *self,
                                    GAsyncResult *res,
                                    GError **error);

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

#### Parameters

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

#### Returns

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

Since: 1.0

## Types and Values

### QmiMessageNasGetSignalStrengthInput

    typedef struct _QmiMessageNasGetSignalStrengthInput QmiMessageNasGetSignalStrengthInput;

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

Since: 1.0

### QmiMessageNasGetSignalStrengthOutput

    typedef struct _QmiMessageNasGetSignalStrengthOutput QmiMessageNasGetSignalStrengthOutput;

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

Since: 1.0

### QmiMessageNasGetSignalStrengthOutputErrorRateListElement

    typedef struct {
        guint16 rate;
        QmiNasRadioInterface radio_interface;
    } QmiMessageNasGetSignalStrengthOutputErrorRateListElement;

A QmiMessageNasGetSignalStrengthOutputErrorRateListElement struct.

#### Members

guint16 `rate`; | a guint16. |
QmiNasRadioInterface `radio_interface`; | a QmiNasRadioInterface. |

Since: 1.0

### QmiMessageNasGetSignalStrengthOutputEcioListElement

    typedef struct {
        guint8 ecio;
        QmiNasRadioInterface radio_interface;
    } QmiMessageNasGetSignalStrengthOutputEcioListElement;

A QmiMessageNasGetSignalStrengthOutputEcioListElement struct.

#### Members

guint8 `ecio`; | a guint8. |
QmiNasRadioInterface `radio_interface`; | a QmiNasRadioInterface. |

Since: 1.0

### QmiMessageNasGetSignalStrengthOutputRssiListElement

    typedef struct {
        guint8 rssi;
        QmiNasRadioInterface radio_interface;
    } QmiMessageNasGetSignalStrengthOutputRssiListElement;

A QmiMessageNasGetSignalStrengthOutputRssiListElement struct.

#### Members

guint8 `rssi`; | a guint8. |
QmiNasRadioInterface `radio_interface`; | a QmiNasRadioInterface. |

Since: 1.0

### QmiMessageNasGetSignalStrengthOutputStrengthListElement

    typedef struct {
        gint8 strength;
        QmiNasRadioInterface radio_interface;
    } QmiMessageNasGetSignalStrengthOutputStrengthListElement;

A QmiMessageNasGetSignalStrengthOutputStrengthListElement struct.

#### Members

gint8 `strength`; | a gint8. |
QmiNasRadioInterface `radio_interface`; | a QmiNasRadioInterface. |

Since: 1.0