mbim_message_new ()

MbimMessage *
mbim_message_new (const guint8 *data,
                  guint32 data_length);

Create a MbimMessage with the given contents.

Since: 1.0

mbim_message_dup ()

MbimMessage *
mbim_message_dup (const MbimMessage *self);

Create a MbimMessage with the same contents as self .

Since: 1.0

mbim_message_ref ()

MbimMessage *
mbim_message_ref (MbimMessage *self);

Atomically increments the reference count of self by one.

Since: 1.0

mbim_message_unref ()

void
mbim_message_unref (MbimMessage *self);

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

Since: 1.0

mbim_message_validate ()

gboolean
mbim_message_validate (const MbimMessage *self,
                       GError **error);

Validates the contents of the headers in the MBIM message.

This operation may be used to ensure that the message contains all bytes it is expected to contain and that it is of a valid type.

This operation also ensures the message is complete and not a partial MBIM fragment.

This operation does not validate that the specific contents of a given message type are available, that is done by the methods retrieving those specific contents.

Since: 1.28

mbim_message_get_printable ()

gchar *
mbim_message_get_printable (const MbimMessage *self,
                            const gchar *line_prefix,
                            gboolean headers_only);

Gets a printable string with the contents of the whole MBIM message.

This method will not fail if the parsing of the message contents fails, a fallback text with the error will be included in the generated printable information instead.

Since: 1.0

mbim_message_get_printable_full ()

gchar *
mbim_message_get_printable_full (const MbimMessage *self,
                                 guint8 mbimex_version_major,
                                 guint8 mbimex_version_minor,
                                 const gchar *line_prefix,
                                 gboolean headers_only,
                                 GError **error);

Gets a printable string with the contents of the whole MBIM message.

Unlike mbim_message_get_printable(), this method allows specifying the MBIMEx version agreed between host and device, so that the correct processing and parsing is done on messages in the newer MBIMEx versions.

If mbimex_version_major < 2, this method behaves exactly as mbim_message_get_printable().

If the specified mbimex_version_major is unsupported, an error will be returned.

This method will not fail if the parsing of the message contents fails, a fallback text with the error will be included in the generated printable information instead.

Since: 1.28

mbim_message_get_raw ()

const guint8 *
mbim_message_get_raw (const MbimMessage *self,
                      guint32 *length,
                      GError **error);

Gets the whole raw data buffer of the MbimMessage.

Since: 1.0

mbim_message_get_message_type ()

MbimMessageType
mbim_message_get_message_type (const MbimMessage *self);

Gets the message type.

Since: 1.0

mbim_message_get_message_length ()

guint32
mbim_message_get_message_length (const MbimMessage *self);

Gets the whole message length.

Since: 1.0

mbim_message_get_transaction_id ()

guint32
mbim_message_get_transaction_id (const MbimMessage *self);

Gets the transaction ID of the message.

Since: 1.0

mbim_message_set_transaction_id ()

void
mbim_message_set_transaction_id (MbimMessage *self,
                                 guint32 transaction_id);

Sets the transaction ID of the message.

Since: 1.0

mbim_message_type_get_string ()

const gchar *
mbim_message_type_get_string (MbimMessageType val);

Gets the nickname string for the MbimMessageType specified at val .

Since: 1.0

mbim_message_open_new ()

MbimMessage *
mbim_message_open_new (guint32 transaction_id,
                       guint32 max_control_transfer);

Create a new MbimMessage of type MBIM_MESSAGE_TYPE_OPEN with the specified parameters.

Since: 1.0

mbim_message_open_get_max_control_transfer ()

guint32
mbim_message_open_get_max_control_transfer
                               (const MbimMessage *self);

Get the maximum control transfer set to be used in the MbimMessage of type MBIM_MESSAGE_TYPE_OPEN.

Since: 1.0

mbim_message_open_done_get_status_code ()

MbimStatusError
mbim_message_open_done_get_status_code
                               (const MbimMessage *self);

Get status code from the MBIM_MESSAGE_TYPE_OPEN_DONE message.

Since: 1.0

mbim_message_open_done_get_result ()

gboolean
mbim_message_open_done_get_result (const MbimMessage *self,
                                   GError **error);

Gets the result of the 'Open' operation in the MBIM_MESSAGE_TYPE_OPEN_DONE message.

Since: 1.0

mbim_message_close_new ()

MbimMessage *
mbim_message_close_new (guint32 transaction_id);

Create a new MbimMessage of type MBIM_MESSAGE_TYPE_CLOSE with the specified parameters.

Since: 1.0

mbim_message_close_done_get_status_code ()

MbimStatusError
mbim_message_close_done_get_status_code
                               (const MbimMessage *self);

Get status code from the MBIM_MESSAGE_TYPE_CLOSE_DONE message.

Since: 1.0

mbim_message_close_done_get_result ()

gboolean
mbim_message_close_done_get_result (const MbimMessage *self,
                                    GError **error);

Gets the result of the 'Close' operation in the MBIM_MESSAGE_TYPE_CLOSE_DONE message.

Since: 1.0

mbim_message_error_new ()

MbimMessage *
mbim_message_error_new (guint32 transaction_id,
                        MbimProtocolError error_status_code);

Create a new MbimMessage of type MBIM_MESSAGE_TYPE_HOST_ERROR with the specified parameters.

Since: 1.0

mbim_message_function_error_new ()

MbimMessage *
mbim_message_function_error_new (guint32 transaction_id,
                                 MbimProtocolError error_status_code);

Create a new MbimMessage of type MBIM_MESSAGE_TYPE_FUNCTION_ERROR with the specified parameters.

Since: 1.12

mbim_message_error_get_error_status_code ()

MbimProtocolError
mbim_message_error_get_error_status_code
                               (const MbimMessage *self);

Get the error code in a MBIM_MESSAGE_TYPE_HOST_ERROR or MBIM_MESSAGE_TYPE_FUNCTION_ERROR message.

Since: 1.0

mbim_message_error_get_error ()

GError *
mbim_message_error_get_error (const MbimMessage *self);

Get the error in a MBIM_MESSAGE_TYPE_HOST_ERROR or MBIM_MESSAGE_TYPE_FUNCTION_ERROR message.

Since: 1.0

mbim_message_command_new ()

MbimMessage *
mbim_message_command_new (guint32 transaction_id,
                          MbimService service,
                          guint32 cid,
                          MbimMessageCommandType command_type);

Create a new MbimMessage of type MBIM_MESSAGE_TYPE_COMMAND with the specified parameters and an empty information buffer.

Since: 1.0

mbim_message_command_append ()

void
mbim_message_command_append (MbimMessage *self,
                             const guint8 *buffer,
                             guint32 buffer_size);

Appends the contents of buffer to self .

Since: 1.0

mbim_message_command_get_service ()

MbimService
mbim_message_command_get_service (const MbimMessage *self);

Get the service of a MBIM_MESSAGE_TYPE_COMMAND message.

Since: 1.0

mbim_message_command_get_service_id ()

const MbimUuid *
mbim_message_command_get_service_id (const MbimMessage *self);

Get the service UUID of a MBIM_MESSAGE_TYPE_COMMAND message.

Since: 1.0

mbim_message_command_get_cid ()

guint32
mbim_message_command_get_cid (const MbimMessage *self);

Get the command id of a MBIM_MESSAGE_TYPE_COMMAND message.

Since: 1.0

mbim_message_command_get_command_type ()

MbimMessageCommandType
mbim_message_command_get_command_type (const MbimMessage *self);

Get the command type of a MBIM_MESSAGE_TYPE_COMMAND message.

Since: 1.0

mbim_message_command_get_raw_information_buffer ()

const guint8 *
mbim_message_command_get_raw_information_buffer
                               (const MbimMessage *self,
                                guint32 *out_length);

Gets the information buffer of the MBIM_MESSAGE_TYPE_COMMAND message.

Since: 1.0

mbim_message_command_type_get_string ()

const gchar *
mbim_message_command_type_get_string (MbimMessageCommandType val);

Gets the nickname string for the MbimMessageCommandType specified at val .

Since: 1.0

mbim_message_command_done_get_service ()

MbimService
mbim_message_command_done_get_service (const MbimMessage *self);

Get the service of a MBIM_MESSAGE_TYPE_COMMAND_DONE message.

Since: 1.0

mbim_message_command_done_get_service_id ()

const MbimUuid *
mbim_message_command_done_get_service_id
                               (const MbimMessage *self);

Get the service UUID of a MBIM_MESSAGE_TYPE_COMMAND_DONE message.

Since: 1.0

mbim_message_command_done_get_cid ()

guint32
mbim_message_command_done_get_cid (const MbimMessage *self);

Get the command id of a MBIM_MESSAGE_TYPE_COMMAND_DONE message.

Since: 1.0

mbim_message_command_done_get_status_code ()

MbimStatusError
mbim_message_command_done_get_status_code
                               (const MbimMessage *self);

Get status code from the MBIM_MESSAGE_TYPE_COMMAND_DONE message.

Since: 1.0

mbim_message_command_done_get_result ()

gboolean
mbim_message_command_done_get_result (const MbimMessage *self,
                                      GError **error);

Gets the result of the 'Command' operation in the MBIM_MESSAGE_TYPE_COMMAND_DONE message.

Since: 1.0

mbim_message_command_done_get_raw_information_buffer ()

const guint8 *
mbim_message_command_done_get_raw_information_buffer
                               (const MbimMessage *self,
                                guint32 *out_length);

Gets the information buffer of the MBIM_MESSAGE_TYPE_COMMAND_DONE message.

Since: 1.0

mbim_message_indicate_status_get_service ()

MbimService
mbim_message_indicate_status_get_service
                               (const MbimMessage *self);

Get the service of a MBIM_MESSAGE_TYPE_INDICATE_STATUS message.

Since: 1.0

mbim_message_indicate_status_get_service_id ()

const MbimUuid *
mbim_message_indicate_status_get_service_id
                               (const MbimMessage *self);

Get the service UUID of a MBIM_MESSAGE_TYPE_INDICATE_STATUS message.

Since: 1.0

mbim_message_indicate_status_get_cid ()

guint32
mbim_message_indicate_status_get_cid (const MbimMessage *self);

Get the command id of a MBIM_MESSAGE_TYPE_INDICATE_STATUS message.

Since: 1.0

mbim_message_indicate_status_get_raw_information_buffer ()

const guint8 *
mbim_message_indicate_status_get_raw_information_buffer
                               (const MbimMessage *self,
                                guint32 *out_length);

Gets the information buffer of the MBIM_MESSAGE_TYPE_INDICATE_STATUS message.

Since: 1.0

mbim_message_response_get_result ()

gboolean
mbim_message_response_get_result (const MbimMessage *self,
                                  MbimMessageType expected,
                                  GError **error);

Gets the result of the operation from the response message, which can be either a MBIM_MESSAGE_TYPE_FUNCTION_ERROR message or a message of the specified expected type.

Since: 1.12

MbimMessage

typedef struct _MbimMessage MbimMessage;

An opaque type representing a MBIM message.

Since: 1.0

enum MbimMessageType

Type of MBIM messages.

Since: 1.0

struct MbimIPv4

struct MbimIPv4 {
    guint8 addr[4];
};

An IPv4 address.

Since: 1.0

struct MbimIPv6

struct MbimIPv6 {
    guint8 addr[16];
};

An IPv6 address.

Since: 1.0

enum MbimMessageCommandType

Type of command message.

Since: 1.0