This section lists all of the resource pool functions. Each function has a
link to the man page and a short description of the function's
purpose. The functions are divided into two groups, depending on whether the function performs
an action or a query:
The imported interfaces for libpool for swap sets is identical to the ones
defined in this document.
The interfaces listed in this section are for performing actions related to pools
and the associated elements.
- pool_associate(3POOL)
Associate a resource with a specified pool.
- pool_component_to_elem(3POOL)
Convert specified component to the pool element type.
- pool_conf_alloc(3POOL)
Create a pool configuration.
- pool_conf_close(3POOL)
Close the specified pool configuration and release the associated resources.
- pool_conf_commit(3POOL)
Commit changes made to the specified pool configuration to permanent storage.
- pool_conf_export(3POOL)
Save the given configuration to the specified location.
- pool_conf_free(3POOL)
Release a pool configuration.
- pool_conf_open(3POOL)
Create a pool configuration at the specified location.
- pool_conf_remove(3POOL)
Removes the permanent storage for the configuration.
- pool_conf_rollback(3POOL)
Restore the configuration state to the state that is held in the pool configuration's permanent storage.
- pool_conf_to_elem(3POOL)
Convert specified pool configuration to the pool element type.
- pool_conf_update(3POOL)
Update the library snapshot of kernel state.
- pool_create(3POOL)
Create a new pool with the default properties and with default resources for each type.
- pool_destroy(3POOL)
Destroy the specified pool. The associated resources are not modified.
- pool_dissociate(3POOL)
Remove the association between the given resource and pool.
- pool_put_property(3POOL)
Set the named property on the element to the specified value.
- pool_resource_create(3POOL)
Create a new resource with the specified name and type for the provided configuration.
- pool_resource_destroy(3POOL)
Remove the specified resource from the configuration file.
- pool_resource_to_elem(3POOL)
Convert specified pool resource to the pool element type.
- pool_resource_transfer(3POOL)
Transfer basic units from the source resource to the target resource.
- pool_resource_xtransfer(3POOL)
Transfer the specified components from the source resource to the target resource.
- pool_rm_property(3POOL)
Remove the named property from the element.
- pool_set_binding(3POOL)
Bind the specified processes to the resources that are associated with pool on the running system.
- pool_set_status(3POOL)
Modify the current state of the pools facility.
- pool_to_elem(3POOL)
Convert specified pool to the pool element type.
- pool_value_alloc(3POOL)
Allocate and return an opaque container for a pool property value.
- pool_value_free(3POOL)
Release an allocated property values.
- pool_value_set_bool(3POOL)
Set a property value of type boolean.
- pool_value_set_double(3POOL)
Set a property value of type double.
- pool_value_set_int64(3POOL)
Set a property value of type int64.
- pool_value_set_name(3POOL)
Set a name=value pair for a pool property.
- pool_value_set_string(3POOL)
Copy the string that was passed in.
- pool_value_set_uint64(3POOL)
Set a property value of type uint64.
The interfaces listed in this section are for performing queries related to pools
and the associated elements.
- pool_component_info(3POOL)
Return a string that describes the given component.
- pool_conf_info(3POOL)
Return a string describing the entire configuration.
- pool_conf_location(3POOL)
Return the location string that was provided to pool_conf_open() for the given specified configuration.
- pool_conf_status(3POOL)
Return the validity status for a pool configuration.
- pool_conf_validate(3POOL)
Check the validity of the contents of the given configuration.
- pool_dynamic_location(3POOL)
Return the location that was used by the pools framework to store the dynamic configuration.
- pool_error(3POOL)
Return the error value of the last failure that was recorded by calling a resource pool configuration library function.
- pool_get_binding(3POOL)
Return the name of the pool on the running system that contains the set of resources to which the specified process is bound.
- pool_get_owning_resource(3POOL)
Return the resource that currently contains the specified component.
- pool_get_pool(3POOL)
Return the pool with the specified name from the provided configuration.
- pool_get_property(3POOL)
Retrieve the value of the named property from the element.
- pool_get_resource(3POOL)
Return the resource with the given name and type from the provided configuration.
- pool_get_resource_binding(3POOL)
Return the name of the pool on the running system that contains the set of resources to which the given process is bound.
- pool_get_status(3POOL)
Retrieve the current state of the pools facility.
- pool_info(3POOL)
Return a description of the specified pool.
- pool_query_components(3POOL)
Retrieve all resource components that match the specified list of properties.
- pool_query_pool_resources(3POOL)
Return a null-terminated array of resources currently associated with the pool.
- pool_query_pools(3POOL)
Return the list of pools that match the specified list of properties.
- pool_query_resource_components(3POOL)
Return a null-terminated array of the components that make up the specified resource.
- pool_query_resources(3POOL)
Return the list of resources that match the specified list of properties.
- pool_resource_info(3POOL)
Return a description of the specified resource.
- pool_resource_type_list(3POOL)
Enumerate the resource types that are supported by the pools framework on this platform.
- pool_static_location(3POOL)
Return the location that was used by the pools framework to store the default configuration for pools framework instantiation.
- pool_strerror(3POOL)
Return a description of each valid pool error code.
- pool_value_get_bool(3POOL)
Get a property value of type boolean.
- pool_value_get_double(3POOL)
Get a property value of type double.
- pool_value_get_int64(3POOL)
Get a property value of type int64.
- pool_value_get_name(3POOL)
Return the name that was assigned to the specified pool property.
- pool_value_get_string(3POOL)
Get a property value of type string.
- pool_value_get_type(3POOL)
Return the type of the data that is contained by the specified pool value.
- pool_value_get_uint64(3POOL)
Get a property value of type uint64.
- pool_version(3POOL)
Get the version number of the pool library.
- pool_walk_components(3POOL)
Invoke callback on all components that are contained in the resource.
- pool_walk_pools(3POOL)
Invoke callback on all pools that are defined in the configuration.
- pool_walk_properties(3POOL)
Invoke callback on all properties defined for the given element.
- pool_walk_resources(3POOL)
Invoke callback on all resources that are associated with the pool.
