MbimDevice: libmbim-glib Reference Manual

MbimDevice

MbimDevice — Generic MBIM device handling routines

Functions

void	mbim_device_new ()
MbimDevice *	mbim_device_new_finish ()
GFile *	mbim_device_get_file ()
GFile *	mbim_device_peek_file ()
const gchar *	mbim_device_get_path ()
const gchar *	mbim_device_get_path_display ()
gboolean	mbim_device_is_open ()
void	mbim_device_open ()
gboolean	mbim_device_open_finish ()
void	mbim_device_open_full ()
gboolean	mbim_device_open_full_finish ()
void	mbim_device_close ()
gboolean	mbim_device_close_finish ()
gboolean	mbim_device_close_force ()
guint32	mbim_device_get_next_transaction_id ()
void	mbim_device_command ()
MbimMessage *	mbim_device_command_finish ()

Properties

GFile *	device-file	Read / Write / Construct Only
gboolean	device-in-session	Read / Write
guint	device-transaction-id	Read / Write

Signals

void	device-error	Run Last
void	device-indicate-status	Run Last
void	device-removed	Run Last

Types and Values

#define	MBIM_DEVICE_FILE
#define	MBIM_DEVICE_IN_SESSION
#define	MBIM_DEVICE_TRANSACTION_ID
#define	MBIM_DEVICE_SIGNAL_REMOVED
#define	MBIM_DEVICE_SIGNAL_INDICATE_STATUS
#define	MBIM_DEVICE_SIGNAL_ERROR
struct	MbimDevice
enum	MbimDeviceOpenFlags

Object Hierarchy

    GObject
    ╰── MbimDevice

Implemented Interfaces

MbimDevice implements GAsyncInitable.

Description

MbimDevice is a generic type in charge of controlling the access to the managed MBIM port.

A MbimDevice can only handle one single MBIM port.

Functions

mbim_device_new ()

void
mbim_device_new (GFile *file,
                 GCancellable *cancellable,
                 GAsyncReadyCallback callback,
                 gpointer user_data);

Asynchronously creates a MbimDevice object to manage file . When the operation is finished, callback will be invoked. You can then call mbim_device_new_finish() to get the result of the operation.

Parameters

file	a GFile.
cancellable	optional GCancellable object, NULL to ignore.
callback	a GAsyncReadyCallback to call when the initialization is finished.
user_data	the data to pass to callback function.

mbim_device_new_finish ()

MbimDevice *
mbim_device_new_finish (GAsyncResult *res,
                        GError **error);

Finishes an operation started with mbim_device_new().

Parameters

res	a GAsyncResult.
error	Return location for error or `NULL`.

Returns

A newly created MbimDevice, or NULL if error is set.

mbim_device_get_file ()

GFile *
mbim_device_get_file (MbimDevice *self);

Get the GFile associated with this MbimDevice.

Parameters

self

a MbimDevice.

Returns

a GFile that must be freed with g_object_unref().

mbim_device_peek_file ()

GFile *
mbim_device_peek_file (MbimDevice *self);

Get the GFile associated with this MbimDevice, without increasing the reference count on the returned object.

Parameters

self

a MbimDevice.

Returns

a GFile. Do not free the returned object, it is owned by self .

mbim_device_get_path ()

const gchar *
mbim_device_get_path (MbimDevice *self);

Get the system path of the underlying MBIM device.

Parameters

self

a MbimDevice.

Returns

the system path of the device.

mbim_device_get_path_display ()

const gchar *
mbim_device_get_path_display (MbimDevice *self);

Get the system path of the underlying MBIM device in UTF-8.

Parameters

self

a MbimDevice.

Returns

UTF-8 encoded system path of the device.

mbim_device_is_open ()

gboolean
mbim_device_is_open (MbimDevice *self);

Checks whether the MbimDevice is open for I/O.

Parameters

self

a MbimDevice.

Returns

TRUE if self is open, FALSE otherwise.

mbim_device_open ()

void
mbim_device_open (MbimDevice *self,
                  guint timeout,
                  GCancellable *cancellable,
                  GAsyncReadyCallback callback,
                  gpointer user_data);

Asynchronously opens a MbimDevice for I/O.

When the operation is finished callback will be called. You can then call mbim_device_open_finish() to get the result of the operation.

Parameters

self	a MbimDevice.
timeout	maximum time, in seconds, to wait for the device to be opened.
cancellable	optional GCancellable object, NULL to ignore.
callback	a GAsyncReadyCallback to call when the operation is finished.
user_data	the data to pass to callback function.

mbim_device_open_finish ()

gboolean
mbim_device_open_finish (MbimDevice *self,
                         GAsyncResult *res,
                         GError **error);

Finishes an asynchronous open operation started with mbim_device_open().

Parameters

self	a MbimDevice.
res	a GAsyncResult.
error	Return location for error or `NULL`.

Returns

TRUE if successful, FALSE if error is set.

mbim_device_open_full ()

void
mbim_device_open_full (MbimDevice *self,
                       MbimDeviceOpenFlags flags,
                       guint timeout,
                       GCancellable *cancellable,
                       GAsyncReadyCallback callback,
                       gpointer user_data);

Asynchronously opens a MbimDevice for I/O.

This method is an extension of the generic mbim_device_open(), which allows launching the MbimDevice with proxy support.

When the operation is finished callback will be called. You can then call mbim_device_open_full_finish() to get the result of the operation.

Parameters

self	a MbimDevice.
flags	a set of MbimDeviceOpenFlags.
timeout	maximum time, in seconds, to wait for the device to be opened.
cancellable	optional GCancellable object, NULL to ignore.
callback	a GAsyncReadyCallback to call when the operation is finished.
user_data	the data to pass to callback function.

mbim_device_open_full_finish ()

gboolean
mbim_device_open_full_finish (MbimDevice *self,
                              GAsyncResult *res,
                              GError **error);

Finishes an asynchronous open operation started with mbim_device_open_full().

Parameters

self	a MbimDevice.
res	a GAsyncResult.
error	Return location for error or `NULL`.

Returns

TRUE if successful, FALSE if error is set.

mbim_device_close ()

void
mbim_device_close (MbimDevice *self,
                   guint timeout,
                   GCancellable *cancellable,
                   GAsyncReadyCallback callback,
                   gpointer user_data);

Asynchronously closes a MbimDevice for I/O.

When the operation is finished callback will be called. You can then call mbim_device_close_finish() to get the result of the operation.

Parameters

self	a MbimDevice.
timeout	maximum time, in seconds, to wait for the device to be closed.
cancellable	optional GCancellable object, NULL to ignore.
callback	a GAsyncReadyCallback to call when the operation is finished.
user_data	the data to pass to callback function.

mbim_device_close_finish ()

gboolean
mbim_device_close_finish (MbimDevice *self,
                          GAsyncResult *res,
                          GError **error);

Finishes an asynchronous close operation started with mbim_device_close().

Parameters

self	a MbimDevice.
res	a GAsyncResult.
error	Return location for error or `NULL`.

Returns

TRUE if successful, FALSE if error is set.

mbim_device_close_force ()

gboolean
mbim_device_close_force (MbimDevice *self,
                         GError **error);

Forces the MbimDevice to be closed.

Parameters

self	a MbimDevice.
error	Return location for error or `NULL`.

Returns

TRUE if self if no error happens, otherwise FALSE and error is set.

mbim_device_get_next_transaction_id ()

guint32
mbim_device_get_next_transaction_id (MbimDevice *self);

Acquire the next transaction ID of this MbimDevice. The internal transaction ID gets incremented.

Parameters

self

A MbimDevice.

Returns

the next transaction ID.

mbim_device_command ()

void
mbim_device_command (MbimDevice *self,
                     MbimMessage *message,
                     guint timeout,
                     GCancellable *cancellable,
                     GAsyncReadyCallback callback,
                     gpointer user_data);

Asynchronously sends a MbimMessage to the device.

When the operation is finished callback will be called. You can then call mbim_device_command_finish() to get the result of the operation.

Parameters

self	a MbimDevice.
message	the message to send.
timeout	maximum time, in seconds, to wait for the response.
cancellable	a GCancellable, or `NULL`.
callback	a GAsyncReadyCallback to call when the operation is finished.
user_data	the data to pass to callback function.

mbim_device_command_finish ()

MbimMessage *
mbim_device_command_finish (MbimDevice *self,
                            GAsyncResult *res,
                            GError **error);

Finishes an operation started with mbim_device_command().

Parameters

self	a MbimDevice.
res	a GAsyncResult.
error	Return location for error or `NULL`.

Returns

a MbimMessage response, or NULL if error is set. The returned value should be freed with mbim_message_unref().

Types and Values

MBIM_DEVICE_FILE

#define MBIM_DEVICE_FILE           "device-file"

MBIM_DEVICE_IN_SESSION

#define MBIM_DEVICE_IN_SESSION     "device-in-session"

MBIM_DEVICE_TRANSACTION_ID

#define MBIM_DEVICE_TRANSACTION_ID "device-transaction-id"

MBIM_DEVICE_SIGNAL_REMOVED

#define MBIM_DEVICE_SIGNAL_REMOVED         "device-removed"

MBIM_DEVICE_SIGNAL_INDICATE_STATUS

#define MBIM_DEVICE_SIGNAL_INDICATE_STATUS "device-indicate-status"

MBIM_DEVICE_SIGNAL_ERROR

#define MBIM_DEVICE_SIGNAL_ERROR           "device-error"

struct MbimDevice

struct MbimDevice;

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

enum MbimDeviceOpenFlags

Flags to specify which actions to be performed when the device is open.

Members

MBIM_DEVICE_OPEN_FLAGS_NONE	None.
MBIM_DEVICE_OPEN_FLAGS_PROXY	Try to open the port through the 'mbim-proxy'.

Property Details

The `“device-file”` property

  “device-file”              GFile *

File to the underlying MBIM device.

Flags: Read / Write / Construct Only

The `“device-in-session”` property

  “device-in-session”        gboolean

Flag to specify if the device is within a session.

Flags: Read / Write

Default value: FALSE

The `“device-transaction-id”` property

  “device-transaction-id”    guint

Current transaction ID.

Flags: Read / Write

Allowed values: >= 1

Default value: 1

Signal Details

The `“device-error”` signal

void
user_function (MbimDevice *self,
               GError     *message,
               gpointer    user_data)

The ::device-error signal is emitted when a MBIM error is received.

Parameters

self	the MbimDevice
message	the MbimMessage error
user_data	user data set when the signal handler was connected.

Flags: Run Last

The `“device-indicate-status”` signal

void
user_function (MbimDevice  *self,
               MbimMessage *message,
               gpointer     user_data)

The ::device-indication-status signal is emitted when a MBIM indication is received.

Parameters

self	the MbimDevice
message	the MbimMessage indication
user_data	user data set when the signal handler was connected.

Flags: Run Last

The `“device-removed”` signal

void
user_function (MbimDevice *self,
               gpointer    user_data)

The ::device-removed signal is emitted when an unexpected port hang-up is received.

Parameters

self	the MbimDevice
message	None
user_data	user data set when the signal handler was connected.

Flags: Run Last

MbimDevice

Functions

Properties

Signals

Types and Values

Object Hierarchy

Implemented Interfaces

Description

Functions

mbim_device_new ()

Parameters

mbim_device_new_finish ()

Parameters

Returns

mbim_device_get_file ()

Parameters

Returns

mbim_device_peek_file ()

Parameters

Returns

mbim_device_get_path ()

Parameters

Returns

mbim_device_get_path_display ()

Parameters

Returns

mbim_device_is_open ()

Parameters

Returns

mbim_device_open ()

Parameters

mbim_device_open_finish ()

Parameters

Returns

mbim_device_open_full ()

Parameters

mbim_device_open_full_finish ()

Parameters

Returns

mbim_device_close ()

Parameters

mbim_device_close_finish ()

Parameters

Returns

mbim_device_close_force ()

Parameters

Returns

mbim_device_get_next_transaction_id ()

Parameters

Returns

mbim_device_command ()

Parameters

mbim_device_command_finish ()

Parameters

Returns

Types and Values

MBIM_DEVICE_FILE

MBIM_DEVICE_IN_SESSION

MBIM_DEVICE_TRANSACTION_ID

MBIM_DEVICE_SIGNAL_REMOVED

MBIM_DEVICE_SIGNAL_INDICATE_STATUS

MBIM_DEVICE_SIGNAL_ERROR

struct MbimDevice

enum MbimDeviceOpenFlags

Members

Property Details

The “device-file” property

The “device-in-session” property

The “device-transaction-id” property

Signal Details

The “device-error” signal

Parameters

The “device-indicate-status” signal

Parameters

The “device-removed” signal

Parameters

The `“device-file”` property

The `“device-in-session”` property

The `“device-transaction-id”` property

The `“device-error”` signal

The `“device-indicate-status”` signal

The `“device-removed”` signal