WMS Get Routes

WMS Get Routes

Synopsis

                    QmiMessageWmsGetRoutesOutput;
                    QmiMessageWmsGetRoutesOutputRouteListElement;

QmiMessageWmsGetRoutesOutput * qmi_message_wms_get_routes_output_ref
                                                        (QmiMessageWmsGetRoutesOutput *self);
void                qmi_message_wms_get_routes_output_unref
                                                        (QmiMessageWmsGetRoutesOutput *self);
gboolean            qmi_message_wms_get_routes_output_get_result
                                                        (QmiMessageWmsGetRoutesOutput *self,
                                                         GError **error);
gboolean            qmi_message_wms_get_routes_output_get_route_list
                                                        (QmiMessageWmsGetRoutesOutput *self,
                                                         GArray **route_list,
                                                         GError **error);
gboolean            qmi_message_wms_get_routes_output_get_transfer_status_report
                                                        (QmiMessageWmsGetRoutesOutput *self,
                                                         QmiWmsTransferIndication *transfer_status_report,
                                                         GError **error);

void                qmi_client_wms_get_routes           (QmiClientWms *self,
                                                         gpointer unused,
                                                         guint timeout,
                                                         GCancellable *cancellable,
                                                         GAsyncReadyCallback callback,
                                                         gpointer user_data);
QmiMessageWmsGetRoutesOutput * qmi_client_wms_get_routes_finish
                                                        (QmiClientWms *self,
                                                         GAsyncResult *res,
                                                         GError **error);

Object Hierarchy

  GBoxed
   +----QmiMessageWmsGetRoutesOutput

Description

Details

QmiMessageWmsGetRoutesOutput

typedef struct _QmiMessageWmsGetRoutesOutput QmiMessageWmsGetRoutesOutput;

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


QmiMessageWmsGetRoutesOutputRouteListElement

typedef struct {
    QmiWmsMessageType message_type;
    QmiWmsMessageClass message_class;
    QmiWmsStorageType storage;
    QmiWmsReceiptAction receipt_action;
} QmiMessageWmsGetRoutesOutputRouteListElement;

A QmiMessageWmsGetRoutesOutputRouteListElement struct.


qmi_message_wms_get_routes_output_ref ()

QmiMessageWmsGetRoutesOutput * qmi_message_wms_get_routes_output_ref
                                                        (QmiMessageWmsGetRoutesOutput *self);

Atomically increments the reference count of self by one.

self :

a QmiMessageWmsGetRoutesOutput.

Returns :

the new reference to self.

qmi_message_wms_get_routes_output_unref ()

void                qmi_message_wms_get_routes_output_unref
                                                        (QmiMessageWmsGetRoutesOutput *self);

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


qmi_message_wms_get_routes_output_get_result ()

gboolean            qmi_message_wms_get_routes_output_get_result
                                                        (QmiMessageWmsGetRoutesOutput *self,
                                                         GError **error);

Get the result of the QMI operation.

self :

a QmiMessageWmsGetRoutesOutput.

error :

Return location for error or NULL.

Returns :

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

qmi_message_wms_get_routes_output_get_route_list ()

gboolean            qmi_message_wms_get_routes_output_get_route_list
                                                        (QmiMessageWmsGetRoutesOutput *self,
                                                         GArray **route_list,
                                                         GError **error);

Get the 'Route List' field from self.

self :

a QmiMessageWmsGetRoutesOutput.

route_list :

a placeholder for the output GArray of QmiMessageWmsGetRoutesOutputRouteListElement elements, or NULL if not required. Do not free it, it is owned by self.

error :

Return location for error or NULL.

Returns :

TRUE if the field is found, FALSE otherwise.

qmi_message_wms_get_routes_output_get_transfer_status_report ()

gboolean            qmi_message_wms_get_routes_output_get_transfer_status_report
                                                        (QmiMessageWmsGetRoutesOutput *self,
                                                         QmiWmsTransferIndication *transfer_status_report,
                                                         GError **error);

Get the 'Transfer Status Report' field from self.

self :

a QmiMessageWmsGetRoutesOutput.

transfer_status_report :

a placeholder for the output QmiWmsTransferIndication, or NULL if not required.

error :

Return location for error or NULL.

Returns :

TRUE if the field is found, FALSE otherwise.

qmi_client_wms_get_routes ()

void                qmi_client_wms_get_routes           (QmiClientWms *self,
                                                         gpointer unused,
                                                         guint timeout,
                                                         GCancellable *cancellable,
                                                         GAsyncReadyCallback callback,
                                                         gpointer user_data);

Asynchronously sends a Get Routes 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_wms_get_routes_finish() to get the result of the operation.

self :

a QmiClientWms.

unused :

NULL. This message doesn't have any input bundle.

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.

qmi_client_wms_get_routes_finish ()

QmiMessageWmsGetRoutesOutput * qmi_client_wms_get_routes_finish
                                                        (QmiClientWms *self,
                                                         GAsyncResult *res,
                                                         GError **error);

Finishes an async operation started with qmi_client_wms_get_routes().

self :

a QmiClientWms.

res :

the GAsyncResult obtained from the GAsyncReadyCallback passed to qmi_client_wms_get_routes().

error :

Return location for error or NULL.

Returns :

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