SSC Control response: libqmi-glib Reference Manual

## SSC Control response SSC Control response — Methods to manage the SSC Control response. |

## Functions

QmiMessageSscControlInput * | qmi_message_ssc_control_input_new ()
QmiMessageSscControlInput * | qmi_message_ssc_control_input_ref ()
void | qmi_message_ssc_control_input_unref ()
gboolean | qmi_message_ssc_control_input_get_report_type ()
gboolean | qmi_message_ssc_control_input_set_report_type ()
gboolean | qmi_message_ssc_control_input_get_data ()
gboolean | qmi_message_ssc_control_input_set_data ()
QmiMessageSscControlOutput * | qmi_message_ssc_control_output_ref ()
void | qmi_message_ssc_control_output_unref ()
gboolean | qmi_message_ssc_control_output_get_result ()
gboolean | qmi_message_ssc_control_output_get_client_id ()
gboolean | qmi_message_ssc_control_output_get_response ()
QmiMessageSscControlOutput * | qmi_message_ssc_control_response_parse ()
void | qmi_client_ssc_control ()
QmiMessageSscControlOutput * | qmi_client_ssc_control_finish ()

## Types and Values

| QmiMessageSscControlInput
| QmiMessageSscControlOutput

## Object Hierarchy

        GBoxed
        ├── QmiMessageSscControlInput
        ╰── QmiMessageSscControlOutput

## Description

Collection of methods to create requests and parse responses of the SSC Control message.

## Functions

### qmi_message_ssc_control_input_new ()

    QmiMessageSscControlInput *
    qmi_message_ssc_control_input_new (void);

Allocates a new QmiMessageSscControlInput.

#### Returns

the newly created QmiMessageSscControlInput. The returned value should be freed with `qmi_message_ssc_control_input_unref()`.

Since: 1.34

### qmi_message_ssc_control_input_ref ()

    QmiMessageSscControlInput *
    qmi_message_ssc_control_input_ref (QmiMessageSscControlInput *self);

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

#### Parameters

self | a QmiMessageSscControlInput. |

#### Returns

the new reference to `self` .

Since: 1.34

### qmi_message_ssc_control_input_unref ()

    void
    qmi_message_ssc_control_input_unref (QmiMessageSscControlInput *self);

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

#### Parameters

self | a QmiMessageSscControlInput. |

Since: 1.34

### qmi_message_ssc_control_input_get_report_type ()

    gboolean
    qmi_message_ssc_control_input_get_report_type
                                   (QmiMessageSscControlInput *self,
                                    QmiSscReportType *value_report_type,
                                    GError **error);

Get the 'Report Type' field from `self` .

#### Parameters

self | a QmiMessageSscControlInput. |
value_report_type | a placeholder for the output QmiSscReportType, 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.34

### qmi_message_ssc_control_input_set_report_type ()

    gboolean
    qmi_message_ssc_control_input_set_report_type
                                   (QmiMessageSscControlInput *self,
                                    QmiSscReportType value_report_type,
                                    GError **error);

Set the 'Report Type' field in the message.

#### Parameters

self | a QmiMessageSscControlInput. |
value_report_type | a QmiSscReportType. |
error | Return location for error or `NULL`. |

#### Returns

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

[skip]

Since: 1.34

### qmi_message_ssc_control_input_get_data ()

    gboolean
    qmi_message_ssc_control_input_get_data
                                   (QmiMessageSscControlInput *self,
                                    GArray **value_data,
                                    GError **error);

Get the 'Data' field from `self` .

#### Parameters

self | a QmiMessageSscControlInput. |
value_data | 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.34

### qmi_message_ssc_control_input_set_data ()

    gboolean
    qmi_message_ssc_control_input_set_data
                                   (QmiMessageSscControlInput *self,
                                    GArray *value_data,
                                    GError **error);

Set the 'Data' field in the message.

#### Parameters

self | a QmiMessageSscControlInput. |
value_data | a GArray of guint8 elements. A new reference to `value_data` 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.34

### qmi_message_ssc_control_output_ref ()

    QmiMessageSscControlOutput *
    qmi_message_ssc_control_output_ref (QmiMessageSscControlOutput *self);

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

#### Parameters

self | a QmiMessageSscControlOutput. |

#### Returns

the new reference to `self` .

Since: 1.34

### qmi_message_ssc_control_output_unref ()

    void
    qmi_message_ssc_control_output_unref (QmiMessageSscControlOutput *self);

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

#### Parameters

self | a QmiMessageSscControlOutput. |

Since: 1.34

### qmi_message_ssc_control_output_get_result ()

    gboolean
    qmi_message_ssc_control_output_get_result
                                   (QmiMessageSscControlOutput *self,
                                    GError **error);

Get the result of the QMI operation.

#### Parameters

self | a QmiMessageSscControlOutput. |
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_ssc_control_output_get_client_id ()

    gboolean
    qmi_message_ssc_control_output_get_client_id
                                   (QmiMessageSscControlOutput *self,
                                    guint64 *value_client_id,
                                    GError **error);

Get the 'Client ID' field from `self` .

#### Parameters

self | a QmiMessageSscControlOutput. |
value_client_id | a placeholder for the output guint64, 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.34

### qmi_message_ssc_control_output_get_response ()

    gboolean
    qmi_message_ssc_control_output_get_response
                                   (QmiMessageSscControlOutput *self,
                                    guint32 *value_response,
                                    GError **error);

Get the 'Response' field from `self` .

#### Parameters

self | a QmiMessageSscControlOutput. |
value_response | 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.34

### qmi_message_ssc_control_response_parse ()

    QmiMessageSscControlOutput *
    qmi_message_ssc_control_response_parse
                                   (QmiMessage *message,
                                    GError **error);

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

Since: 1.34

### qmi_client_ssc_control ()

    void
    qmi_client_ssc_control (QmiClientSsc *self,
                            QmiMessageSscControlInput *input,
                            guint timeout,
                            GCancellable *cancellable,
                            GAsyncReadyCallback callback,
                            gpointer user_data);

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

#### Parameters

self | a QmiClientSsc. |
input | a QmiMessageSscControlInput. |
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_ssc_control_finish ()

    QmiMessageSscControlOutput *
    qmi_client_ssc_control_finish (QmiClientSsc *self,
                                   GAsyncResult *res,
                                   GError **error);

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

#### Parameters

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

#### Returns

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

Since: 1.34

## Types and Values

### QmiMessageSscControlInput

    typedef struct _QmiMessageSscControlInput QmiMessageSscControlInput;

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

Since: 1.34

### QmiMessageSscControlOutput

    typedef struct _QmiMessageSscControlOutput QmiMessageSscControlOutput;

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

Since: 1.34