SqshArchive Struct Reference

#include <sqsh_archive_private.h>

Public Member Functions
SQSH_NO_UNUSED struct SqshArchive *	sqsh_archive_open (const void *source, const struct SqshConfig *config, int *err)
	initializes a archive context in heap.
const struct SqshConfig *	sqsh_archive_config (const struct SqshArchive *archive)
	sqsh_superblock returns the configuration object of the archive context.
const struct SqshSuperblock *	sqsh_archive_superblock (const struct SqshArchive *archive)
	sqsh_superblock returns the superblock context.
struct SqshMapManager *	sqsh_archive_map_manager (struct SqshArchive *archive)
	sqsh_mapper returns the map manager to retrieve chunks of the archive file.
SQSH_NO_UNUSED int	sqsh_archive_id_table (struct SqshArchive *archive, struct SqshIdTable **id_table)
	Retrieves the id table of a Sqsh instance.
SQSH_NO_UNUSED int	sqsh_archive_inode_map (struct SqshArchive *archive, struct SqshInodeMap **inode_map)
	Retrieves the export table of a Sqsh instance.
SQSH_NO_UNUSED int	sqsh_archive_export_table (struct SqshArchive *archive, struct SqshExportTable **export_table)
	Retrieves the export table of a Sqsh instance.
SQSH_NO_UNUSED int	sqsh_archive_fragment_table (struct SqshArchive *archive, struct SqshFragmentTable **fragment_table)
	Retrieves the fragment table of a Sqsh instance.
SQSH_NO_UNUSED int	sqsh_archive_xattr_table (struct SqshArchive *archive, struct SqshXattrTable **xattr_table)
	Retrieves the xattr table of a Sqsh instance.
int	sqsh_archive_close (struct SqshArchive *archive)
	Frees the resources used by a Sqsh instance.

Detailed Description

Definition at line 226 of file sqsh_archive_private.h.

Member Function Documentation

sqsh_archive_close()

int sqsh_archive_close

(

struct SqshArchive *

archive

)

Frees the resources used by a Sqsh instance.

Parameters

[in]

archive

The Sqsh instance to free.

Returns

0 on success, a negative value on error.

sqsh_archive_config()

const struct SqshConfig * sqsh_archive_config

(

const struct SqshArchive *

archive

)

sqsh_superblock returns the configuration object of the archive context.

Parameters

[in]

archive

the SqshArchive structure.

Returns

the superblock context.

sqsh_archive_export_table()

SQSH_NO_UNUSED int sqsh_archive_export_table	(	struct SqshArchive *	archive,
		struct SqshExportTable **	export_table )

Retrieves the export table of a Sqsh instance.

Parameters

[in]	archive	The Sqsh instance to retrieve the export table from.
[out]	export_table	Pointer to a struct SqshTable where the export table will be stored.

Returns

0 on success, a negative value on error.

sqsh_archive_fragment_table()

SQSH_NO_UNUSED int sqsh_archive_fragment_table	(	struct SqshArchive *	archive,
		struct SqshFragmentTable **	fragment_table )

Retrieves the fragment table of a Sqsh instance.

Parameters

[in]	archive	The Sqsh instance to retrieve the fragment table from.
[out]	fragment_table	Pointer to a struct SqshTable where the export table will be stored.

Returns

0 on success, a negative value on error.

sqsh_archive_id_table()

SQSH_NO_UNUSED int sqsh_archive_id_table	(	struct SqshArchive *	archive,
		struct SqshIdTable **	id_table )

Retrieves the id table of a Sqsh instance.

Parameters

[in]	archive	The Sqsh instance to retrieve the id table from.
[out]	id_table	Pointer to a struct SqshTable where the id table will be stored.

Returns

0 on success, a negative value on error.

sqsh_archive_inode_map()

SQSH_NO_UNUSED int sqsh_archive_inode_map	(	struct SqshArchive *	archive,
		struct SqshInodeMap **	inode_map )

Retrieves the export table of a Sqsh instance.

Parameters

[in]	archive	The Sqsh instance to retrieve the inode cache from.
[out]	inode_map	Pointer to a struct SqshInodeMap where the inode cache will be stored.

Returns

0 on success, a negative value on error.

sqsh_archive_map_manager()

struct SqshMapManager * sqsh_archive_map_manager

(

struct SqshArchive *

archive

)

sqsh_mapper returns the map manager to retrieve chunks of the archive file.

Parameters

[in]

archive

the Sqsh structure.

Returns

the mapper context.

sqsh_archive_open()

SQSH_NO_UNUSED struct SqshArchive * sqsh_archive_open	(	const void *	source,
		const struct SqshConfig *	config,
		int *	err )

initializes a archive context in heap.

Parameters

[in]	source	the source to retrieve the archive from
[in]	config	the configuration for the archive context.
[out]	err	Pointer to an int where the error code will be stored.

Returns

a pointer to the archive context or NULL if an error occurred.

sqsh_archive_superblock()

const struct SqshSuperblock * sqsh_archive_superblock

(

const struct SqshArchive *

archive

)

sqsh_superblock returns the superblock context.

Parameters

[in]

archive

the Sqsh structure.

Returns

the superblock context.

sqsh_archive_xattr_table()

SQSH_NO_UNUSED int sqsh_archive_xattr_table	(	struct SqshArchive *	archive,
		struct SqshXattrTable **	xattr_table )

Retrieves the xattr table of a Sqsh instance.

Parameters

[in]	archive	The Sqsh instance to retrieve the xattr table from.
[out]	xattr_table	Pointer to a struct SqshTable where the export table will be stored.

Returns

0 on success, a negative value on error.

---

The documentation for this struct was generated from the following files:

• libsqsh/include/sqsh_archive_private.h
• include/sqsh_archive.h