Pool Configuration Manipulation Library Functions
pool_associate(3POOL)
NAME
pool_associate, pool_create, pool_destroy, pool_dissociate,
pool_info, pool_query_pool_resources - resource pool manipu-
lation functionsSYNOPSIS
cc [ flag... ] file... -lpool [ library... ]
#include
int pool_associate(pool_conf_t *conf, pool_t *pool,
pool_resource_t *resource);
pool_t *pool_create(pool_conf_t *conf, const char *name);
int pool_destroy(pool_conf_t *conf, pool_t *pool);
int pool_dissociate(pool_conf_t *conf, pool_t *pool,
pool_resource_t *resource);
const char *pool_info(pool_conf_t *conf, pool_t *pool,
int flags);pool_resource_t **pool_query_pool_resources(pool_conf_t *conf,
pool_t *pool, uint_t *nelem, pool_value_t **properties);
DESCRIPTION
These functions provide mechanisms for constructing and modifying pools entries within a target pools configuration. The conf argument for each function refers to the target configuration to which the operation applies.The pool_associate() function associates the specified
resource with pool. A resource can be associated with multi-
ple pools at the same time. Any resource of this type thatwas formerly associated with this pool is no longer associ-
ated with the pool. The new association replaces the earlier one.The pool_create() function creates a new pool with the sup-
plied name with its default properties initialized, and associated with the default resource of each type.SunOS 5.11 Last change: 18 Jul 2005 1
Pool Configuration Manipulation Library Functionspool_associate(3POOL)
The pool_destroy function() destroys the given pool associa-
tion. Associated resources are not modified.The pool_dissociate() function removes the association
between the given resource and pool. On successful comple-
tion, the pool is associated with the default resource of the same type.The pool_info() function returns a string describing the
given pool. The string is allocated with malloc(3C). The caller is reponsible for freeing the returned string. If theflags option is non-zero, the string returned also describes
the associated resources of the pool.The pool_query_pool_resources() function returns a null-
terminated array of resources currently associated with the pool that match the given list of properties. The return value must be freed by the caller. The nelem argument is set to be the length of the array returned.RETURN VALUES
Upon successful completion, pool_create() returns a new ini-
tialized pool. Otherwise it returns NULL andpool_error(3POOL) returns the pool-specific error value.
Upon successful completion, pool_associate(),
pool_destroy(), and pool_dissociate() return 0. Otherwise,
they return -1 and pool_error() returns the pool-specific
error value.Upon successful completion, pool_info() returns a string
describing the given pool. Otherwise it returns NULL andpool_error() returns the pool-specific error value.
Upon successful completion, pool_query_pool_resources()
returns a null-terminated array of resources. Otherwise it
returns NULL and pool_error() returns the pool-specific
error value.ERRORS
The pool_create() function will fail if:
POE_BADPARAM The supplied configuration's status is
not POF_VALID or name is already in use.
SunOS 5.11 Last change: 18 Jul 2005 2
Pool Configuration Manipulation Library Functionspool_associate(3POOL)
POE_SYSTEM A system error has occurred. Check the
system error code for more details.POE_INVALID_CONF The pool element could not be created
because the configuration would be invalid.POE_PUTPROP One of the supplied properties could not
be set.The pool_destroy() function will fail if:
POE_BADPARAM The supplied configuration's status is not
POF_VALID.
The pool_associate() function will fail if:
POE_BADPARAM The supplied configuration's status is not
POF_VALID or the parameters are supplied
from a different configuration.POE_SYSTEM A system error has occurred. Check the sys-
tem error code for more details.The pool_disassociate() function will fail if:
POE_BADPARAM The supplied configuration's status is
not POF_VALID or the parameters are sup-
plied from a different configuration.POE_INVALID_CONF No resources could be located for the
supplied configuration or the supplied configuration is not valid (for example, more than one default for a resource type was found.)POE_SYSTEM A system error has occurred. Check the
system error code for more details.SunOS 5.11 Last change: 18 Jul 2005 3
Pool Configuration Manipulation Library Functionspool_associate(3POOL)
The pool_info() function will fail if:
POE_BADPARAM The supplied configuration's status is
not POF_VALID or the flags paramter is
neither 0 or 1.POE_INVALID_CONF The configuration is invalid.
POE_SYSTEM A system error has occurred. Check the
system error code for more details.The pool_query_pool_resources() function will fail if:
POE_BADPARAM The supplied configuration's status is
not POF_VALID.
POE_INVALID_CONF The configuration is invalid.
POE_SYSTEM A system error has occurred. Check the
system error code for more details.USAGE
Pool names are unique across pools in a given configuration file. It is an error to attempt to create a pool with a namethat is currently used by another pool within the same con-
figuration.ATTRIBUTES
See attributes(5) for descriptions of the following attri-
butes:SunOS 5.11 Last change: 18 Jul 2005 4
Pool Configuration Manipulation Library Functionspool_associate(3POOL)
______________________________________________________________________
| ATTRIBUTE TYPE | ATTRIBUTE VALUE |
|_____________________________|_____________________________|
| CSI | Enabled ||_____________________________|_____________________________|
| Interface Stability | Uncommitted ||_____________________________|_____________________________|
| MT-Level | Safe |
|_____________________________|_____________________________|
SEE ALSO
libpool(3LIB), pool_error(3POOL), attributes(5)
SunOS 5.11 Last change: 18 Jul 2005 5
Pool Configuration Manipulation Library Functionspool_associate(3POOL)
SunOS 5.11 Last change: 18 Jul 2005 6