SpiceClientGLib.QmpPort

g GObject.Object GObject.Object SpiceClientGLib.QmpPort SpiceClientGLib.QmpPort GObject.Object->SpiceClientGLib.QmpPort

Subclasses:

None

Methods

Inherited:

GObject.Object (37)

Structs:

GObject.ObjectClass (5)

class

get (channel)

query_status_async (cancellable, callback, *user_data)

query_status_finish (result)

vm_action_async (action, cancellable, callback, *user_data)

vm_action_finish (result)

Virtual Methods

Inherited:

GObject.Object (7)

Properties

Name

Type

Flags

Short Description

channel

SpiceClientGLib.PortChannel

r/w/co

Associated port channel

ready

bool

r

Whether the QMP port is ready

Signals

Inherited:

GObject.Object (1)

Name

Short Description

event

Event emitted whenever a QMP event is received.

Fields

Inherited:

GObject.Object (1)

Class Details

class SpiceClientGLib.QmpPort(**kwargs)
Bases:

GObject.Object

Abstract:

No

Structure:

SpiceClientGLib.QmpPortClass

Opaque data structure.

New in version 0.36.

classmethod get(channel)
Parameters:

channel (SpiceClientGLib.PortChannel) – the QMP port channel

Returns:

a weak reference to the associated SpiceClientGLib.QmpPort

Return type:

SpiceClientGLib.QmpPort

Associate a QMP port helper to the given port channel. If there is already a helper associated with the channel, it is simply returned.

New in version 0.36.

query_status_async(cancellable, callback, *user_data)
Parameters:

Query the run status of all VCPUs.

New in version 0.36.

query_status_finish(result)
Parameters:

result (Gio.AsyncResult) – The async Gio.AsyncResult result

Raises:

GLib.Error

Returns:

The SpiceClientGLib.QmpStatus result or None, in which case error will be set.

Return type:

SpiceClientGLib.QmpStatus

Finish the asynchronous status query.

New in version 0.36.

vm_action_async(action, cancellable, callback, *user_data)
Parameters:

Request the VM to perform an action.

New in version 0.36.

vm_action_finish(result)
Parameters:

result (Gio.AsyncResult) – The async Gio.AsyncResult result

Raises:

GLib.Error

Return type:

bool

Finishes asynchronous VM action and returns the result.

New in version 0.36.

Signal Details

SpiceClientGLib.QmpPort.signals.event(qmp_port, name, node)
Signal Name:

event

Flags:

RUN_FIRST

Parameters:

Event emitted whenever a QMP event is received.

New in version 0.36.

Property Details

SpiceClientGLib.QmpPort.props.channel
Name:

channel

Type:

SpiceClientGLib.PortChannel

Default Value:

None

Flags:

READABLE, WRITABLE, CONSTRUCT_ONLY

Associated port channel

SpiceClientGLib.QmpPort.props.ready
Name:

ready

Type:

bool

Default Value:

False

Flags:

READABLE

Whether the QMP port is ready