network::server_manager Struct Reference

A server manager causes listening on a given port to occur for the duration of its lifetime. More...

#include <network.hpp>

List of all members.

Public Types

enum  CREATE_SERVER { MUST_CREATE_SERVER, TRY_CREATE_SERVER, NO_SERVER }
 Parameter to pass to the constructor. More...

Public Member Functions

 server_manager (int port, CREATE_SERVER create_server=MUST_CREATE_SERVER)
 ~server_manager ()
bool is_running () const
void stop ()

Private Attributes

bool free_


Detailed Description

A server manager causes listening on a given port to occur for the duration of its lifetime.

Definition at line 70 of file network.hpp.


Member Enumeration Documentation

Parameter to pass to the constructor.

Enumerator:
MUST_CREATE_SERVER  Will throw exception on failure.
TRY_CREATE_SERVER  Will swallow failure.
NO_SERVER 

Definition at line 73 of file network.hpp.


Constructor & Destructor Documentation

network::server_manager::server_manager ( int  port,
CREATE_SERVER  create_server = MUST_CREATE_SERVER 
)

network::server_manager::~server_manager (  ) 

Definition at line 294 of file network.cpp.

References stop().


Member Function Documentation

bool network::server_manager::is_running (  )  const

Definition at line 308 of file network.cpp.

References server_socket.

void network::server_manager::stop (  ) 

Definition at line 299 of file network.cpp.

References free_, and server_socket.

Referenced by server::process_command(), and ~server_manager().


Member Data Documentation

Definition at line 85 of file network.hpp.

Referenced by server_manager(), and stop().


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

Generated by doxygen 1.5.5 on 23 May 2008 for The Battle for Wesnoth
Gna! | Forum | Wiki | CIA | devdocs