pmempool_feature_query man page

pmempool_feature_query(), pmempool_feature_enable(), pmempool_feature_disable() — toggle or query pool set features

Synopsis

#include <libpmempool.h>

int pmempool_feature_query(const char *path, enum pmempool_feature feature, unsigned flags);

int pmempool_feature_enable(const char *path, enum pmempool_feature feature, unsigned flags);

int pmempool_feature_disable(const char *path, enum pmempool_feature feature, unsigned flags);

Description

The feature argument accepts following values:

The pmempool_feature_query() function checks state of feature in the pool set pointed by path.

The pmempool_feature_enable() function enables feature in the pool set pointed by path.

The pmempool_feature_disable() function disables feature in the pool set pointed by path.

Compatibility

Poolsets with features not defined in this document (e.g. enabled by the newer software version) are not supported.

Disclaimer

pmempool_feature_query(), pmempool_feature_enable() and pmempool_feature_disable() are not fail safe.

Return Value

On success, pmempool_feature_query() returns 0 if feature is disabled or 1 if it is enabled. On error, it returns -1 and sets errno accordingly.

On success, pmempool_feature_enable() returns 0. On error, it returns -1 and sets errno accordingly.

On success, pmempool_feature_disable() returns 0. On error, it returns -1 and sets errno accordingly.

If path points poolset with remote replica errno is set to EINVAL and function returns -1.

If non zero flags are provided errno is set to EINVAL and function returns -1.

See Also

poolset(5) and <http://pmem.io>

Referenced By

libpmempool(7), pmemblk_ctl_get(3), pmemlog_ctl_get(3), pmemobj_ctl_get(3).

The man pages pmempool_feature_disable(3) and pmempool_feature_enable(3) are aliases of pmempool_feature_query(3).

2019-07-10 PMDK - pmempool API version 1.3 PMDK Programmer's Manual