ORE Studio 0.0.4
Loading...
Searching...
No Matches
Static Public Member Functions | List of all members
server_configuration Class Referencefinal

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

#include <server_configuration.hpp>

Collaboration diagram for server_configuration:
Collaboration graph

Static Public Member Functions

static boost::program_options::options_description make_options_description (std::uint16_t default_port, std::uint32_t default_max_connections, const std::string &default_identifier, bool include_ssl=false)
 Creates the options description for server CLI arguments.
 
static net::server_options read_options (const boost::program_options::variables_map &vm)
 Reads server options from parsed variables map.
 

Detailed Description

Provides command-line options for server configuration.

Standard server options: -p, –port PORT Port to listen on -m, –max-connections N Maximum concurrent connections -i, –identifier ID Server identifier for handshake

SSL options (when include_ssl is true): -c, –certificate FILE Path to SSL certificate file -k, –private-key FILE Path to SSL private key file

Member Function Documentation

◆ make_options_description()

boost::program_options::options_description make_options_description ( std::uint16_t  default_port,
std::uint32_t  default_max_connections,
const std::string &  default_identifier,
bool  include_ssl = false 
)
static

Creates the options description for server CLI arguments.

Parameters
default_portDefault port number.
default_max_connectionsDefault max connections.
default_identifierDefault server identifier.
include_sslWhether to include SSL certificate options.
Returns
options_description for server configuration.

◆ read_options()

net::server_options read_options ( const boost::program_options::variables_map &  vm)
static

Reads server options from parsed variables map.

Parameters
vmParsed command-line options.
Returns
server_options populated from the variables map.