broker_config Class Reference

#include <broker_config.h>

Public Member Functions
	broker_config ()
	broker_config (const YAML::Node &config)
virtual const std::string &	get_client_address () const
virtual uint16_t	get_client_port () const
virtual const std::string &	get_worker_address () const
virtual uint16_t	get_worker_port () const
virtual const std::string &	get_monitor_address () const
virtual uint16_t	get_monitor_port () const
virtual size_t	get_max_worker_liveness () const
virtual size_t	get_max_request_failures () const
virtual std::chrono::milliseconds	get_worker_ping_interval () const
const log_config &	get_log_config () const
const notifier_config &	get_notifier_config () const

Detailed Description

An object representation of a default broker's configuration

Definition at line 21 of file broker_config.h.

Constructor & Destructor Documentation

broker_config() [1/2]

broker_config::broker_config

(

)

A default constructor

Definition at line 3 of file broker_config.cpp.

broker_config() [2/2]

broker_config::broker_config

(

const YAML::Node &

config

)

A constructor that loads the configuration from a YAML document.

Parameters

config

The input document.

Definition at line 7 of file broker_config.cpp.

Member Function Documentation

get_client_address()

const std::string & broker_config::get_client_address ( ) const

virtual

Get IP address for client connections (from frontend).

Returns

Broker's IP address for client connections.

Definition at line 91 of file broker_config.cpp.

get_client_port()

uint16_t broker_config::get_client_port ( ) const

virtual

Get the port to listen for incoming tasks.

Returns

Broker's port for client connections.

Definition at line 96 of file broker_config.cpp.

get_log_config()

const log_config & broker_config::get_log_config

(

)

const

Get wrapper for logger configuration.

Returns

Logging config as log_config structure.

Definition at line 131 of file broker_config.cpp.

get_max_request_failures()

size_t broker_config::get_max_request_failures ( ) const

virtual

Get the amount of times a request can fail before it's cancelled

Returns

Maximum request failure count

Definition at line 141 of file broker_config.cpp.

get_max_worker_liveness()

size_t broker_config::get_max_worker_liveness ( ) const

virtual

Get the maximum (i.e. initial) liveness of a worker.

Returns

Maximum liveness of worker.

Definition at line 121 of file broker_config.cpp.

get_monitor_address()

const std::string & broker_config::get_monitor_address ( ) const

virtual

Get IP address for monitor connections.

Returns

Broker's IP address for monitor connections.

Definition at line 111 of file broker_config.cpp.

get_monitor_port()

uint16_t broker_config::get_monitor_port ( ) const

virtual

Get the port for communication with monitor.

Returns

Broker's port for monitor connections.

Definition at line 116 of file broker_config.cpp.

get_notifier_config()

const notifier_config & broker_config::get_notifier_config

(

)

const

Get wrapper for frontend notifier configuration.

Returns

Frontend connection information as notifier_config structure.

Definition at line 136 of file broker_config.cpp.

get_worker_address()

const std::string & broker_config::get_worker_address ( ) const

virtual

Get IP address for worker connections.

Returns

Broker's IP address for worker connections.

Definition at line 101 of file broker_config.cpp.

get_worker_ping_interval()

std::chrono::milliseconds broker_config::get_worker_ping_interval ( ) const

virtual

Get the time (in milliseconds) expected to pass between pings from the worker.

Returns

Interval between two concurrent pings.

Definition at line 126 of file broker_config.cpp.

get_worker_port()

uint16_t broker_config::get_worker_port ( ) const

virtual

Get the port for communication with workers.

Returns

Broker's port for worker connections.

Definition at line 106 of file broker_config.cpp.

---

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

• src/config/broker_config.h
• src/config/broker_config.cpp