llarp::Config

Public Functions

Name
Config(std::optional< fs::path > datadir =std::nullopt)
virtual ~Config() =default
virtual std::unique_ptr< ConfigGenParameters > MakeGenParams() const
create generation params (virtual for unit test mock)
void initializeConfig(ConfigDefinition & conf, const ConfigGenParameters & params)
void addBackwardsCompatibleConfigOptions(ConfigDefinition & conf)
Insert config entries for backwards-compatibility (e.g.
bool Load(std::optional< fs::path > fname =std::nullopt, bool isRelay =false)
bool LoadString(std::string_view ini, bool isRelay =false)
std::string generateBaseClientConfig()
std::string generateBaseRouterConfig()
void Save()
void Override(std::string section, std::string key, std::string value)
void AddDefault(std::string section, std::string key, std::string value)
std::shared_ptr< Config > EmbeddedConfig()
create a config with the default parameters for an embedded lokinet

Public Attributes

Name
RouterConfig router
NetworkConfig network
PeerSelectionConfig paths
ConnectConfig connect
DnsConfig dns
LinksConfig links
ApiConfig api
BootstrapConfig bootstrap
LoggingConfig logging

Public Functions Documentation

function Config

explicit Config(
    std::optional< fs::path > datadir =std::nullopt
)

function ~Config

virtual ~Config() =default

function MakeGenParams

virtual std::unique_ptr< ConfigGenParameters > MakeGenParams() const

create generation params (virtual for unit test mock)

function initializeConfig

void initializeConfig(
    ConfigDefinition & conf,
    const ConfigGenParameters & params
)

function addBackwardsCompatibleConfigOptions

void addBackwardsCompatibleConfigOptions(
    ConfigDefinition & conf
)

Insert config entries for backwards-compatibility (e.g.

Parameters:

  • conf is the config to modify

so that the config system will tolerate old values that are no longer accepted)

function Load

bool Load(
    std::optional< fs::path > fname =std::nullopt,
    bool isRelay =false
)

function LoadString

bool LoadString(
    std::string_view ini,
    bool isRelay =false
)

function generateBaseClientConfig

std::string generateBaseClientConfig()

function generateBaseRouterConfig

std::string generateBaseRouterConfig()

function Save

void Save()

function Override

void Override(
    std::string section,
    std::string key,
    std::string value
)

function AddDefault

void AddDefault(
    std::string section,
    std::string key,
    std::string value
)

function EmbeddedConfig

static std::shared_ptr< Config > EmbeddedConfig()

create a config with the default parameters for an embedded lokinet

Public Attributes Documentation

variable router

RouterConfig router;

variable network

NetworkConfig network;

variable paths

PeerSelectionConfig paths;

variable connect

ConnectConfig connect;

variable dns

DnsConfig dns;

LinksConfig links;

variable api

ApiConfig api;

variable bootstrap

BootstrapConfig bootstrap;

variable logging

LoggingConfig logging;

Updated on 2026-01-10 at 22:49:45 +0000