claw  1.9.0
Public Member Functions | Static Public Member Functions | List of all members
claw::net::socket_server Class Reference

Class used to receive incoming connections. More...

#include <socket_server.hpp>

Inheritance diagram for claw::net::socket_server:
Inheritance graph
[legend]
Collaboration diagram for claw::net::socket_server:
Collaboration graph
[legend]

Public Member Functions

 socket_server ()
 Constructor. More...
 
 socket_server (int port, unsigned int queue_size=s_default_queue_size)
 Constructor, open the socket. More...
 
socket_serveropen (int port, unsigned int queue_size=s_default_queue_size)
 Open the socket. More...
 
socket_serverclose ()
 Close the socket.
 
bool is_open () const
 Tell if the server is open.
 
 operator bool () const
 Tell if the server is working.
 
template<typename SocketStream >
void accept (SocketStream &sock, int time_limit)
 

Static Public Member Functions

static bool init ()
 Initialize the use of the socket library. More...
 
static bool release ()
 Close the socket library. More...
 

Detailed Description

Class used to receive incoming connections.

Author
Julien Jorge

Definition at line 48 of file socket_server.hpp.

Constructor & Destructor Documentation

◆ socket_server() [1/2]

claw::net::socket_server::socket_server ( )

Constructor.

Postcondition
is_open() == false

Definition at line 38 of file socket_server.cpp.

◆ socket_server() [2/2]

claw::net::socket_server::socket_server ( int  port,
unsigned int  queue_size = s_default_queue_size 
)

Constructor, open the socket.

Parameters
portThe port to bind.
queue_sizeThe size of the waiting queue for incoming connections.

Definition at line 48 of file socket_server.cpp.

Member Function Documentation

◆ init()

bool claw::net::socket_server::init ( )
static

Initialize the use of the socket library.

Returns
true if the initialization is successful.

Definition at line 106 of file socket_server.cpp.

◆ open()

claw::net::socket_server * claw::net::socket_server::open ( int  port,
unsigned int  queue_size = s_default_queue_size 
)

Open the socket.

Parameters
portThe port to bind.
queue_sizeThe size of the waiting queue for incoming connections.
Returns
this if everything works fine, NULL otherwise.

Definition at line 60 of file socket_server.cpp.

◆ release()

bool claw::net::socket_server::release ( )
static

Close the socket library.

Returns
true if the operation is successful.

Definition at line 115 of file socket_server.cpp.


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