libstoragemgmt_pool.h File Reference

#include "libstoragemgmt_common.h"

Include dependency graph for libstoragemgmt_pool.h:

This graph shows which files directly or indirectly include this file:

Functions
int LSM_DLL_EXPORT	lsm_pool_record_array_free (lsm_pool *pa[], uint32_t size)
int LSM_DLL_EXPORT	lsm_pool_record_free (lsm_pool *p)
lsm_pool LSM_DLL_EXPORT *	lsm_pool_record_copy (lsm_pool *to_be_copied)
char LSM_DLL_EXPORT *	lsm_pool_name_get (lsm_pool *p)
char LSM_DLL_EXPORT *	lsm_pool_id_get (lsm_pool *p)
uint64_t LSM_DLL_EXPORT	lsm_pool_total_space_get (lsm_pool *p)
uint64_t LSM_DLL_EXPORT	lsm_pool_free_space_get (lsm_pool *p)
uint64_t LSM_DLL_EXPORT	lsm_pool_status_get (lsm_pool *s)
const char LSM_DLL_EXPORT *	lsm_pool_status_info_get (lsm_pool *s)
char LSM_DLL_EXPORT *	lsm_pool_system_id_get (lsm_pool *p)
uint64_t LSM_DLL_EXPORT	lsm_pool_element_type_get (lsm_pool *p)
uint64_t LSM_DLL_EXPORT	lsm_pool_unsupported_actions_get (lsm_pool *p)

Function Documentation

uint64_t LSM_DLL_EXPORT lsm_pool_element_type_get ( lsm_pool * p )

Retrieve what the pool can be used to create

Parameters:

p

Pool pointer

Returns:: Usage value

uint64_t LSM_DLL_EXPORT lsm_pool_free_space_get ( lsm_pool * p )

Retrieves the remaining free space in the pool.

Parameters:

p

Pool

Returns:: The amount of free space.

Definition at line 605 of file lsm_datatypes.cpp.

Here is the caller graph for this function:

char LSM_DLL_EXPORT* lsm_pool_id_get ( lsm_pool * p )

Retrieves the system wide unique identifier for the pool. Note: Returned value is only valid as long as p is valid!.

Parameters:

p

Pool

Returns:: The System wide unique identifier.

Definition at line 589 of file lsm_datatypes.cpp.

Here is the caller graph for this function:

char LSM_DLL_EXPORT* lsm_pool_name_get ( lsm_pool * p )

Retrieves the name from the pool. Note: Returned value is only valid as long as p is valid!.

Parameters:

p

Pool

Returns:: The name of the pool.

Here is the caller graph for this function:

int LSM_DLL_EXPORT lsm_pool_record_array_free	(	lsm_pool *	pa[],
		uint32_t	size
	)

Frees the memory for each of the pools and then the pool array itself.

Parameters:

	pa	Pool array to free.
	size	Size of the pool array.

Returns:: LSM_ERR_OK on success, else error reason.

Here is the caller graph for this function:

lsm_pool LSM_DLL_EXPORT* lsm_pool_record_copy ( lsm_pool * to_be_copied )

Copies a lsm_pool record

Parameters:

to_be_copied

Record to be copied

Returns:: NULL on memory exhaustion, else copy.

Definition at line 529 of file lsm_datatypes.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

int LSM_DLL_EXPORT lsm_pool_record_free ( lsm_pool * p )

Frees the memory for an individual pool

Parameters:

p

Valid pool

Returns:: LSM_ERR_OK on success, else error reason.

Definition at line 545 of file lsm_datatypes.cpp.

Here is the caller graph for this function:

uint64_t LSM_DLL_EXPORT lsm_pool_status_get ( lsm_pool * s )

Retrieve the status for the Pool.

Parameters:

s

Pool to retrieve status for

Returns:: Pool status which is a bit sensitive field, returns UINT64_MAX on bad pool pointer.

Definition at line 613 of file lsm_datatypes.cpp.

const char LSM_DLL_EXPORT* lsm_pool_status_info_get ( lsm_pool * s )

Retrieve the status info for the Pool.

Parameters:

s

Pool to retrieve status for

Returns:: Pool status info which is a character string.

Definition at line 621 of file lsm_datatypes.cpp.

char LSM_DLL_EXPORT* lsm_pool_system_id_get ( lsm_pool * p )

Retrieve the system id for the specified pool.

Parameters:

p

Pool pointer

Returns:: System ID

Definition at line 629 of file lsm_datatypes.cpp.

uint64_t LSM_DLL_EXPORT lsm_pool_total_space_get ( lsm_pool * p )

Retrieves the total space for the pool.

Parameters:

p

Pool

Returns:: Total space of the pool.

Definition at line 597 of file lsm_datatypes.cpp.

uint64_t LSM_DLL_EXPORT lsm_pool_unsupported_actions_get ( lsm_pool * p )

Retrieve what the pool cannot be used for.

Parameters:

p

Pool pointer

Returns:: bitmap of actions not supported.

libstoragemgmt_pool.h File Reference

Functions

Function Documentation