Qmi.Client¶

Methods¶

Inherited:: GObject.Object (37)
Structs:: GObject.ObjectClass (5)

	`check_version` (major, minor)
	`get_cid` ()
	`get_device` ()
	`get_next_transaction_id` ()
	`get_service` ()
	`get_version` (major, minor)
	`is_valid` ()
	`peek_device` ()

Virtual Methods¶

Inherited:: GObject.Object (7)

do_process_indication (message)

Properties¶

Name	Type	Flags	Short Description
`client-cid`	`int`	r/w	ID of the client registered into the QMI device
`client-device`	`Qmi.Device`	r/w	The QMI device
`client-service`	`Qmi.Service`	r/w	QMI service this client is using
`client-valid`	`bool`	r	Whether the client is valid and usable
`client-version-major`	`int`	r/w	Major version of the service handled by this client
`client-version-minor`	`int`	r/w	Minor version of the service handled by this client

Signals¶

Inherited:: GObject.Object (1)

Fields¶

Inherited:: GObject.Object (1)

Name	Type	Access	Description
parent	`GObject.Object`	r

Class Details¶

class Qmi.Client(**kwargs)¶

Bases:: GObject.Object
Abstract:: Yes
Structure:: Qmi.ClientClass

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

Added in version 1.0.

check_version(major, minor)¶

Parameters:

major (int) – a major version.
minor (int) – a minor version.

Returns:

True if the version of the service is greater or equal than the one given, False otherwise.

Return type:

bool

Checks if the version of the service handled by this Qmi.Client is greater or equal than the given version.

Added in version 1.0.

get_cid()¶

Returns:: the client ID.
Return type:: int

Get the client ID of this Qmi.Client.

Added in version 1.0.

get_device()¶

Returns:: a GObject.Object that must be freed with GObject.Object.unref().
Return type:: GObject.Object

Get the Qmi.Device associated with this Qmi.Client.

Added in version 1.0.

get_next_transaction_id()¶

Returns:: the next transaction ID.
Return type:: int

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

Added in version 1.0.

get_service()¶

Returns:: a Qmi.Service.
Return type:: Qmi.Service

Get the service being used by this Qmi.Client.

Added in version 1.0.

get_version(major, minor)¶

Parameters:

major (int) – placeholder for the output major version.
minor (int) – placeholder for the output minor version.

Returns:

True if the version was properly reported, False otherwise.

Return type:

bool

Get the version of the service handled by this Qmi.Client.

Added in version 1.0.

is_valid()¶

Returns:: True if the client is valid, False otherwise.
Return type:: bool

Checks whether Qmi.Client is a valid and usable client.

The client is marked as invalid as soon as the client id is released or when the associated Qmi.Device is closed.

This method may be used if the caller needs to ensure validity before a command is attempted, e.g. if the lifecycle of the object is managed in some other place and the caller just has a reference to the Qmi.Client.

Added in version 1.20.

peek_device()¶

Returns:: a GObject.Object. Do not free the returned object, it is owned by self.
Return type:: GObject.Object

Get the Qmi.Device associated with this Qmi.Client, without increasing the reference count on the returned object.

Added in version 1.0.

do_process_indication(message) virtual¶

Parameters:: message (GLib.ByteArray)

Property Details¶

Qmi.Client.props.client_cid¶

Name:: client-cid
Type:: int
Default Value:: 0
Flags:: READABLE, WRITABLE

ID of the client registered into the QMI device

Added in version 1.0.

Qmi.Client.props.client_device¶

Name:: client-device
Type:: Qmi.Device
Default Value:: None
Flags:: READABLE, WRITABLE

The QMI device

Added in version 1.0.

Qmi.Client.props.client_service¶

Name:: client-service
Type:: Qmi.Service
Default Value:: Qmi.Service.UNKNOWN
Flags:: READABLE, WRITABLE

QMI service this client is using

Added in version 1.0.

Qmi.Client.props.client_valid¶

Name:: client-valid
Type:: bool
Default Value:: False
Flags:: READABLE

Whether the client is valid and usable

Added in version 1.20.

Qmi.Client.props.client_version_major¶

Name:: client-version-major
Type:: int
Default Value:: 0
Flags:: READABLE, WRITABLE

Major version of the service handled by this client

Added in version 1.0.

Qmi.Client.props.client_version_minor¶

Name:: client-version-minor
Type:: int
Default Value:: 0
Flags:: READABLE, WRITABLE

Minor version of the service handled by this client

Added in version 1.0.