All Classes Namespaces Functions Variables Typedefs Enumerations Friends
Public Member Functions | List of all members
ucxx::Config Class Reference

Component encapsulating the UCP configuration. More...

#include <config.h>

Public Member Functions

 Config (const Config &)=delete
 
Configoperator= (Config const &)=delete
 
 Config (Config &&o)=delete
 
Configoperator= (Config &&o)=delete
 
 Config (ConfigMap userOptions)
 Constructor that reads the UCX configuration and apply user options. More...
 
ConfigMap get ()
 Get the configuration map. More...
 
ucp_config_t * getHandle ()
 Get the underlying ucp_config_t* handle. More...
 

Detailed Description

Component encapsulating the UCP configuration.

The UCP layer provides a handle to its configuration in form of ucp_config_t* object, this class encapsulates that object and provides methods to simplify its handling.

Constructor & Destructor Documentation

◆ Config()

ucxx::Config::Config ( ConfigMap  userOptions)
explicit

Constructor that reads the UCX configuration and apply user options.

Read UCX configuration defaults and environment variable modifiers and apply user configurations overriding previously set configurations.

Parameters
[in]userOptionsuser-defined options overriding defaults and environment variable modifiers.

Member Function Documentation

◆ get()

ConfigMap ucxx::Config::get ( )

Get the configuration map.

Get the configuration map with all visible UCP configurations that are in effect for the current process.

Returns
The map to the UCP configurations defined for the process.

◆ getHandle()

ucp_config_t* ucxx::Config::getHandle ( )

Get the underlying ucp_config_t* handle.

Lifetime of the ucp_config_t* handle is managed by the ucxx::Config object and its ownership is non-transferrable. Once the ucxx::Config is destroyed the handle is not valid anymore, it is the user's responsibility to ensure the owner's lifetime while using the handle.

// config is `ucxx::Config`
ucp_config_t* configHandle = config.getHandle();
Returns
The underlying ucp_config_t* handle.

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