A class that represents a TCP/IP connection to the wesnothd server. More...

#include <wesnothd_connection.hpp>

Public Types
using	error = wesnothd_connection_error

Public Member Functions
	wesnothd_connection (const wesnothd_connection &)=delete

wesnothd_connection &	operator= (const wesnothd_connection &)=delete

	~wesnothd_connection ()

	wesnothd_connection (const std::string &host, const std::string &service)
	Constructor. More...

void	send_data (const configr_of &request)
	Queues the given data to be sent to the server. More...

bool	receive_data (config &result)
	Receives the next pending data pack from the server, if available. More...

bool	wait_and_receive_data (config &data)
	Unlike receive_data, waits until data is available instead of returning immediately. More...

void	wait_for_handshake ()
	Waits until the server handshake is complete. More...

bool	using_tls () const
	True if connection is currently using TLS and thus is allowed to send cleartext passwords or auth tokens. More...

void	cancel ()

void	stop ()

std::size_t	bytes_to_write () const

std::size_t	bytes_written () const

std::size_t	bytes_to_read () const

std::size_t	bytes_read () const

bool	has_data_received () const

bool	is_sending_data () const

Private Types
typedef boost::asio::ip::tcp::resolver	resolver

typedef std::unique_ptr< boost::asio::ip::tcp::socket >	raw_socket

typedef std::unique_ptr< boost::asio::ssl::stream< raw_socket::element_type > >	tls_socket

typedef utils::variant< raw_socket, tls_socket >	any_socket

using	results_type = resolver::results_type

using	endpoint = const boost::asio::ip::tcp::endpoint &

template<typename T >
using	data_queue = std::queue< T, std::list< T > >

Private Member Functions
void	handle_resolve (const boost::system::error_code &ec, results_type results)

void	handle_connect (const boost::system::error_code &ec, endpoint endpoint)

void	handshake ()

void	handle_handshake (const boost::system::error_code &ec)

void	fallback_to_unencrypted ()

std::size_t	is_write_complete (const boost::system::error_code &error, std::size_t bytes_transferred)

void	handle_write (const boost::system::error_code &ec, std::size_t bytes_transferred)

std::size_t	is_read_complete (const boost::system::error_code &error, std::size_t bytes_transferred)

void	handle_read (const boost::system::error_code &ec, std::size_t bytes_transferred)

void	send ()

void	recv ()

void	set_keepalive (int seconds)

Private Attributes
std::thread	worker_thread_

boost::asio::io_context	io_context_

resolver	resolver_

boost::asio::ssl::context	tls_context_

std::string	host_

std::string	service_

bool	use_tls_

any_socket	socket_

boost::system::error_code	last_error_

std::mutex	last_error_mutex_

std::promise< void >	handshake_finished_

boost::asio::streambuf	read_buf_

uint32_t	handshake_response_

data_queue< std::unique_ptr< boost::asio::streambuf > >	send_queue_

data_queue< config >	recv_queue_

std::mutex	recv_queue_mutex_

std::condition_variable	recv_queue_lock_

uint32_t	payload_size_

std::size_t	bytes_to_write_

std::size_t	bytes_written_

std::size_t	bytes_to_read_

std::size_t	bytes_read_

Detailed Description

A class that represents a TCP/IP connection to the wesnothd server.

Definition at line 51 of file wesnothd_connection.hpp.

Member Typedef Documentation

◆ any_socket

typedef utils::variant<raw_socket, tls_socket> wesnothd_connection::any_socket

private

Definition at line 149 of file wesnothd_connection.hpp.

◆ data_queue

template<typename T >

using wesnothd_connection::data_queue = std::queue<T, std::list<T> >

private

Definition at line 186 of file wesnothd_connection.hpp.

◆ endpoint

using wesnothd_connection::endpoint = const boost::asio::ip::tcp::endpoint&

private

Definition at line 162 of file wesnothd_connection.hpp.

◆ error

using wesnothd_connection::error = wesnothd_connection_error

Definition at line 54 of file wesnothd_connection.hpp.

◆ raw_socket

typedef std::unique_ptr<boost::asio::ip::tcp::socket> wesnothd_connection::raw_socket

private

Definition at line 147 of file wesnothd_connection.hpp.

◆ resolver

typedef boost::asio::ip::tcp::resolver wesnothd_connection::resolver

private

Definition at line 140 of file wesnothd_connection.hpp.

◆ results_type

using wesnothd_connection::results_type = resolver::results_type

private

Definition at line 161 of file wesnothd_connection.hpp.

◆ tls_socket

typedef std::unique_ptr<boost::asio::ssl::stream<raw_socket::element_type> > wesnothd_connection::tls_socket

private

Definition at line 148 of file wesnothd_connection.hpp.

Constructor & Destructor Documentation

◆ wesnothd_connection() [1/2]

wesnothd_connection::wesnothd_connection ( const wesnothd_connection & )

delete

◆ ~wesnothd_connection()

wesnothd_connection::~wesnothd_connection ( )

Definition at line 120 of file wesnothd_connection.cpp.

References MPTEST_LOG, socket_, stop(), worker_thread_, and write().

◆ wesnothd_connection() [2/2]

wesnothd_connection::wesnothd_connection	(	const std::string &	host,
		const std::string &	service
	)

Constructor.

Parameters

host	Name of the host to connect to
service	Service identifier such as "80" or "http"

Definition at line 64 of file wesnothd_connection.cpp.

References DBG_NW, utils::get_unknown_exception_type(), handle_resolve(), handshake_finished_, io_context_, LOG_NW, MPTEST_LOG, resolver_, use_tls_, and worker_thread_.

Member Function Documentation

◆ bytes_read()

std::size_t wesnothd_connection::bytes_read ( ) const

inline

Definition at line 120 of file wesnothd_connection.hpp.

References bytes_read_.

◆ bytes_to_read()

std::size_t wesnothd_connection::bytes_to_read ( ) const

inline

Definition at line 115 of file wesnothd_connection.hpp.

References bytes_to_read_.

◆ bytes_to_write()

std::size_t wesnothd_connection::bytes_to_write ( ) const

inline

Definition at line 105 of file wesnothd_connection.hpp.

References bytes_to_write_.

◆ bytes_written()

std::size_t wesnothd_connection::bytes_written ( ) const

inline

Definition at line 110 of file wesnothd_connection.hpp.

References bytes_written_.

◆ cancel()

void wesnothd_connection::cancel ( )

Definition at line 343 of file wesnothd_connection.cpp.

References MPTEST_LOG.

◆ fallback_to_unencrypted()

void wesnothd_connection::fallback_to_unencrypted ( )

private

Definition at line 265 of file wesnothd_connection.cpp.

References handle_connect(), socket_, and use_tls_.

Referenced by handle_handshake().

◆ handle_connect()

void wesnothd_connection::handle_connect	(	const boost::system::error_code &	ec,
		endpoint	endpoint
	)

private

Definition at line 151 of file wesnothd_connection.cpp.

References ERR_NW, handshake(), LOG_NW, MPTEST_LOG, and use_tls_.

Referenced by fallback_to_unencrypted(), and handle_resolve().

◆ handle_handshake()

void wesnothd_connection::handle_handshake ( const boost::system::error_code & ec )

private

Definition at line 206 of file wesnothd_connection.cpp.

References fallback_to_unencrypted(), handshake_finished_, handshake_response_, host_, network_asio::load_tls_root_certs(), LOG_NW, MPTEST_LOG, recv(), s, socket_, tls_context_, use_tls_, and verbose_verify().

Referenced by handshake().

◆ handle_read()

void wesnothd_connection::handle_read	(	const boost::system::error_code &	ec,
		std::size_t	bytes_transferred
	)

private

Definition at line 461 of file wesnothd_connection.cpp.

References bytes_to_read_, data, DBG_NW, io_context_, last_error_, last_error_mutex_, LOG_NW, MPTEST_LOG, read_buf_, read_gz(), recv(), recv_queue_, recv_queue_lock_, and recv_queue_mutex_.

Referenced by recv().

◆ handle_resolve()

void wesnothd_connection::handle_resolve	(	const boost::system::error_code &	ec,
		results_type	results
	)

private

Definition at line 138 of file wesnothd_connection.cpp.

References handle_connect(), LOG_NW, MPTEST_LOG, and socket_.

Referenced by wesnothd_connection().

◆ handle_write()

void wesnothd_connection::handle_write	(	const boost::system::error_code &	ec,
		std::size_t	bytes_transferred
	)

private

Definition at line 397 of file wesnothd_connection.cpp.

References DBG_NW, io_context_, last_error_, last_error_mutex_, LOG_NW, MPTEST_LOG, send(), and send_queue_.

Referenced by send().

◆ handshake()

void wesnothd_connection::handshake ( )

private

Definition at line 168 of file wesnothd_connection.cpp.

References DBG_NW, prefs::get(), handle_handshake(), handshake_response_, prefs::keepalive_timeout(), MPTEST_LOG, set_keepalive(), socket_, and use_tls_.

Referenced by handle_connect().

◆ has_data_received()

bool wesnothd_connection::has_data_received ( ) const

inline

Definition at line 125 of file wesnothd_connection.hpp.

References recv_queue_.

◆ is_read_complete()

std::size_t wesnothd_connection::is_read_complete	(	const boost::system::error_code &	error,
		std::size_t	bytes_transferred
	)

private

Definition at line 422 of file wesnothd_connection.cpp.

References bytes_read_, bytes_to_read_, io_context_, last_error_, last_error_mutex_, LOG_NW, MPTEST_LOG, and read_buf_.

Referenced by recv().

◆ is_sending_data()

bool wesnothd_connection::is_sending_data ( ) const

inline

Definition at line 130 of file wesnothd_connection.hpp.

References send_queue_.

◆ is_write_complete()

std::size_t wesnothd_connection::is_write_complete	(	const boost::system::error_code &	error,
		std::size_t	bytes_transferred
	)

private

Definition at line 377 of file wesnothd_connection.cpp.

References bytes_to_write_, bytes_written_, io_context_, last_error_, last_error_mutex_, LOG_NW, and MPTEST_LOG.

Referenced by send().

◆ operator=()

wesnothd_connection& wesnothd_connection::operator= ( const wesnothd_connection & )

delete

◆ receive_data()

bool wesnothd_connection::receive_data ( config & result )

Receives the next pending data pack from the server, if available.

Parameters

result The object to which the received data will be written.

Returns: True if any data was available, false otherwise.

Definition at line 529 of file wesnothd_connection.cpp.

References _(), last_error_, last_error_mutex_, MPTEST_LOG, recv_queue_, recv_queue_mutex_, and config::swap().

Referenced by gui2::dialogs::mp_lobby::network_handler(), gui2::dialogs::mp_join_game::network_handler(), gui2::dialogs::mp_staging::network_handler(), playmp_controller::receive_from_wesnothd(), and wait_and_receive_data().

◆ recv()

void wesnothd_connection::recv ( )

private

Definition at line 517 of file wesnothd_connection.cpp.

References handle_read(), is_read_complete(), MPTEST_LOG, read_buf_, and socket_.

Referenced by handle_handshake(), and handle_read().

◆ send()

void wesnothd_connection::send ( )

private

Definition at line 494 of file wesnothd_connection.cpp.

References bytes_to_write_, bytes_written_, handle_write(), is_write_complete(), MPTEST_LOG, payload_size_, send_queue_, and socket_.

Referenced by handle_write().

◆ send_data()

void wesnothd_connection::send_data ( const configr_of & request )

Queues the given data to be sent to the server.

Parameters

request The data to send

Definition at line 322 of file wesnothd_connection.cpp.

References DBG_NW, io_context_, MPTEST_LOG, send_queue_, and write_gz().

Referenced by playmp_controller::send_to_wesnothd().

◆ set_keepalive()

void wesnothd_connection::set_keepalive ( int seconds )

private

Definition at line 572 of file wesnothd_connection.cpp.

References socket_.

Referenced by handshake().

◆ stop()

void wesnothd_connection::stop ( )

Definition at line 369 of file wesnothd_connection.cpp.

References io_context_, and MPTEST_LOG.

Referenced by ~wesnothd_connection().

◆ using_tls()

bool wesnothd_connection::using_tls ( ) const

inline

True if connection is currently using TLS and thus is allowed to send cleartext passwords or auth tokens.

Definition at line 96 of file wesnothd_connection.hpp.

References socket_.

◆ wait_and_receive_data()

bool wesnothd_connection::wait_and_receive_data ( config & data )

Unlike receive_data, waits until data is available instead of returning immediately.

Parameters

data	Config object passed to receive_data

Returns: True, since data will always be available.

Definition at line 558 of file wesnothd_connection.cpp.

References data, receive_data(), recv_queue_lock_, recv_queue_mutex_, and gui2::dialogs::loading_screen::spin().

Referenced by gui2::dialogs::mp_join_game::fetch_game_config().

◆ wait_for_handshake()

void wesnothd_connection::wait_for_handshake ( )

Waits until the server handshake is complete.

Definition at line 278 of file wesnothd_connection.cpp.

References e, lg::err(), handshake_finished_, LOG_NW, MPTEST_LOG, s, gui2::dialogs::loading_screen::spin(), and WRN_NW.

Member Data Documentation

◆ bytes_read_

std::size_t wesnothd_connection::bytes_read_

private

Definition at line 201 of file wesnothd_connection.hpp.

Referenced by bytes_read(), and is_read_complete().

◆ bytes_to_read_

std::size_t wesnothd_connection::bytes_to_read_

private

Definition at line 200 of file wesnothd_connection.hpp.

Referenced by bytes_to_read(), handle_read(), and is_read_complete().

◆ bytes_to_write_

std::size_t wesnothd_connection::bytes_to_write_

private

Definition at line 198 of file wesnothd_connection.hpp.

Referenced by bytes_to_write(), is_write_complete(), and send().

◆ bytes_written_

std::size_t wesnothd_connection::bytes_written_

private

Definition at line 199 of file wesnothd_connection.hpp.

Referenced by bytes_written(), is_write_complete(), and send().

◆ handshake_finished_

std::promise<void> wesnothd_connection::handshake_finished_

private

Definition at line 157 of file wesnothd_connection.hpp.

Referenced by handle_handshake(), wait_for_handshake(), and wesnothd_connection().

◆ handshake_response_

uint32_t wesnothd_connection::handshake_response_

private

Definition at line 170 of file wesnothd_connection.hpp.

Referenced by handle_handshake(), and handshake().

◆ host_

std::string wesnothd_connection::host_

private

Definition at line 145 of file wesnothd_connection.hpp.

Referenced by handle_handshake().

◆ io_context_

boost::asio::io_context wesnothd_connection::io_context_

private

Definition at line 138 of file wesnothd_connection.hpp.

Referenced by handle_read(), handle_write(), is_read_complete(), is_write_complete(), send_data(), stop(), and wesnothd_connection().

◆ last_error_

boost::system::error_code wesnothd_connection::last_error_

private

Definition at line 153 of file wesnothd_connection.hpp.

Referenced by handle_read(), handle_write(), is_read_complete(), is_write_complete(), and receive_data().

◆ last_error_mutex_

std::mutex wesnothd_connection::last_error_mutex_

private

Definition at line 155 of file wesnothd_connection.hpp.

Referenced by handle_read(), handle_write(), is_read_complete(), is_write_complete(), and receive_data().

◆ payload_size_

uint32_t wesnothd_connection::payload_size_

private

Definition at line 195 of file wesnothd_connection.hpp.

Referenced by send().

◆ read_buf_

boost::asio::streambuf wesnothd_connection::read_buf_

private

Definition at line 159 of file wesnothd_connection.hpp.

Referenced by handle_read(), is_read_complete(), and recv().

◆ recv_queue_

data_queue<config> wesnothd_connection::recv_queue_

private

Definition at line 189 of file wesnothd_connection.hpp.

Referenced by handle_read(), has_data_received(), and receive_data().

◆ recv_queue_lock_

std::condition_variable wesnothd_connection::recv_queue_lock_

private

Definition at line 193 of file wesnothd_connection.hpp.

Referenced by handle_read(), and wait_and_receive_data().

◆ recv_queue_mutex_

std::mutex wesnothd_connection::recv_queue_mutex_

private

Definition at line 191 of file wesnothd_connection.hpp.

Referenced by handle_read(), receive_data(), and wait_and_receive_data().

◆ resolver_

resolver wesnothd_connection::resolver_

private

Definition at line 141 of file wesnothd_connection.hpp.

Referenced by wesnothd_connection().

◆ send_queue_

data_queue<std::unique_ptr<boost::asio::streambuf> > wesnothd_connection::send_queue_

private

Definition at line 188 of file wesnothd_connection.hpp.

Referenced by handle_write(), is_sending_data(), send(), and send_data().

◆ service_

std::string wesnothd_connection::service_

private

Definition at line 146 of file wesnothd_connection.hpp.

◆ socket_

any_socket wesnothd_connection::socket_

private

Definition at line 151 of file wesnothd_connection.hpp.

Referenced by fallback_to_unencrypted(), handle_handshake(), handle_resolve(), handshake(), recv(), send(), set_keepalive(), using_tls(), and ~wesnothd_connection().

◆ tls_context_

boost::asio::ssl::context wesnothd_connection::tls_context_

private

Definition at line 143 of file wesnothd_connection.hpp.

Referenced by handle_handshake().

◆ use_tls_

bool wesnothd_connection::use_tls_

private

Definition at line 150 of file wesnothd_connection.hpp.

Referenced by fallback_to_unencrypted(), handle_connect(), handle_handshake(), handshake(), and wesnothd_connection().

◆ worker_thread_

std::thread wesnothd_connection::worker_thread_

private

Definition at line 136 of file wesnothd_connection.hpp.

Referenced by wesnothd_connection(), and ~wesnothd_connection().

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

Public Types

Public Member Functions

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ any_socket

◆ data_queue

◆ endpoint

◆ error

◆ raw_socket

◆ resolver

◆ results_type

◆ tls_socket

Constructor & Destructor Documentation

◆ wesnothd_connection() [1/2]

◆ ~wesnothd_connection()

◆ wesnothd_connection() [2/2]

Member Function Documentation

◆ bytes_read()

◆ bytes_to_read()

◆ bytes_to_write()

◆ bytes_written()

◆ cancel()

◆ fallback_to_unencrypted()

◆ handle_connect()

◆ handle_handshake()

◆ handle_read()

◆ handle_resolve()

◆ handle_write()

◆ handshake()

◆ has_data_received()

◆ is_read_complete()

◆ is_sending_data()

◆ is_write_complete()

◆ operator=()

◆ receive_data()

◆ recv()

◆ send()

◆ send_data()

◆ set_keepalive()

◆ stop()

◆ using_tls()

◆ wait_and_receive_data()

◆ wait_for_handshake()

Member Data Documentation

◆ bytes_read_

◆ bytes_to_read_

◆ bytes_to_write_

◆ bytes_written_

◆ handshake_finished_

◆ handshake_response_

◆ host_

◆ io_context_

◆ last_error_

◆ last_error_mutex_

◆ payload_size_

◆ read_buf_

◆ recv_queue_

◆ recv_queue_lock_

◆ recv_queue_mutex_

◆ resolver_

◆ send_queue_

◆ service_

◆ socket_

◆ tls_context_

◆ use_tls_

◆ worker_thread_