High level network layer for config object transport. More...

Classes
struct	bandwidth_stats
struct	bandwidth_stats_output
struct	pending_statistics
struct	manager
struct	server_manager
	A server manager causes listening on a given port to occur for the duration of its lifetime. More...
struct	bandwidth_in
struct	connection_stats
struct	error
struct	statistics
Typedefs
typedef std::map< const std::string, bandwidth_stats >	bandwidth_map
typedef std::vector < bandwidth_map >	hour_stats_vector
typedef boost::shared_ptr < bandwidth_stats >	bandwidth_stats_ptr
typedef int	connection
typedef boost::shared_ptr < bandwidth_in >	bandwidth_in_ptr
Functions
connection_stats	get_connection_stats (connection connection_num)
pending_statistics	get_pending_stats ()
void	set_raw_data_only ()
size_t	nconnections ()
	The number of peers we are connected to.
bool	is_server ()
	If we are currently accepting connections.
connection	connect (const std::string &host, int port=15000)
	Function to attempt to connect to a remote host.
connection	connect (const std::string &host, int port, threading::waiter &waiter)
connection	accept_connection ()
	Function to accept a connection from a remote host.
bool	disconnect (connection connection_num=0)
	Function to disconnect from a certain host, or close all connections if connection_num is 0.
void	queue_disconnect (connection connection_num)
	Function to queue a disconnection.
connection	receive_data (config &cfg, connection connection_num, unsigned int timeout, bandwidth_in_ptr *bandwidth_in)
connection	receive_data (config &cfg, connection connection_num=0, bandwidth_in_ptr *b=0)
	Function to receive data from either a certain connection, or all connections if connection_num is 0.
connection	receive_data (std::vector< char > &buf, bandwidth_in_ptr *bandwidth_in)
hour_stats_vector	hour_stats (24)
static bandwidth_map::iterator	add_bandwidth_entry (const std::string &packet_type)
std::string	get_bandwidth_stats_all ()
std::string	get_bandwidth_stats ()
std::string	get_bandwidth_stats (int hour)
void	add_bandwidth_out (const std::string &packet_type, size_t len)
void	add_bandwidth_in (const std::string &packet_type, size_t len)
void	send_file (const std::string &filename, connection connection_num, const std::string &packet_type)
size_t	send_data (const config &cfg, connection connection_num=0, const std::string &packet_type="unknown")
	Function to send data down a given connection, or broadcast to all peers if connection_num is 0.
void	send_raw_data (const char *buf, int len, connection connection_num, const std::string &packet_type)
void	process_send_queue (connection connection_num=0, size_t max_size=0)
	Function to send any data that is in a connection's send_queue, up to a maximum of 'max_size' bytes -- or the entire send queue if 'max_size' bytes is 0.
void	send_data_all_except (const config &cfg, connection connection_num, const std::string &packet_type="unknown")
	Function to send data to all peers except 'connection_num'.
std::string	ip_address (connection connection_num)
	Function to get the remote ip address of a socket.
statistics	get_send_stats (connection handle)
	Function to see the number of bytes being processed on the current socket.
statistics	get_receive_stats (connection handle)
Proxy Settings Methods
Methods to configure the connection of a client through a proxy server.
void	enable_connection_through_proxy ()
	Attempt to connect through a proxy (as opposed to directly.
void	set_proxy_address (const std::string &address)
	Set the address of the proxy.
void	set_proxy_port (const std::string &port)
	Set the port of the proxy.
void	set_proxy_user (const std::string &user)
	Set the user to authenticate with the proxy.
void	set_proxy_password (const std::string &password)
	Set the password to authenticate with the proxy.
Variables
unsigned int	ping_timeout = 0
	Amount of seconds after the last server ping when we assume to have timed out.
connection const	null_connection = 0
const int	ping_interval = 30
	Minimum interval between pings.

Detailed Description

High level network layer for config object transport.

This module provides high level network access using an API similar to sockets, but primarily for the transport of config objects. This is how the games protocols work - data is sent via config objects.

A client would create a manager object to initialize the network layer, connect(), and then send_data(). A server would create a server_manager object, then accept_connection(), and finally receive_data().

Typedef Documentation

typedef boost::shared_ptr<bandwidth_in> network::bandwidth_in_ptr

Definition at line 206 of file network.hpp.

typedef std::map<const std::string, bandwidth_stats> network::bandwidth_map

Definition at line 956 of file network.cpp.

typedef boost::shared_ptr<bandwidth_stats> network::bandwidth_stats_ptr

Definition at line 984 of file network.cpp.

typedef int network::connection

Definition at line 74 of file network.hpp.

typedef std::vector<bandwidth_map> network::hour_stats_vector

Definition at line 957 of file network.cpp.

Function Documentation

connection network::accept_connection ( )

Function to accept a connection from a remote host.

If no host is attempting to connect, it will return 0 immediately. Otherwise returns the new connection.

Exceptions:

error

A list of all the sockets which have connected, but haven't had their initial handshake received.

Definition at line 210 of file network_ana.cpp.

Referenced by BOOST_AUTO_TEST_CASE(), mp::ui::process_network(), server::run(), and WESNOTH_PARAMETERIZED_TEST_CASE().

Here is the caller graph for this function:

static bandwidth_map::iterator network::add_bandwidth_entry ( const std::string & packet_type ) [static]

Definition at line 962 of file network.cpp.

References hour_stats().

Here is the call graph for this function:

void network::add_bandwidth_in	(	const std::string &	packet_type,
		size_t	len
	)

Definition at line 268 of file network_ana.cpp.

Referenced by network::bandwidth_in::~bandwidth_in().

Here is the caller graph for this function:

void network::add_bandwidth_out	(	const std::string &	packet_type,
		size_t	len
	)

Definition at line 263 of file network_ana.cpp.

connection network::connect	(	const std::string &	host,
		int	port = `15000`
	)

Function to attempt to connect to a remote host.

Returns:: The new connection on success, or 0 on failure.

Exceptions:

error

Definition at line 200 of file network_ana.cpp.

Referenced by BOOST_AUTO_TEST_CASE(), connect(), network::server_manager::server_manager(), and WESNOTH_PARAMETERIZED_TEST_CASE().

Here is the caller graph for this function:

connection network::connect	(	const std::string &	host,
		int	port,
		threading::waiter &	waiter
	)

Definition at line 205 of file network_ana.cpp.

References connect().

Here is the call graph for this function:

bool network::disconnect ( connection connection_num = 0 )

Function to disconnect from a certain host, or close all connections if connection_num is 0.

Returns true if the connection was disconnected. Returns false on failure to disconnect, since the socket is in the middle of sending/receiving data. The socket will be closed when it has finished its send/receive.

Definition at line 215 of file network_ana.cpp.

Referenced by open_connection(), playsingle_controller::play_scenario(), server::run(), WESNOTH_PARAMETERIZED_TEST_CASE(), and network::manager::~manager().

Here is the caller graph for this function:

void network::enable_connection_through_proxy ( )

Attempt to connect through a proxy (as opposed to directly.

)

Use the set_proxy_* methods to configure the connection options.

Definition at line 113 of file network_ana.cpp.

Referenced by game_controller::game_controller().

Here is the caller graph for this function:

std::string network::get_bandwidth_stats ( )

Definition at line 295 of file network_ana.cpp.

References ana::stats::bytes_in(), ana::stats::bytes_out(), ana::HOURS, ana::stats::packets_in(), and ana::stats::packets_out().

Referenced by server::netstats_handler(), and server::run().

Here is the call graph for this function:

Here is the caller graph for this function:

std::string network::get_bandwidth_stats ( int hour )

Definition at line 317 of file network_ana.cpp.

std::string network::get_bandwidth_stats_all ( )

Definition at line 274 of file network_ana.cpp.

References ana::stats::bytes_in(), ana::stats::bytes_out(), ana::stats::packets_in(), and ana::stats::packets_out().

Referenced by server::netstats_handler().

Here is the call graph for this function:

Here is the caller graph for this function:

connection_stats network::get_connection_stats ( connection connection_num )

Definition at line 92 of file network_ana.cpp.

References ana::stats::bytes_in(), ana::stats::bytes_out(), and ana::stats::uptime().

Here is the call graph for this function:

pending_statistics network::get_pending_stats ( )

Definition at line 139 of file network_ana.cpp.

References network::pending_statistics::nbytes_pending_sends, and network::pending_statistics::npending_sends.

Referenced by server::netstats_handler().

Here is the caller graph for this function:

statistics network::get_receive_stats ( connection handle )

Definition at line 376 of file network_ana.cpp.

statistics network::get_send_stats ( connection handle )

Function to see the number of bytes being processed on the current socket.

Definition at line 371 of file network_ana.cpp.

hour_stats_vector network::hour_stats ( 24 )

Referenced by add_bandwidth_entry(), and ChatClient::parse_command().

Here is the caller graph for this function:

std::string network::ip_address ( connection connection_num )

Function to get the remote ip address of a socket.

Definition at line 366 of file network_ana.cpp.

Referenced by wesnothd::game::add_player(), server::ban_handler(), wesnothd::game::ban_user(), server::clones_handler(), server::gban_handler(), wesnothd::game::has_same_ip(), server::ip_exceeds_connection_limit(), server::kick_handler(), wesnothd::game::kick_member(), server::kickban_handler(), wesnothd::game::mute_observer(), wesnothd::game::player_is_banned(), server::process_data_game(), server::process_data_lobby(), server::process_login(), wesnothd::room_manager::process_message(), server::process_query(), wesnothd::game::remove_player(), server::run(), wesnothd::game::start_game(), server::status_handler(), wesnothd::game::unban_user(), and wesnothd::game::unmute_observer().

Here is the caller graph for this function:

bool network::is_server ( )

If we are currently accepting connections.

Definition at line 195 of file network_ana.cpp.

Referenced by mp::connect::process_network_error().

Here is the caller graph for this function:

size_t network::nconnections ( )

The number of peers we are connected to.

Definition at line 190 of file network_ana.cpp.

Referenced by events::menu_handler::ai_formula(), BOOST_AUTO_TEST_CASE(), playmp_controller::can_execute_command(), play_controller::can_execute_command(), check_timeout(), replay_network_sender::commit_and_sync(), events::console_handler::do_control(), events::console_handler::do_debug(), mp_sync::get_user_choice(), events::console_handler::is_enabled(), open_connection(), mp::connect::process_event(), events::menu_handler::scenario_settings_table(), events::menu_handler::status_table(), turn_info::sync_network(), replay_network_sender::sync_non_undoable(), turn_info::turn_info(), verify_and_clear_global_variable(), verify_and_get_global_variable(), verify_and_set_global_variable(), and WML_HANDLER_FUNCTION().

Here is the caller graph for this function:

void network::process_send_queue	(	connection	connection_num = `0`,
		size_t	max_size = `0`
	)

Function to send any data that is in a connection's send_queue, up to a maximum of 'max_size' bytes -- or the entire send queue if 'max_size' bytes is 0.

Definition at line 354 of file network_ana.cpp.

Referenced by server::run().

Here is the caller graph for this function:

void network::queue_disconnect ( network::connection sock )

Function to queue a disconnection.

Next time receive_data is called, it will generate an error on the given connection (and presumably then the handling of the error will include closing the connection).

Definition at line 220 of file network_ana.cpp.

Referenced by server::kick_handler(), server::kickban_handler(), and server::process_login().

Here is the caller graph for this function: