client_configuration Class Reference

Provides command-line options for client configuration. More...

#include <client_configuration.hpp>

Collaboration diagram for client_configuration:

Static Public Member Functions
static boost::program_options::options_description	make_options_description (std::uint16_t default_port, const std::string &default_identifier, bool include_auth=false)
	Creates the options description for client CLI arguments.
static net::client_options	read_options (const boost::program_options::variables_map &vm)
	Reads client options from parsed variables map.
static std::optional< login_options >	read_login_options (const boost::program_options::variables_map &vm)
	Reads login options from parsed variables map.

Detailed Description

Provides command-line options for client configuration.

Standard client options: –connect-host HOST Host to connect to –connect-port PORT Port to connect to –connect-identifier ID Client identifier for handshake

Authentication options (when include_auth is true): –login-username USER Username for authentication –login-password PASS Password for authentication

Member Function Documentation

make_options_description()

boost::program_options::options_description make_options_description ( std::uint16_t  default_port, const std::string &  default_identifier, bool  include_auth = false  )

static

Creates the options description for client CLI arguments.

Parameters

default_port	Default port number.
default_identifier	Default client identifier.
include_auth	Whether to include authentication options.

Returns

options_description for client configuration.

read_options()

net::client_options read_options ( const boost::program_options::variables_map &  vm )

static

Reads client options from parsed variables map.

Always returns a client_options object, populated with either user-provided values or the defaults.

Parameters

vm	Parsed command-line options.

Returns

client_options populated from the variables map.

read_login_options()

std::optional< login_options > read_login_options ( const boost::program_options::variables_map &  vm )

static

Reads login options from parsed variables map.

Returns std::nullopt if no login options are provided. Throws if only username or only password is provided.

Parameters

vm	Parsed command-line options.

Returns

login_options if both username and password were provided.

Exceptions

std::runtime_error

if only one of username/password is provided.