Go to main content

man pages section 3: Extended Library Functions, Volume 3

Exit Print View

Updated: Thursday, June 13, 2019
 
 

pool_component_to_elem(3POOL)

Name

pool_component_to_elem, pool_to_elem, pool_conf_to_elem, pool_resource_to_elem - resource pool element-related functions

Synopsis

cc [ flag… ] file–lpool [ library… ] 
#include <pool.h>

pool_elem_t *pool_component_to_elem(pool_conf_t *conf,
     pool_component_t *component);
pool_elem_t *pool_conf_to_elem(pool_conf_t *conf);
pool_elem_t *pool_resource_to_elem(pool_conf_t *conf, 
      pool_resource_t *resource);
pool_elem_t *pool_to_elem(pool_conf_t *conf, pool_t *pool);

Description

A pool element, as represented by a pool_elem_t, is a common abstraction for any libpool entity that contains properties. All such types can be converted to the opaque pool_elem_t type using the appropriate conversion functions prototyped above. The conf argument for each function refers to the target configuration to which the operation applies.

The global system properties are represented by a pool_conf_t pointer.

All pools are represented by a pool_t pointer.

All psets are represented by a pool_resource_t pointer.

All cpus are represented by a pool_component_t pointer.

All of the above can be converted to pool_elem_t * objects for property manipulation using these functions.

Return Values

Upon successful completion, these functions return a pool_elem_t corresponding to the argument passed in. Otherwise they return NULL and pool_error(3POOL) returns the pool-specific error value.

Errors

These function will fail if:

POE_BADPARAM

The supplied configuration's status is not POF_VALID.

Attributes

See attributes(7) for descriptions of the following attributes:

ATTRIBUTE TYPE
ATTRIBUTE VALUE
CSI
Enabled
Interface Stability
Uncommitted
MT-Level
Safe

See Also

libpool(3LIB), pool_error(3POOL), attributes(7)