UDisks.NVMeNamespace

Implementations:

UDisks.NVMeNamespaceProxy, UDisks.NVMeNamespaceSkeleton

Methods

class	interface_info ()
class	override_properties (klass, property_id_begin)
	call_format_namespace (arg_options, cancellable, callback, *user_data)
	call_format_namespace_finish (res)
	call_format_namespace_sync (arg_options, cancellable)
	complete_format_namespace (invocation)

Virtual Methods

do_handle_format_namespace (invocation, arg_options)

Properties

Name	Type	Flags	Short Description
eui64	str	r/w	EUI64
format-percent-remaining	int	r/w	FormatPercentRemaining
formatted-lbasize	GLib.Variant	r/w	FormattedLBASize
lbaformats	GLib.Variant	r/w	LBAFormats
namespace-capacity	int	r/w	NamespaceCapacity
namespace-size	int	r/w	NamespaceSize
namespace-utilization	int	r/w	NamespaceUtilization
nguid	str	r/w	NGUID
nsid	int	r/w	NSID
uuid	str	r/w	UUID
wwn	str	r/w	WWN

Signals

Name	Short Description
handle-format-namespace	Signal emitted when a remote caller is invoking the ‘FormatNamespace() [gdbus-method-org-freedesktop-UDisks2-NVMe-Namespace.FormatNamespace]’ D-Bus method.

Fields

None

Class Details

class UDisks.NVMeNamespace

Bases:

GObject.GInterface

Structure:

UDisks.NVMeNamespaceIface

Abstract interface type for the D-Bus interface ‘org.freedesktop.UDisks2.NVMe.Namespace [gdbus-interface-org-freedesktop-UDisks2-NVMe-Namespace.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.NVMe.Namespace [gdbus-interface-org-freedesktop-UDisks2-NVMe-Namespace.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.NVMeNamespace interface for a concrete class. The properties are overridden in the order they are defined.

call_format_namespace(arg_options, cancellable, callback, *user_data)

Parameters:

• 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 ‘FormatNamespace() [gdbus-method-org-freedesktop-UDisks2-NVMe-Namespace.FormatNamespace]’ 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.NVMeNamespace.call_format_namespace_finish() to get the result of the operation.

See UDisks.NVMeNamespace.call_format_namespace_sync() for the synchronous, blocking version of this method.

New in version 2.10.0.

call_format_namespace_finish(res)

Parameters:

res (Gio.AsyncResult) – The Gio.AsyncResult obtained from the Gio.AsyncReadyCallback passed to UDisks.NVMeNamespace.call_format_namespace().

Raises:

GLib.Error

Returns:

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

Return type:

bool

Finishes an operation started with UDisks.NVMeNamespace.call_format_namespace().

New in version 2.10.0.

call_format_namespace_sync(arg_options, cancellable)

Parameters:

• 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 ‘FormatNamespace() [gdbus-method-org-freedesktop-UDisks2-NVMe-Namespace.FormatNamespace]’ D-Bus method on self. The calling thread is blocked until a reply is received.

See UDisks.NVMeNamespace.call_format_namespace() for the asynchronous version of this method.

New in version 2.10.0.

complete_format_namespace(invocation)

Parameters:

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

Helper function used in service implementations to finish handling invocations of the ‘FormatNamespace() [gdbus-method-org-freedesktop-UDisks2-NVMe-Namespace.FormatNamespace]’ 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_format_namespace(invocation, arg_options) virtual

Parameters:

• invocation (Gio.DBusMethodInvocation) –

• arg_options (GLib.Variant) –

Return type:

bool

Signal Details

UDisks.NVMeNamespace.signals.handle_format_namespace(n_v_me_namespace, invocation, arg_options)

Signal Name:

handle-format-namespace

Flags:

RUN_LAST

Parameters:

• n_v_me_namespace (UDisks.NVMeNamespace) – The object which received the signal

• invocation (Gio.DBusMethodInvocation) – A Gio.DBusMethodInvocation.

• 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 ‘FormatNamespace() [gdbus-method-org-freedesktop-UDisks2-NVMe-Namespace.FormatNamespace]’ 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.NVMeNamespace.complete_format_namespace() 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.NVMeNamespace.props.eui64

Name:

eui64

Type:

str

Default Value:

None

Flags:

READABLE, WRITABLE

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

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.NVMeNamespace.props.format_percent_remaining

Name:

format-percent-remaining

Type:

int

Default Value:

0

Flags:

READABLE, WRITABLE

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

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.

New in version 2.10.0.

UDisks.NVMeNamespace.props.formatted_lbasize

Name:

formatted-lbasize

Type:

GLib.Variant

Default Value:

None

Flags:

READABLE, WRITABLE

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

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.NVMeNamespace.props.lbaformats

Name:

lbaformats

Type:

GLib.Variant

Default Value:

None

Flags:

READABLE, WRITABLE

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

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.NVMeNamespace.props.namespace_capacity

Name:

namespace-capacity

Type:

int

Default Value:

0

Flags:

READABLE, WRITABLE

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

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.NVMeNamespace.props.namespace_size

Name:

namespace-size

Type:

int

Default Value:

0

Flags:

READABLE, WRITABLE

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

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.NVMeNamespace.props.namespace_utilization

Name:

namespace-utilization

Type:

int

Default Value:

0

Flags:

READABLE, WRITABLE

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

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.NVMeNamespace.props.nguid

Name:

nguid

Type:

str

Default Value:

None

Flags:

READABLE, WRITABLE

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

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.NVMeNamespace.props.nsid

Name:

nsid

Type:

int

Default Value:

0

Flags:

READABLE, WRITABLE

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

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.NVMeNamespace.props.uuid

Name:

uuid

Type:

str

Default Value:

None

Flags:

READABLE, WRITABLE

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

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.NVMeNamespace.props.wwn

Name:

wwn

Type:

str

Default Value:

None

Flags:

READABLE, WRITABLE

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

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.