OsinfoTree

OsinfoTree — An installation tree for a (guest) OS

Functions

Properties

gchar * architecture Read / Write
gchar * boot-iso-path Read / Write
gboolean has-treeinfo Read / Write
gchar * initrd-path Read / Write
gchar * kernel-path Read / Write
OsinfoOs * os Read / Write
gchar * treeinfo-arch Read / Write
gchar * treeinfo-family Read / Write
gchar * treeinfo-variant Read / Write
gchar * treeinfo-version Read / Write
gchar * url Read / Write

Types and Values

Object Hierarchy

    GEnum
    ╰── OsinfoTreeError
    GObject
    ╰── OsinfoEntity
        ╰── OsinfoTree

Description

OsinfoTree is an entity representing an installation tree a (guest) operating system.

Functions

osinfo_tree_error_quark ()

GQuark
osinfo_tree_error_quark (void);

Gets a GQuark representing the string "osinfo-tree-error"

Returns

the GQuark representing the string.

Since: 0.1.0


osinfo_tree_new ()

OsinfoTree *
osinfo_tree_new (const gchar *id,
                 const gchar *architecture);

id : the id of the tree to be created architecture : the architecture of the tree to be created

Create a new tree entity

Returns

A tree entity.

[trasfer full]

Since: 0.1.0


osinfo_tree_create_from_location ()

OsinfoTree *
osinfo_tree_create_from_location (const gchar *location,
                                  GCancellable *cancellable,
                                  GError **error);

Creates a new OsinfoTree for installation tree at location . The location could be a http:// or a https:// URI.

NOTE: Currently this only works for trees with a .treeinfo file

Parameters

location

the location of an installation tree

 

cancellable

a GCancellable, or NULL.

[allow-none]

error

The location where to store any error, or NULL

 

Returns

a new OsinfoTree , or NULL on error.

[transfer full]

Since: 0.1.0


osinfo_tree_create_from_location_async ()

void
osinfo_tree_create_from_location_async
                               (const gchar *location,
                                gint priority,
                                GCancellable *cancellable,
                                GAsyncReadyCallback callback,
                                gpointer user_data);

Asynchronous variant of osinfo_tree_create_from_location.

Parameters

location

the location of an installation tree

 

priority

the I/O priority of the request

 

cancellable

a GCancellable, or NULL.

[allow-none]

callback

Function to call when result of this call is ready

 

user_data

The user data to pass to callback , or NULL

 

Since: 0.1.0


osinfo_tree_create_from_location_finish ()

OsinfoTree *
osinfo_tree_create_from_location_finish
                               (GAsyncResult *res,
                                GError **error);

Finishes an asynchronous tree object creation process started with osinfo_tree_create_from_location_async.

Parameters

res

a GAsyncResult

 

error

The location where to store any error, or NULL

 

Returns

a new OsinfoTree , or NULL on error.

[transfer full]

Since: 0.1.0


osinfo_tree_get_architecture ()

const gchar *
osinfo_tree_get_architecture (OsinfoTree *tree);

Retrieves the target hardware architecture of the OS tree provides.

Parameters

tree

an OsinfoTree instance

 

Returns

the hardware architecture, or NULL.

[transfer none]

Since: 0.1.0


osinfo_tree_get_url ()

const gchar *
osinfo_tree_get_url (OsinfoTree *tree);

The URL to the tree

Parameters

tree

an OsinfoTree instance

 

Returns

the URL, or NULL.

[transfer none]


osinfo_tree_has_treeinfo ()

gboolean
osinfo_tree_has_treeinfo (OsinfoTree *tree);

Return whether a tree has treeinfo or not.

Parameters

tree

an OsinfoTree instance

 

Returns

TRUE if the tree has treeinfo. FALSE otherwise.

Since: 1.3.0


osinfo_tree_get_treeinfo_family ()

const gchar *
osinfo_tree_get_treeinfo_family (OsinfoTree *tree);

If tree has treeinfo, this function retrieves the expected family.

Note: In practice, this will usually not be the exact copy of the family but rather a regular expression that matches it.

Parameters

tree

an OsinfoTree instance

 

Returns

the treeinfo family, or NULL.

[transfer none]

Since: 0.1.0


osinfo_tree_get_treeinfo_variant ()

const gchar *
osinfo_tree_get_treeinfo_variant (OsinfoTree *tree);

If tree has treeinfo, this function retrieves the expected variant.

Note: In practice, this will usually not be the exact copy of the variant but rather a regular expression that matches it.

Parameters

tree

an OsinfoTree instance

 

Returns

the treeinfo variant, or NULL.

[transfer none]

Since: 0.1.0


osinfo_tree_get_treeinfo_version ()

const gchar *
osinfo_tree_get_treeinfo_version (OsinfoTree *tree);

If tree has treeinfo, this function retrieves the expected version.

Note: In practice, this will usually not be the exact copy of version but rather a regular expression that matches it.

Parameters

tree

an OsinfoTree instance

 

Returns

the treeinfo version, or NULL.

[transfer none]

Since: 0.1.0


osinfo_tree_get_treeinfo_arch ()

const gchar *
osinfo_tree_get_treeinfo_arch (OsinfoTree *tree);

If tree has treeinfo, this function retrieves the expected architecture.

Note: In practice, this will usually not be the exact copy of the architecture but rather a regular expression that matches it.

Parameters

tree

an OsinfoTree instance

 

Returns

the treeinfo architecture, or NULL.

[transfer none]

Since: 0.1.0


osinfo_tree_get_boot_iso_path ()

const gchar *
osinfo_tree_get_boot_iso_path (OsinfoTree *tree);

Retrieves the path to the boot_iso image in the install tree.

Parameters

tree

an OsinfoTree instance

 

Returns

the path to boot_iso image, or NULL.

[transfer none]

Since: 0.1.0


osinfo_tree_get_kernel_path ()

const gchar *
osinfo_tree_get_kernel_path (OsinfoTree *tree);

Retrieves the path to the kernel image in the install tree.

Note: This only applies to installer trees of 'linux' OS family.

Parameters

tree

an OsinfoTree instance

 

Returns

the path to kernel image, or NULL.

[transfer none]

Since: 0.1.0


osinfo_tree_get_initrd_path ()

const gchar *
osinfo_tree_get_initrd_path (OsinfoTree *tree);

Retrieves the path to the initrd image in the install tree.

Note: This only applies to installer trees of 'linux' OS family.

Parameters

tree

an OsinfoTree instance

 

Returns

the path to initrd image, or NULL.

[transfer none]

Since: 0.1.0


osinfo_tree_get_os ()

OsinfoOs *
osinfo_tree_get_os (OsinfoTree *tree);

Parameters

tree

an OsinfoTree instance

 

Returns

the operating system, or NULL.

[transfer full]

Since: 1.5.0


osinfo_tree_set_os ()

void
osinfo_tree_set_os (OsinfoTree *tree,
                    OsinfoOs *os);

Sets the OsinfoOs associated to the OsinfoTree instance.

Parameters

tree

an OsinfoTree instance

 

os

an OsinfoOs instance

 

Since: 1.5.0


osinfo_tree_get_os_variants ()

OsinfoOsVariantList *
osinfo_tree_get_os_variants (OsinfoTree *tree);

Gets the variants of the associated operating system.

Parameters

tree

an OsinfoTree instance

 

Returns

the operating system variant, or NULL.

[transfer full]

Since: 1.5.0

Types and Values

OSINFO_TREE_ERROR

#define OSINFO_TREE_ERROR (osinfo_tree_error_quark ())

enum OsinfoTreeError

Members

OSINFO_TREE_ERROR_NO_TREEINFO

   

OSINFO_TREE_ERROR_NOT_SUPPORTED_PROTOCOL

   

Since: 1.6.0


OSINFO_TREE_PROP_ARCHITECTURE

#define OSINFO_TREE_PROP_ARCHITECTURE     "architecture"

OSINFO_TREE_PROP_URL

#define OSINFO_TREE_PROP_URL              "url"

OSINFO_TREE_PROP_TREEINFO_FAMILY

#define OSINFO_TREE_PROP_TREEINFO_FAMILY  "treeinfo-family"

OSINFO_TREE_PROP_TREEINFO_VARIANT

#define OSINFO_TREE_PROP_TREEINFO_VARIANT "treeinfo-variant"

OSINFO_TREE_PROP_TREEINFO_VERSION

#define OSINFO_TREE_PROP_TREEINFO_VERSION "treeinfo-version"

OSINFO_TREE_PROP_TREEINFO_ARCH

#define OSINFO_TREE_PROP_TREEINFO_ARCH    "treeinfo-arch"

OSINFO_TREE_PROP_BOOT_ISO

#define OSINFO_TREE_PROP_BOOT_ISO         "boot-iso"

OSINFO_TREE_PROP_KERNEL

#define OSINFO_TREE_PROP_KERNEL           "kernel"

OSINFO_TREE_PROP_INITRD

#define OSINFO_TREE_PROP_INITRD           "initrd"

OSINFO_TREE_PROP_HAS_TREEINFO

#define OSINFO_TREE_PROP_HAS_TREEINFO     "has-treeinfo"

OSINFO_TREE_PROP_VARIANT

#define OSINFO_TREE_PROP_VARIANT          "variant"

Property Details

The “architecture” property

  “architecture”             gchar *

The target hardware architecture of this tree.

Flags: Read / Write

Default value: NULL


The “boot-iso-path” property

  “boot-iso-path”            gchar *

The path to the boot ISO in the install tree

Flags: Read / Write

Default value: NULL


The “has-treeinfo” property

  “has-treeinfo”             gboolean

Whether the tree has treeinfo or not

Flags: Read / Write

Default value: FALSE


The “initrd-path” property

  “initrd-path”              gchar *

The path to the initrd image in the install tree.

Flags: Read / Write

Default value: NULL


The “kernel-path” property

  “kernel-path”              gchar *

The path to the kernel image in the install tree.

Flags: Read / Write

Default value: NULL


The “os” property

  “os”                       OsinfoOs *

Os information for the current tree. For tree stored in an OsinfoDB, it will be filled when the database is loaded, otherwise the property will be filled after a successful call to osinfo_db_identify_tree().

Flags: Read / Write


The “treeinfo-arch” property

  “treeinfo-arch”            gchar *

The treeinfo arch

Flags: Read / Write

Default value: NULL


The “treeinfo-family” property

  “treeinfo-family”          gchar *

The treeinfo family

Flags: Read / Write

Default value: NULL


The “treeinfo-variant” property

  “treeinfo-variant”         gchar *

The treeinfo variant

Flags: Read / Write

Default value: NULL


The “treeinfo-version” property

  “treeinfo-version”         gchar *

The treeinfo version

Flags: Read / Write

Default value: NULL


The “url” property

  “url”                      gchar *

The URL to this tree.

Flags: Read / Write

Default value: NULL

See Also

OsinfoOs