ucxpp::config Class Reference

Stores UCX configuration options. More...

#include <ucxpp/config.h>

Inheritance diagram for ucxpp::config:

Collaboration diagram for ucxpp::config:

Public Member Functions
	config (char const *env_prefix=nullptr, char const *filename=nullptr)
	Construct a new config object. More...
	~config ()
	Destroy the config object and release memory.
ucp_config_t *	handle () const
	Get the native UCX configuration handle. More...
void	modify (char const *name, char const *value)
	Modify a configuration option. More...
void	print () const
	Print the configuration to the standard output.
Public Member Functions inherited from ucxpp::noncopyable
	noncopyable (noncopyable &&)=default
	noncopyable (noncopyable const &)=delete
noncopyable &	operator= (noncopyable const &)=delete
noncopyable &	operator= (noncopyable &&)=default

Detailed Description

Stores UCX configuration options.

Constructor & Destructor Documentation

config()

ucxpp::config::config	(	char const *	env_prefix = nullptr,
		char const *	filename = nullptr
	)

Construct a new config object.

Parameters

env_prefix	If non-NULL, the routine searches for the environment variables that start with <env_prefix>UCX prefix. Otherwise, the routine searches for the environment variables that start with UCX_ prefix.
filename	If non-NULL, read configuration from the file defined by filename. If the file does not exist, it will be ignored and no error reported to the application.

Member Function Documentation

handle()

ucp_config_t * ucxpp::config::handle

(

)

const

Get the native UCX configuration handle.

Returns

ucp_config_t* The native UCX configuration handle

modify()

void ucxpp::config::modify	(	char const *	name,
		char const *	value
	)

Modify a configuration option.

Parameters

name	The name of the configuration option to modify
value	The new value of the configuration option

---

The documentation for this class was generated from the following files:

• include/ucxpp/config.h
• src/config.cc