booster::aio::basic_socket Class Reference

This class represents a basic Socket object. More...

#include <booster/booster/aio/basic_socket.h>

Inheritance diagram for booster::aio::basic_socket:

List of all members.

Public Types
enum	boolean_option_type { tcp_no_delay, keep_alive, reuse_address }
Public Member Functions
	basic_socket ()
	basic_socket (io_service &srv)
void	open (family_type d, socket_type t)
void	open (family_type d, socket_type t, system::error_code &e)
endpoint	local_endpoint (system::error_code &e)
endpoint	local_endpoint ()
endpoint	remote_endpoint (system::error_code &e)
endpoint	remote_endpoint ()
bool	get_option (boolean_option_type opt, system::error_code &e)
bool	get_option (boolean_option_type opt)
void	set_option (boolean_option_type opt, bool v, system::error_code &e)
void	set_option (boolean_option_type opt, bool v)

---

Detailed Description

This class represents a basic Socket object.

---

Member Enumeration Documentation

enum booster::aio::basic_socket::boolean_option_type

Boolean socket options list

---

Constructor & Destructor Documentation

booster::aio::basic_socket::basic_socket

(

)

Create a new socket object

booster::aio::basic_socket::basic_socket

(

io_service &

srv

)

Create a new socket object and connect to the io_service srv

---

Member Function Documentation

bool booster::aio::basic_socket::get_option	(	boolean_option_type	opt,
		system::error_code &	e
	)

Get a value for a boolean_option_type

If a error occurs it is assigned to e.

bool booster::aio::basic_socket::get_option

(

boolean_option_type

opt

)

Get a value for a boolean_option_type Throws system::system_error if error occurs.

endpoint booster::aio::basic_socket::local_endpoint

(

)

Get a local endpoint for the socket

Throws system::system_error if error occurs.

endpoint booster::aio::basic_socket::local_endpoint

(

system::error_code &

e

)

Get a local endpoint for the socket

If a error occurs it is assigned to e.

void booster::aio::basic_socket::open	(	family_type	d,
		socket_type	t,
		system::error_code &	e
	)

Opens a new stream socket of a family_type d

If a error occurs it is assigned to e.

void booster::aio::basic_socket::open	(	family_type	d,
		socket_type	t
	)

Open a socket of family_type d and of the protocol (socket_type) t

Throws system::system_error if error occurs.

endpoint booster::aio::basic_socket::remote_endpoint

(

system::error_code &

e

)

Get a remote endpoint for the socket

If a error occurs it is assigned to e.

endpoint booster::aio::basic_socket::remote_endpoint

(

)

Get a remote endpoint for the socket

Throws system::system_error if error occurs.

void booster::aio::basic_socket::set_option	(	boolean_option_type	opt,
		bool	v,
		system::error_code &	e
	)

Set a value for a boolean_option_type

If a error occurs it is assigned to e.

void booster::aio::basic_socket::set_option	(	boolean_option_type	opt,
		bool	v
	)

Set a value for a boolean_option_type

Throws system::system_error if error occurs.

---

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

• booster/aio/basic_socket.h