StoragedObject: Storaged Reference Manual

StoragedObject

StoragedObject — Specialized GDBusObject types

Functions

StoragedBlock *	storaged_object_get_block ()
StoragedDrive *	storaged_object_get_drive ()
StoragedDriveAta *	storaged_object_get_drive_ata ()
StoragedFilesystem *	storaged_object_get_filesystem ()
StoragedJob *	storaged_object_get_job ()
StoragedSwapspace *	storaged_object_get_swapspace ()
StoragedEncrypted *	storaged_object_get_encrypted ()
StoragedLoop *	storaged_object_get_loop ()
StoragedManager *	storaged_object_get_manager ()
StoragedPartition *	storaged_object_get_partition ()
StoragedPartitionTable *	storaged_object_get_partition_table ()
StoragedMDRaid *	storaged_object_get_mdraid ()
StoragedBlock *	storaged_object_peek_block ()
StoragedDrive *	storaged_object_peek_drive ()
StoragedDriveAta *	storaged_object_peek_drive_ata ()
StoragedFilesystem *	storaged_object_peek_filesystem ()
StoragedJob *	storaged_object_peek_job ()
StoragedSwapspace *	storaged_object_peek_swapspace ()
StoragedEncrypted *	storaged_object_peek_encrypted ()
StoragedLoop *	storaged_object_peek_loop ()
StoragedManager *	storaged_object_peek_manager ()
StoragedPartition *	storaged_object_peek_partition ()
StoragedPartitionTable *	storaged_object_peek_partition_table ()
StoragedMDRaid *	storaged_object_peek_mdraid ()
StoragedObjectProxy *	storaged_object_proxy_new ()
StoragedObjectSkeleton *	storaged_object_skeleton_new ()
void	storaged_object_skeleton_set_block ()
void	storaged_object_skeleton_set_drive ()
void	storaged_object_skeleton_set_drive_ata ()
void	storaged_object_skeleton_set_filesystem ()
void	storaged_object_skeleton_set_job ()
void	storaged_object_skeleton_set_swapspace ()
void	storaged_object_skeleton_set_encrypted ()
void	storaged_object_skeleton_set_loop ()
void	storaged_object_skeleton_set_manager ()
void	storaged_object_skeleton_set_partition ()
void	storaged_object_skeleton_set_partition_table ()
void	storaged_object_skeleton_set_mdraid ()

Properties

StoragedBlock *	block	Read / Write
StoragedDrive *	drive	Read / Write
StoragedDriveAta *	drive-ata	Read / Write
StoragedEncrypted *	encrypted	Read / Write
StoragedFilesystem *	filesystem	Read / Write
StoragedJob *	job	Read / Write
StoragedLoop *	loop	Read / Write
StoragedManager *	manager	Read / Write
StoragedMDRaid *	mdraid	Read / Write
StoragedPartition *	partition	Read / Write
StoragedPartitionTable *	partition-table	Read / Write
StoragedSwapspace *	swapspace	Read / Write

Types and Values

	StoragedObject
struct	StoragedObjectIface
struct	StoragedObjectProxy
struct	StoragedObjectProxyClass
struct	StoragedObjectSkeleton
struct	StoragedObjectSkeletonClass

Object Hierarchy

    GInterface
    ╰── StoragedObject
    GObject
    ├── GDBusObjectProxy
    │   ╰── StoragedObjectProxy
    ╰── GDBusObjectSkeleton
        ╰── StoragedObjectSkeleton
            ├── StoragedLinuxBlockObject
            ├── StoragedLinuxDriveObject
            ╰── StoragedLinuxMDRaidObject

Prerequisites

StoragedObject requires GDBusObject and GObject.

Implemented Interfaces

StoragedObjectProxy implements GDBusObject and StoragedObject.

StoragedObjectSkeleton implements GDBusObject and StoragedObject.

Known Implementations

StoragedObject is implemented by StoragedLinuxBlockObject, StoragedLinuxDriveObject, StoragedLinuxMDRaidObject, StoragedObjectProxy and StoragedObjectSkeleton.

Description

This section contains the StoragedObject, StoragedObjectProxy, and StoragedObjectSkeleton types which make it easier to work with objects implementing generated types for D-Bus interfaces.

Functions

storaged_object_get_block ()

StoragedBlock *
storaged_object_get_block (StoragedObject *object);

Gets the StoragedBlock instance for the D-Bus interface org.storaged.Storaged.Block on object , if any.

Parameters

object

A StoragedObject.

Returns

A StoragedBlock that must be freed with g_object_unref() or NULL if object does not implement the interface.

[transfer full]

storaged_object_get_drive ()

StoragedDrive *
storaged_object_get_drive (StoragedObject *object);

Gets the StoragedDrive instance for the D-Bus interface org.storaged.Storaged.Drive on object , if any.

Parameters

object

A StoragedObject.

Returns

A StoragedDrive that must be freed with g_object_unref() or NULL if object does not implement the interface.

[transfer full]

storaged_object_get_drive_ata ()

StoragedDriveAta *
storaged_object_get_drive_ata (StoragedObject *object);

Gets the StoragedDriveAta instance for the D-Bus interface org.storaged.Storaged.Drive.Ata on object , if any.

Parameters

object

A StoragedObject.

Returns

A StoragedDriveAta that must be freed with g_object_unref() or NULL if object does not implement the interface.

[transfer full]

storaged_object_get_filesystem ()

StoragedFilesystem *
storaged_object_get_filesystem (StoragedObject *object);

Gets the StoragedFilesystem instance for the D-Bus interface org.storaged.Storaged.Filesystem on object , if any.

Parameters

object

A StoragedObject.

Returns

A StoragedFilesystem that must be freed with g_object_unref() or NULL if object does not implement the interface.

[transfer full]

storaged_object_get_job ()

StoragedJob *
storaged_object_get_job (StoragedObject *object);

Gets the StoragedJob instance for the D-Bus interface org.storaged.Storaged.Job on object , if any.

Parameters

object

A StoragedObject.

Returns

A StoragedJob that must be freed with g_object_unref() or NULL if object does not implement the interface.

[transfer full]

storaged_object_get_swapspace ()

StoragedSwapspace *
storaged_object_get_swapspace (StoragedObject *object);

Gets the StoragedSwapspace instance for the D-Bus interface org.storaged.Storaged.Swapspace on object , if any.

Parameters

object

A StoragedObject.

Returns

A StoragedSwapspace that must be freed with g_object_unref() or NULL if object does not implement the interface.

[transfer full]

storaged_object_get_encrypted ()

StoragedEncrypted *
storaged_object_get_encrypted (StoragedObject *object);

Gets the StoragedEncrypted instance for the D-Bus interface org.storaged.Storaged.Encrypted on object , if any.

Parameters

object

A StoragedObject.

Returns

A StoragedEncrypted that must be freed with g_object_unref() or NULL if object does not implement the interface.

[transfer full]

storaged_object_get_loop ()

StoragedLoop *
storaged_object_get_loop (StoragedObject *object);

Gets the StoragedLoop instance for the D-Bus interface org.storaged.Storaged.Loop on object , if any.

Parameters

object

A StoragedObject.

Returns

A StoragedLoop that must be freed with g_object_unref() or NULL if object does not implement the interface.

[transfer full]

storaged_object_get_manager ()

StoragedManager *
storaged_object_get_manager (StoragedObject *object);

Gets the StoragedManager instance for the D-Bus interface org.storaged.Storaged.Manager on object , if any.

Parameters

object

A StoragedObject.

Returns

A StoragedManager that must be freed with g_object_unref() or NULL if object does not implement the interface.

[transfer full]

storaged_object_get_partition ()

StoragedPartition *
storaged_object_get_partition (StoragedObject *object);

Gets the StoragedPartition instance for the D-Bus interface org.storaged.Storaged.Partition on object , if any.

Parameters

object

A StoragedObject.

Returns

A StoragedPartition that must be freed with g_object_unref() or NULL if object does not implement the interface.

[transfer full]

storaged_object_get_partition_table ()

StoragedPartitionTable *
storaged_object_get_partition_table (StoragedObject *object);

Gets the StoragedPartitionTable instance for the D-Bus interface org.storaged.Storaged.PartitionTable on object , if any.

Parameters

object

A StoragedObject.

Returns

A StoragedPartitionTable that must be freed with g_object_unref() or NULL if object does not implement the interface.

[transfer full]

storaged_object_get_mdraid ()

StoragedMDRaid *
storaged_object_get_mdraid (StoragedObject *object);

Gets the StoragedMDRaid instance for the D-Bus interface org.storaged.Storaged.MDRaid on object , if any.

Parameters

object

A StoragedObject.

Returns

A StoragedMDRaid that must be freed with g_object_unref() or NULL if object does not implement the interface.

[transfer full]

Since: 2.0.0

storaged_object_peek_block ()

StoragedBlock *
storaged_object_peek_block (StoragedObject *object);

Like storaged_object_get_block() but doesn't increase the reference count on the returned object.

It is not safe to use the returned object if you are on another thread than the one where the GDBusObjectManagerClient or GDBusObjectManagerServer for object is running.

[skip]

Parameters

object

A StoragedObject.

Returns

A StoragedBlock or NULL if object does not implement the interface. Do not free the returned object, it is owned by object .

[transfer none]

storaged_object_peek_drive ()

StoragedDrive *
storaged_object_peek_drive (StoragedObject *object);

Like storaged_object_get_drive() but doesn't increase the reference count on the returned object.

It is not safe to use the returned object if you are on another thread than the one where the GDBusObjectManagerClient or GDBusObjectManagerServer for object is running.

[skip]

Parameters

object

A StoragedObject.

Returns

A StoragedDrive or NULL if object does not implement the interface. Do not free the returned object, it is owned by object .

[transfer none]

storaged_object_peek_drive_ata ()

StoragedDriveAta *
storaged_object_peek_drive_ata (StoragedObject *object);

Like storaged_object_get_drive_ata() but doesn't increase the reference count on the returned object.

It is not safe to use the returned object if you are on another thread than the one where the GDBusObjectManagerClient or GDBusObjectManagerServer for object is running.

[skip]

Parameters

object

A StoragedObject.

Returns

A StoragedDriveAta or NULL if object does not implement the interface. Do not free the returned object, it is owned by object .

[transfer none]

storaged_object_peek_filesystem ()

StoragedFilesystem *
storaged_object_peek_filesystem (StoragedObject *object);

Like storaged_object_get_filesystem() but doesn't increase the reference count on the returned object.

It is not safe to use the returned object if you are on another thread than the one where the GDBusObjectManagerClient or GDBusObjectManagerServer for object is running.

[skip]

Parameters

object

A StoragedObject.

Returns

A StoragedFilesystem or NULL if object does not implement the interface. Do not free the returned object, it is owned by object .

[transfer none]

storaged_object_peek_job ()

StoragedJob *
storaged_object_peek_job (StoragedObject *object);

Like storaged_object_get_job() but doesn't increase the reference count on the returned object.

It is not safe to use the returned object if you are on another thread than the one where the GDBusObjectManagerClient or GDBusObjectManagerServer for object is running.

[skip]

Parameters

object

A StoragedObject.

Returns

A StoragedJob or NULL if object does not implement the interface. Do not free the returned object, it is owned by object .

[transfer none]

storaged_object_peek_swapspace ()

StoragedSwapspace *
storaged_object_peek_swapspace (StoragedObject *object);

Like storaged_object_get_swapspace() but doesn't increase the reference count on the returned object.

It is not safe to use the returned object if you are on another thread than the one where the GDBusObjectManagerClient or GDBusObjectManagerServer for object is running.

[skip]

Parameters

object

A StoragedObject.

Returns

A StoragedSwapspace or NULL if object does not implement the interface. Do not free the returned object, it is owned by object .

[transfer none]

storaged_object_peek_encrypted ()

StoragedEncrypted *
storaged_object_peek_encrypted (StoragedObject *object);

Like storaged_object_get_encrypted() but doesn't increase the reference count on the returned object.

It is not safe to use the returned object if you are on another thread than the one where the GDBusObjectManagerClient or GDBusObjectManagerServer for object is running.

[skip]

Parameters

object

A StoragedObject.

Returns

A StoragedEncrypted or NULL if object does not implement the interface. Do not free the returned object, it is owned by object .

[transfer none]

storaged_object_peek_loop ()

StoragedLoop *
storaged_object_peek_loop (StoragedObject *object);

Like storaged_object_get_loop() but doesn't increase the reference count on the returned object.

It is not safe to use the returned object if you are on another thread than the one where the GDBusObjectManagerClient or GDBusObjectManagerServer for object is running.

[skip]

Parameters

object

A StoragedObject.

Returns

A StoragedLoop or NULL if object does not implement the interface. Do not free the returned object, it is owned by object .

[transfer none]

storaged_object_peek_manager ()

StoragedManager *
storaged_object_peek_manager (StoragedObject *object);

Like storaged_object_get_manager() but doesn't increase the reference count on the returned object.

It is not safe to use the returned object if you are on another thread than the one where the GDBusObjectManagerClient or GDBusObjectManagerServer for object is running.

[skip]

Parameters

object

A StoragedObject.

Returns

A StoragedManager or NULL if object does not implement the interface. Do not free the returned object, it is owned by object .

[transfer none]

storaged_object_peek_partition ()

StoragedPartition *
storaged_object_peek_partition (StoragedObject *object);

Like storaged_object_get_partition() but doesn't increase the reference count on the returned object.

It is not safe to use the returned object if you are on another thread than the one where the GDBusObjectManagerClient or GDBusObjectManagerServer for object is running.

[skip]

Parameters

object

A StoragedObject.

Returns

A StoragedPartition or NULL if object does not implement the interface. Do not free the returned object, it is owned by object .

[transfer none]

storaged_object_peek_partition_table ()

StoragedPartitionTable *
storaged_object_peek_partition_table (StoragedObject *object);

Like storaged_object_get_partition_table() but doesn't increase the reference count on the returned object.

It is not safe to use the returned object if you are on another thread than the one where the GDBusObjectManagerClient or GDBusObjectManagerServer for object is running.

[skip]

Parameters

object

A StoragedObject.

Returns

A StoragedPartitionTable or NULL if object does not implement the interface. Do not free the returned object, it is owned by object .

[transfer none]

storaged_object_peek_mdraid ()

StoragedMDRaid *
storaged_object_peek_mdraid (StoragedObject *object);

Like storaged_object_get_mdraid() but doesn't increase the reference count on the returned object.

It is not safe to use the returned object if you are on another thread than the one where the GDBusObjectManagerClient or GDBusObjectManagerServer for object is running.

[skip]

Parameters

object

A StoragedObject.

Returns

A StoragedMDRaid or NULL if object does not implement the interface. Do not free the returned object, it is owned by object .

[transfer none]

Since: 2.0.0

storaged_object_proxy_new ()

StoragedObjectProxy *
storaged_object_proxy_new (GDBusConnection *connection,
                           const gchar *object_path);

Creates a new proxy object.

Parameters

connection	A GDBusConnection.
object_path	An object path.

Returns

The proxy object.

[transfer full]

storaged_object_skeleton_new ()

StoragedObjectSkeleton *
storaged_object_skeleton_new (const gchar *object_path);

Creates a new skeleton object.

Parameters

object_path

An object path.

Returns

The skeleton object.

[transfer full]

storaged_object_skeleton_set_block ()

void
storaged_object_skeleton_set_block (StoragedObjectSkeleton *object,
                                    StoragedBlock *interface_);

Sets the StoragedBlock instance for the D-Bus interface org.storaged.Storaged.Block on object .

Parameters

object	A StoragedObjectSkeleton.
interface_	A StoragedBlock or `NULL` to clear the interface.	[allow-none]

storaged_object_skeleton_set_drive ()

void
storaged_object_skeleton_set_drive (StoragedObjectSkeleton *object,
                                    StoragedDrive *interface_);

Sets the StoragedDrive instance for the D-Bus interface org.storaged.Storaged.Drive on object .

Parameters

object	A StoragedObjectSkeleton.
interface_	A StoragedDrive or `NULL` to clear the interface.	[allow-none]

storaged_object_skeleton_set_drive_ata ()

void
storaged_object_skeleton_set_drive_ata
                               (StoragedObjectSkeleton *object,
                                StoragedDriveAta *interface_);

Sets the StoragedDriveAta instance for the D-Bus interface org.storaged.Storaged.Drive.Ata on object .

Parameters

object	A StoragedObjectSkeleton.
interface_	A StoragedDriveAta or `NULL` to clear the interface.	[allow-none]

storaged_object_skeleton_set_filesystem ()

void
storaged_object_skeleton_set_filesystem
                               (StoragedObjectSkeleton *object,
                                StoragedFilesystem *interface_);

Sets the StoragedFilesystem instance for the D-Bus interface org.storaged.Storaged.Filesystem on object .

Parameters

object	A StoragedObjectSkeleton.
interface_	A StoragedFilesystem or `NULL` to clear the interface.	[allow-none]

storaged_object_skeleton_set_job ()

void
storaged_object_skeleton_set_job (StoragedObjectSkeleton *object,
                                  StoragedJob *interface_);

Sets the StoragedJob instance for the D-Bus interface org.storaged.Storaged.Job on object .

Parameters

object	A StoragedObjectSkeleton.
interface_	A StoragedJob or `NULL` to clear the interface.	[allow-none]

storaged_object_skeleton_set_swapspace ()

void
storaged_object_skeleton_set_swapspace
                               (StoragedObjectSkeleton *object,
                                StoragedSwapspace *interface_);

Sets the StoragedSwapspace instance for the D-Bus interface org.storaged.Storaged.Swapspace on object .

Parameters

object	A StoragedObjectSkeleton.
interface_	A StoragedSwapspace or `NULL` to clear the interface.	[allow-none]

storaged_object_skeleton_set_encrypted ()

void
storaged_object_skeleton_set_encrypted
                               (StoragedObjectSkeleton *object,
                                StoragedEncrypted *interface_);

Sets the StoragedEncrypted instance for the D-Bus interface org.storaged.Storaged.Encrypted on object .

Parameters

object	A StoragedObjectSkeleton.
interface_	A StoragedEncrypted or `NULL` to clear the interface.	[allow-none]

storaged_object_skeleton_set_loop ()

void
storaged_object_skeleton_set_loop (StoragedObjectSkeleton *object,
                                   StoragedLoop *interface_);

Sets the StoragedLoop instance for the D-Bus interface org.storaged.Storaged.Loop on object .

Parameters

object	A StoragedObjectSkeleton.
interface_	A StoragedLoop or `NULL` to clear the interface.	[allow-none]

storaged_object_skeleton_set_manager ()

void
storaged_object_skeleton_set_manager (StoragedObjectSkeleton *object,
                                      StoragedManager *interface_);

Sets the StoragedManager instance for the D-Bus interface org.storaged.Storaged.Manager on object .

Parameters

object	A StoragedObjectSkeleton.
interface_	A StoragedManager or `NULL` to clear the interface.	[allow-none]

storaged_object_skeleton_set_partition ()

void
storaged_object_skeleton_set_partition
                               (StoragedObjectSkeleton *object,
                                StoragedPartition *interface_);

Sets the StoragedPartition instance for the D-Bus interface org.storaged.Storaged.Partition on object .

Parameters

object	A StoragedObjectSkeleton.
interface_	A StoragedPartition or `NULL` to clear the interface.	[allow-none]

storaged_object_skeleton_set_partition_table ()

void
storaged_object_skeleton_set_partition_table
                               (StoragedObjectSkeleton *object,
                                StoragedPartitionTable *interface_);

Sets the StoragedPartitionTable instance for the D-Bus interface org.storaged.Storaged.PartitionTable on object .

Parameters

object	A StoragedObjectSkeleton.
interface_	A StoragedPartitionTable or `NULL` to clear the interface.	[allow-none]

storaged_object_skeleton_set_mdraid ()

void
storaged_object_skeleton_set_mdraid (StoragedObjectSkeleton *object,
                                     StoragedMDRaid *interface_);

Sets the StoragedMDRaid instance for the D-Bus interface org.storaged.Storaged.MDRaid on object .

Parameters

object	A StoragedObjectSkeleton.
interface_	A StoragedMDRaid or `NULL` to clear the interface.	[allow-none]

Since: 2.0.0

Types and Values

StoragedObject

typedef struct _StoragedObject StoragedObject;

The StoragedObject type is a specialized container of interfaces.

struct StoragedObjectIface

struct StoragedObjectIface {
  GTypeInterface parent_iface;
};

Virtual table for the StoragedObject interface.

Members

GTypeInterface parent_iface;

The parent interface.

struct StoragedObjectProxy

struct StoragedObjectProxy;

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

struct StoragedObjectProxyClass

struct StoragedObjectProxyClass {
  GDBusObjectProxyClass parent_class;
};

Class structure for StoragedObjectProxy.

Members

struct StoragedObjectSkeleton

struct StoragedObjectSkeleton;

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

struct StoragedObjectSkeletonClass

struct StoragedObjectSkeletonClass {
  GDBusObjectSkeletonClass parent_class;
};

Class structure for StoragedObjectSkeleton.

Members

Property Details

The `“block”` property

  “block”                    StoragedBlock *

The StoragedBlock instance corresponding to the D-Bus interface org.storaged.Storaged.Block, if any.

Connect to the “notify” signal to get informed of property changes.

Flags: Read / Write

The `“drive”` property

  “drive”                    StoragedDrive *

The StoragedDrive instance corresponding to the D-Bus interface org.storaged.Storaged.Drive, if any.

Connect to the “notify” signal to get informed of property changes.

Flags: Read / Write

The `“drive-ata”` property

  “drive-ata”                StoragedDriveAta *

The StoragedDriveAta instance corresponding to the D-Bus interface org.storaged.Storaged.Drive.Ata, if any.

Connect to the “notify” signal to get informed of property changes.

Flags: Read / Write

The `“encrypted”` property

  “encrypted”                StoragedEncrypted *

The StoragedEncrypted instance corresponding to the D-Bus interface org.storaged.Storaged.Encrypted, if any.

Connect to the “notify” signal to get informed of property changes.

Flags: Read / Write

The `“filesystem”` property

  “filesystem”               StoragedFilesystem *

The StoragedFilesystem instance corresponding to the D-Bus interface org.storaged.Storaged.Filesystem, if any.

Connect to the “notify” signal to get informed of property changes.

Flags: Read / Write

The `“job”` property

  “job”                      StoragedJob *

The StoragedJob instance corresponding to the D-Bus interface org.storaged.Storaged.Job, if any.

Connect to the “notify” signal to get informed of property changes.

Flags: Read / Write

The `“loop”` property

  “loop”                     StoragedLoop *

The StoragedLoop instance corresponding to the D-Bus interface org.storaged.Storaged.Loop, if any.

Connect to the “notify” signal to get informed of property changes.

Flags: Read / Write

The `“manager”` property

  “manager”                  StoragedManager *

The StoragedManager instance corresponding to the D-Bus interface org.storaged.Storaged.Manager, if any.

Connect to the “notify” signal to get informed of property changes.

Flags: Read / Write

The `“mdraid”` property

  “mdraid”                   StoragedMDRaid *

The StoragedMDRaid instance corresponding to the D-Bus interface org.storaged.Storaged.MDRaid, if any.

Connect to the “notify” signal to get informed of property changes.

Flags: Read / Write

Since: 2.0.0

The `“partition”` property

  “partition”                StoragedPartition *

The StoragedPartition instance corresponding to the D-Bus interface org.storaged.Storaged.Partition, if any.

Connect to the “notify” signal to get informed of property changes.

Flags: Read / Write

The `“partition-table”` property

  “partition-table”          StoragedPartitionTable *

The StoragedPartitionTable instance corresponding to the D-Bus interface org.storaged.Storaged.PartitionTable, if any.

Connect to the “notify” signal to get informed of property changes.

Flags: Read / Write

The `“swapspace”` property

  “swapspace”                StoragedSwapspace *

The StoragedSwapspace instance corresponding to the D-Bus interface org.storaged.Storaged.Swapspace, if any.

Connect to the “notify” signal to get informed of property changes.

Flags: Read / Write