CatapultServer  v0.5.0.1 (Elephant)
catapult::config Namespace Reference

Classes

struct  AccountRestrictionConfiguration
 Account restriction plugin configuration settings. More...
 
struct  AggregateConfiguration
 Aggregate plugin configuration settings. More...
 
struct  BasicLoggerConfiguration
 Basic logger configuration settings. More...
 
class  CatapultConfiguration
 Comprehensive configuration for a catapult process. More...
 
class  CatapultDataDirectory
 Catapult data directory. More...
 
class  CatapultDataDirectoryPreparer
 Catapult data directory factory that automatically creates subdirectories. More...
 
class  CatapultDirectory
 Catapult directory. More...
 
struct  ConsoleLoggerConfiguration
 Console logger configuration settings. More...
 
struct  ExtensionsConfiguration
 Extensions configuration settings. More...
 
struct  FileLoggerConfiguration
 File logger configuration settings. More...
 
struct  HashLockConfiguration
 Hash lock plugin configuration settings. More...
 
struct  InflationConfiguration
 Inflation configuration settings. More...
 
struct  LoggingConfiguration
 Logging configuration settings. More...
 
struct  MosaicConfiguration
 Mosaic plugin configuration settings. More...
 
struct  MultisigConfiguration
 Multisig plugin configuration settings. More...
 
struct  NamespaceConfiguration
 Namespace plugin configuration settings. More...
 
struct  NodeConfiguration
 Node configuration settings. More...
 
struct  SecretLockConfiguration
 Secret lock plugin configuration settings. More...
 
struct  TransferConfiguration
 Transfer plugin configuration settings. More...
 
struct  UserConfiguration
 User configuration settings. More...
 

Functions

ionet::Node ToLocalNode (const CatapultConfiguration &config)
 Extracts a node representing the local node from config. More...
 
template<typename TConfigurationLoader , typename TConfiguration = std::invoke_result_t<TConfigurationLoader, const std::string&>>
TConfiguration LoadConfiguration (const boost::filesystem::path &path, TConfigurationLoader loader)
 Loads configuration from path using loader. More...
 
template<typename TConfiguration >
TConfiguration LoadIniConfiguration (const boost::filesystem::path &path)
 Loads ini configuration from path. More...
 
std::vector< ionet::NodeLoadPeersConfiguration (const boost::filesystem::path &path, model::NetworkIdentifier networkIdentifier)
 Loads peers configuration from path for network networkIdentifier. More...
 
utils::BasicLoggerOptions GetConsoleLoggerOptions (const ConsoleLoggerConfiguration &config)
 Maps console logger configuration (config) to console logger options. More...
 
utils::FileLoggerOptions GetFileLoggerOptions (const FileLoggerConfiguration &config)
 Maps file logger configuration (config) to file logger options. More...
 
std::vector< ionet::NodeLoadPeersFromStream (std::istream &input, model::NetworkIdentifier networkIdentifier)
 Loads peers from the specified stream (input) for the network identified by networkIdentifier. More...
 
std::vector< ionet::NodeLoadPeersFromPath (const std::string &path, model::NetworkIdentifier networkIdentifier)
 Loads peers from the specified path for the network identified by networkIdentifier. More...
 
void ValidateConfiguration (const CatapultConfiguration &config)
 Validates config and throws an exception if it is invalid. More...
 

Function Documentation

◆ GetConsoleLoggerOptions()

utils::BasicLoggerOptions catapult::config::GetConsoleLoggerOptions ( const ConsoleLoggerConfiguration config)

Maps console logger configuration (config) to console logger options.

◆ GetFileLoggerOptions()

utils::FileLoggerOptions catapult::config::GetFileLoggerOptions ( const FileLoggerConfiguration config)

Maps file logger configuration (config) to file logger options.

Here is the call graph for this function:

◆ LoadConfiguration()

template<typename TConfigurationLoader , typename TConfiguration = std::invoke_result_t<TConfigurationLoader, const std::string&>>
TConfiguration catapult::config::LoadConfiguration ( const boost::filesystem::path &  path,
TConfigurationLoader  loader 
)

Loads configuration from path using loader.

Here is the caller graph for this function:

◆ LoadIniConfiguration()

template<typename TConfiguration >
TConfiguration catapult::config::LoadIniConfiguration ( const boost::filesystem::path &  path)

Loads ini configuration from path.

Here is the call graph for this function:

◆ LoadPeersConfiguration()

std::vector<ionet::Node> catapult::config::LoadPeersConfiguration ( const boost::filesystem::path &  path,
model::NetworkIdentifier  networkIdentifier 
)
inline

Loads peers configuration from path for network networkIdentifier.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ LoadPeersFromPath()

std::vector< ionet::Node > catapult::config::LoadPeersFromPath ( const std::string &  path,
model::NetworkIdentifier  networkIdentifier 
)

Loads peers from the specified path for the network identified by networkIdentifier.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ LoadPeersFromStream()

std::vector< ionet::Node > catapult::config::LoadPeersFromStream ( std::istream &  input,
model::NetworkIdentifier  networkIdentifier 
)

Loads peers from the specified stream (input) for the network identified by networkIdentifier.

Here is the caller graph for this function:

◆ ToLocalNode()

ionet::Node catapult::config::ToLocalNode ( const CatapultConfiguration config)

Extracts a node representing the local node from config.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ ValidateConfiguration()

void catapult::config::ValidateConfiguration ( const CatapultConfiguration config)

Validates config and throws an exception if it is invalid.

Here is the caller graph for this function: