UDisks.ManagerNVMe¶

Implementations:: UDisks.ManagerNVMeProxy, UDisks.ManagerNVMeSkeleton

Methods¶

class	`interface_info` ()
class	`override_properties` (klass, property_id_begin)
	`call_connect` (arg_subsysnqn, arg_transport, arg_transport_addr, arg_options, cancellable, callback, *user_data)
	`call_connect_finish` (res)
	`call_connect_sync` (arg_subsysnqn, arg_transport, arg_transport_addr, arg_options, cancellable)
	`call_set_host_id` (arg_hostid, arg_options, cancellable, callback, *user_data)
	`call_set_host_id_finish` (res)
	`call_set_host_id_sync` (arg_hostid, arg_options, cancellable)
	`call_set_host_nqn` (arg_hostnqn, arg_options, cancellable, callback, *user_data)
	`call_set_host_nqn_finish` (res)
	`call_set_host_nqn_sync` (arg_hostnqn, arg_options, cancellable)
	`complete_connect` (invocation, nvme_ctrl)
	`complete_set_host_id` (invocation)
	`complete_set_host_nqn` (invocation)

Virtual Methods¶

	`do_handle_connect` (invocation, arg_subsysnqn, arg_transport, arg_transport_addr, arg_options)
	`do_handle_set_host_id` (invocation, arg_hostid, arg_options)
	`do_handle_set_host_nqn` (invocation, arg_hostnqn, arg_options)

Properties¶

Name	Type	Flags	Short Description
`host-id`	`str`	r/w	HostID
`host-nqn`	`str`	r/w	HostNQN

Signals¶

Name	Short Description
`handle-connect`	Signal emitted when a remote caller is invoking the ‘Connect() [gdbus-method-org-freedesktop-UDisks2-Manager-NVMe.Connect]’ D-Bus method.
`handle-set-host-id`	Signal emitted when a remote caller is invoking the ‘SetHostID() [gdbus-method-org-freedesktop-UDisks2-Manager-NVMe.SetHostID]’ D-Bus method.
`handle-set-host-nqn`	Signal emitted when a remote caller is invoking the ‘SetHostNQN() [gdbus-method-org-freedesktop-UDisks2-Manager-NVMe.SetHostNQN]’ D-Bus method.

Fields¶

None

Class Details¶

class UDisks.ManagerNVMe¶

Bases:: GObject.GInterface
Structure:: UDisks.ManagerNVMeIface

Abstract interface type for the D-Bus interface ‘org.freedesktop.UDisks2.Manager.NVMe [gdbus-interface-org-freedesktop-UDisks2-Manager-NVMe.top_of_page]’.

classmethod interface_info()¶

Returns:: A Gio.DBusInterfaceInfo. Do not free.
Return type:: Gio.DBusInterfaceInfo

Gets a machine-readable description of the ‘org.freedesktop.UDisks2.Manager.NVMe [gdbus-interface-org-freedesktop-UDisks2-Manager-NVMe.top_of_page]’ D-Bus interface.

classmethod override_properties(klass, property_id_begin)¶

Parameters:

klass (GObject.ObjectClass) – The class structure for a GObject.Object derived class.
property_id_begin (int) – The property id to assign to the first overridden property.

Returns:

The last property id.

Return type:

int

Overrides all GObject.Object properties in the UDisks.ManagerNVMe interface for a concrete class. The properties are overridden in the order they are defined.

call_connect(arg_subsysnqn, arg_transport, arg_transport_addr, arg_options, cancellable, callback, *user_data)¶

Parameters:

arg_subsysnqn (str) – Argument to pass with the method invocation.
arg_transport (str) – Argument to pass with the method invocation.
arg_transport_addr (str) – Argument to pass with the method invocation.
arg_options (GLib.Variant) – Argument to pass with the method invocation.
cancellable (Gio.Cancellable or None) – A Gio.Cancellable or None.
callback (Gio.AsyncReadyCallback or None) – A Gio.AsyncReadyCallback to call when the request is satisfied or None.
user_data (object or None) – User data to pass to callback.

Asynchronously invokes the ‘Connect() [gdbus-method-org-freedesktop-UDisks2-Manager-NVMe.Connect]’ D-Bus method on self. When the operation is finished, callback will be invoked in the thread-default main loop of the thread you are calling this method from (see GLib.MainContext.push_thread_default()). You can then call UDisks.ManagerNVMe.call_connect_finish() to get the result of the operation.

See UDisks.ManagerNVMe.call_connect_sync() for the synchronous, blocking version of this method.

New in version 2.10.0.

call_connect_finish(res)¶

Parameters:

res (Gio.AsyncResult) – The Gio.AsyncResult obtained from the Gio.AsyncReadyCallback passed to UDisks.ManagerNVMe.call_connect().

Raises:

GLib.Error

Returns:

True if the call succeeded, False if error is set.

out_nvme_ctrl:: Return location for return parameter or None to ignore.

Return type:

(bool, out_nvme_ctrl: str)

Finishes an operation started with UDisks.ManagerNVMe.call_connect().

New in version 2.10.0.

call_connect_sync(arg_subsysnqn, arg_transport, arg_transport_addr, arg_options, cancellable)¶

Parameters:

arg_subsysnqn (str) – Argument to pass with the method invocation.
arg_transport (str) – Argument to pass with the method invocation.
arg_transport_addr (str) – Argument to pass with the method invocation.
arg_options (GLib.Variant) – Argument to pass with the method invocation.
cancellable (Gio.Cancellable or None) – A Gio.Cancellable or None.

Raises:

GLib.Error

Returns:

True if the call succeeded, False if error is set.

out_nvme_ctrl:: Return location for return parameter or None to ignore.

Return type:

(bool, out_nvme_ctrl: str)

Synchronously invokes the ‘Connect() [gdbus-method-org-freedesktop-UDisks2-Manager-NVMe.Connect]’ D-Bus method on self. The calling thread is blocked until a reply is received.

See UDisks.ManagerNVMe.call_connect() for the asynchronous version of this method.

New in version 2.10.0.

call_set_host_id(arg_hostid, arg_options, cancellable, callback, *user_data)¶

Parameters:

arg_hostid (str) – Argument to pass with the method invocation.
arg_options (GLib.Variant) – Argument to pass with the method invocation.
cancellable (Gio.Cancellable or None) – A Gio.Cancellable or None.
callback (Gio.AsyncReadyCallback or None) – A Gio.AsyncReadyCallback to call when the request is satisfied or None.
user_data (object or None) – User data to pass to callback.

Asynchronously invokes the ‘SetHostID() [gdbus-method-org-freedesktop-UDisks2-Manager-NVMe.SetHostID]’ D-Bus method on self. When the operation is finished, callback will be invoked in the thread-default main loop of the thread you are calling this method from (see GLib.MainContext.push_thread_default()). You can then call UDisks.ManagerNVMe.call_set_host_id_finish() to get the result of the operation.

See UDisks.ManagerNVMe.call_set_host_id_sync() for the synchronous, blocking version of this method.

New in version 2.10.0.

call_set_host_id_finish(res)¶

Parameters:: res (Gio.AsyncResult) – The Gio.AsyncResult obtained from the Gio.AsyncReadyCallback passed to UDisks.ManagerNVMe.call_set_host_id().
Raises:: GLib.Error
Returns:: True if the call succeeded, False if error is set.
Return type:: bool

Finishes an operation started with UDisks.ManagerNVMe.call_set_host_id().

New in version 2.10.0.

call_set_host_id_sync(arg_hostid, arg_options, cancellable)¶

Parameters:

arg_hostid (str) – Argument to pass with the method invocation.
arg_options (GLib.Variant) – Argument to pass with the method invocation.
cancellable (Gio.Cancellable or None) – A Gio.Cancellable or None.

Raises:

GLib.Error

Returns:

True if the call succeeded, False if error is set.

Return type:

bool

Synchronously invokes the ‘SetHostID() [gdbus-method-org-freedesktop-UDisks2-Manager-NVMe.SetHostID]’ D-Bus method on self. The calling thread is blocked until a reply is received.

See UDisks.ManagerNVMe.call_set_host_id() for the asynchronous version of this method.

New in version 2.10.0.

call_set_host_nqn(arg_hostnqn, arg_options, cancellable, callback, *user_data)¶

Parameters:

arg_hostnqn (str) – Argument to pass with the method invocation.
arg_options (GLib.Variant) – Argument to pass with the method invocation.
cancellable (Gio.Cancellable or None) – A Gio.Cancellable or None.
callback (Gio.AsyncReadyCallback or None) – A Gio.AsyncReadyCallback to call when the request is satisfied or None.
user_data (object or None) – User data to pass to callback.

Asynchronously invokes the ‘SetHostNQN() [gdbus-method-org-freedesktop-UDisks2-Manager-NVMe.SetHostNQN]’ D-Bus method on self. When the operation is finished, callback will be invoked in the thread-default main loop of the thread you are calling this method from (see GLib.MainContext.push_thread_default()). You can then call UDisks.ManagerNVMe.call_set_host_nqn_finish() to get the result of the operation.

See UDisks.ManagerNVMe.call_set_host_nqn_sync() for the synchronous, blocking version of this method.

New in version 2.10.0.

call_set_host_nqn_finish(res)¶

Parameters:: res (Gio.AsyncResult) – The Gio.AsyncResult obtained from the Gio.AsyncReadyCallback passed to UDisks.ManagerNVMe.call_set_host_nqn().
Raises:: GLib.Error
Returns:: True if the call succeeded, False if error is set.
Return type:: bool

Finishes an operation started with UDisks.ManagerNVMe.call_set_host_nqn().

New in version 2.10.0.

call_set_host_nqn_sync(arg_hostnqn, arg_options, cancellable)¶

Parameters:

arg_hostnqn (str) – Argument to pass with the method invocation.
arg_options (GLib.Variant) – Argument to pass with the method invocation.
cancellable (Gio.Cancellable or None) – A Gio.Cancellable or None.

Raises:

GLib.Error

Returns:

True if the call succeeded, False if error is set.

Return type:

bool

Synchronously invokes the ‘SetHostNQN() [gdbus-method-org-freedesktop-UDisks2-Manager-NVMe.SetHostNQN]’ D-Bus method on self. The calling thread is blocked until a reply is received.

See UDisks.ManagerNVMe.call_set_host_nqn() for the asynchronous version of this method.

New in version 2.10.0.

complete_connect(invocation, nvme_ctrl)¶

Parameters:

invocation (Gio.DBusMethodInvocation) – A Gio.DBusMethodInvocation.
nvme_ctrl (str) – Parameter to return.

Helper function used in service implementations to finish handling invocations of the ‘Connect() [gdbus-method-org-freedesktop-UDisks2-Manager-NVMe.Connect]’ D-Bus method. If you instead want to finish handling an invocation by returning an error, use g_dbus_method_invocation_return_error() or similar.

This method will free invocation, you cannot use it afterwards.

New in version 2.10.0.

complete_set_host_id(invocation)¶

Parameters:: invocation (Gio.DBusMethodInvocation) – A Gio.DBusMethodInvocation.

Helper function used in service implementations to finish handling invocations of the ‘SetHostID() [gdbus-method-org-freedesktop-UDisks2-Manager-NVMe.SetHostID]’ D-Bus method. If you instead want to finish handling an invocation by returning an error, use g_dbus_method_invocation_return_error() or similar.

This method will free invocation, you cannot use it afterwards.

New in version 2.10.0.

complete_set_host_nqn(invocation)¶

Parameters:: invocation (Gio.DBusMethodInvocation) – A Gio.DBusMethodInvocation.

Helper function used in service implementations to finish handling invocations of the ‘SetHostNQN() [gdbus-method-org-freedesktop-UDisks2-Manager-NVMe.SetHostNQN]’ D-Bus method. If you instead want to finish handling an invocation by returning an error, use g_dbus_method_invocation_return_error() or similar.

This method will free invocation, you cannot use it afterwards.

New in version 2.10.0.

do_handle_connect(invocation, arg_subsysnqn, arg_transport, arg_transport_addr, arg_options) virtual¶

Parameters:

invocation (Gio.DBusMethodInvocation) –
arg_subsysnqn (str) –
arg_transport (str) –
arg_transport_addr (str) –
arg_options (GLib.Variant) –

Return type:

bool

Handler for the UDisks.ManagerNVMe ::handle-connect signal.

do_handle_set_host_id(invocation, arg_hostid, arg_options) virtual¶

Parameters:

invocation (Gio.DBusMethodInvocation) –
arg_hostid (str) –
arg_options (GLib.Variant) –

Return type:

bool

Handler for the UDisks.ManagerNVMe ::handle-set-host-id signal.

do_handle_set_host_nqn(invocation, arg_hostnqn, arg_options) virtual¶

Parameters:

invocation (Gio.DBusMethodInvocation) –
arg_hostnqn (str) –
arg_options (GLib.Variant) –

Return type:

bool

Handler for the UDisks.ManagerNVMe ::handle-set-host-nqn signal.

Signal Details¶

UDisks.ManagerNVMe.signals.handle_connect(manager_n_v_me, invocation, arg_subsysnqn, arg_transport, arg_transport_addr, arg_options)¶

Signal Name:

handle-connect

Flags:

RUN_LAST

Parameters:

manager_n_v_me (UDisks.ManagerNVMe) – The object which received the signal
invocation (Gio.DBusMethodInvocation) – A Gio.DBusMethodInvocation.
arg_subsysnqn (str) – Argument passed by remote caller.
arg_transport (str) – Argument passed by remote caller.
arg_transport_addr (str) – Argument passed by remote caller.
arg_options (GLib.Variant) – Argument passed by remote caller.

Returns:

Gio.DBUS_METHOD_INVOCATION_HANDLED or True if the invocation was handled, Gio.DBUS_METHOD_INVOCATION_UNHANDLED or False to let other signal handlers run.

Return type:

bool

Signal emitted when a remote caller is invoking the ‘Connect() [gdbus-method-org-freedesktop-UDisks2-Manager-NVMe.Connect]’ D-Bus method.

If a signal handler returns True, it means the signal handler will handle the invocation (e.g. take a reference to invocation and eventually call UDisks.ManagerNVMe.complete_connect() or e.g. g_dbus_method_invocation_return_error() on it) and no other signal handlers will run. If no signal handler handles the invocation, the Gio.DBusError.UNKNOWN_METHOD error is returned.

New in version 2.10.0.

UDisks.ManagerNVMe.signals.handle_set_host_id(manager_n_v_me, invocation, arg_hostid, arg_options)¶

Signal Name:

handle-set-host-id

Flags:

RUN_LAST

Parameters:

manager_n_v_me (UDisks.ManagerNVMe) – The object which received the signal
invocation (Gio.DBusMethodInvocation) – A Gio.DBusMethodInvocation.
arg_hostid (str) – Argument passed by remote caller.
arg_options (GLib.Variant) – Argument passed by remote caller.

Returns:

Gio.DBUS_METHOD_INVOCATION_HANDLED or True if the invocation was handled, Gio.DBUS_METHOD_INVOCATION_UNHANDLED or False to let other signal handlers run.

Return type:

bool

Signal emitted when a remote caller is invoking the ‘SetHostID() [gdbus-method-org-freedesktop-UDisks2-Manager-NVMe.SetHostID]’ D-Bus method.

If a signal handler returns True, it means the signal handler will handle the invocation (e.g. take a reference to invocation and eventually call UDisks.ManagerNVMe.complete_set_host_id() or e.g. g_dbus_method_invocation_return_error() on it) and no other signal handlers will run. If no signal handler handles the invocation, the Gio.DBusError.UNKNOWN_METHOD error is returned.

New in version 2.10.0.

UDisks.ManagerNVMe.signals.handle_set_host_nqn(manager_n_v_me, invocation, arg_hostnqn, arg_options)¶

Signal Name:

handle-set-host-nqn

Flags:

RUN_LAST

Parameters:

manager_n_v_me (UDisks.ManagerNVMe) – The object which received the signal
invocation (Gio.DBusMethodInvocation) – A Gio.DBusMethodInvocation.
arg_hostnqn (str) – Argument passed by remote caller.
arg_options (GLib.Variant) – Argument passed by remote caller.

Returns:

Gio.DBUS_METHOD_INVOCATION_HANDLED or True if the invocation was handled, Gio.DBUS_METHOD_INVOCATION_UNHANDLED or False to let other signal handlers run.

Return type:

bool

Signal emitted when a remote caller is invoking the ‘SetHostNQN() [gdbus-method-org-freedesktop-UDisks2-Manager-NVMe.SetHostNQN]’ D-Bus method.

If a signal handler returns True, it means the signal handler will handle the invocation (e.g. take a reference to invocation and eventually call UDisks.ManagerNVMe.complete_set_host_nqn() or e.g. g_dbus_method_invocation_return_error() on it) and no other signal handlers will run. If no signal handler handles the invocation, the Gio.DBusError.UNKNOWN_METHOD error is returned.

New in version 2.10.0.

Property Details¶

UDisks.ManagerNVMe.props.host_id¶

Name:: host-id
Type:: str
Default Value:: None
Flags:: READABLE, WRITABLE

Represents the D-Bus property ‘“HostID” [gdbus-property-org-freedesktop-UDisks2-Manager-NVMe.HostID]’.

Since the D-Bus property for this GObject.Object property is readable but not writable, it is meaningful to read from it on both the client- and service-side. It is only meaningful, however, to write to it on the service-side.

UDisks.ManagerNVMe.props.host_nqn¶

Name:: host-nqn
Type:: str
Default Value:: None
Flags:: READABLE, WRITABLE

Represents the D-Bus property ‘“HostNQN” [gdbus-property-org-freedesktop-UDisks2-Manager-NVMe.HostNQN]’.

Since the D-Bus property for this GObject.Object property is readable but not writable, it is meaningful to read from it on both the client- and service-side. It is only meaningful, however, to write to it on the service-side.