utilmm::base_socket Class Reference
[OS-related tools]

#include <socket.hh>

Inheritance diagram for utilmm::base_socket:

[legend]

List of all members.

Classes
struct	bad_address
Public Types
enum	Domain { Unix, Inet }
enum	Type { Stream, Datagram }
enum	Wait { WaitRead = 1, WaitWrite = 2, WaitException = 4 }
Public Member Functions
	base_socket (Domain domain, Type type)
	base_socket (int fd)
int	fd () const
void	flush () const
bool	try_wait (int what) const
void	wait (int what) const
	~base_socket ()
Protected Member Functions
std::vector< uint8_t >	to_sockaddr (std::string const &to) const
Private Member Functions
int	wait (int what, timeval *tv) const
Static Private Member Functions
static int	to_unix (Type t)
static int	to_unix (Domain d)
Private Attributes
Domain	m_domain
int	m_fd
Type	m_type

---

Detailed Description

Base class for sockets

Definition at line 16 of file socket.hh.

---

Member Enumeration Documentation

enum utilmm::base_socket::Domain

Enumerator:

Unix
Inet

Definition at line 19 of file socket.hh.

enum utilmm::base_socket::Type

Enumerator:

Stream
Datagram

Definition at line 20 of file socket.hh.

enum utilmm::base_socket::Wait

Enumerator:

WaitRead
WaitWrite
WaitException

Definition at line 21 of file socket.hh.

---

Constructor & Destructor Documentation

utilmm::base_socket::base_socket

(

int

fd

)

Definition at line 44 of file socket.cc.

utilmm::base_socket::base_socket	(	Domain	domain,
		Type	type
	)

Definition at line 46 of file socket.cc.

utilmm::base_socket::~base_socket

(

)

Closes the socket

Definition at line 56 of file socket.cc.

---

Member Function Documentation

int utilmm::base_socket::fd

(

)

const

Get the socket file descriptor

Definition at line 124 of file socket.cc.

void utilmm::base_socket::flush

(

)

const

Flush all buffers related to this socket

Definition at line 160 of file socket.cc.

vector< uint8_t > utilmm::base_socket::to_sockaddr

(

std::string const &

to

)

const [protected]

Definition at line 62 of file socket.cc.

int utilmm::base_socket::to_unix

(

Type

t

)

[static, private]

Definition at line 34 of file socket.cc.

int utilmm::base_socket::to_unix

(

Domain

d

)

[static, private]

Definition at line 24 of file socket.cc.

bool utilmm::base_socket::try_wait

(

int

what

)

const

Non-blocking version of wait

Parameters:

what

an OR-ed field of values in the Wait enum

Returns:

true if the event was present and false otherwise

Definition at line 125 of file socket.cc.

void utilmm::base_socket::wait

(

int

what

)

const

Blocks until one of the specified events is detected on this socket

Parameters:

what

an OR-ed field of values in the Wait enum

Definition at line 130 of file socket.cc.

int utilmm::base_socket::wait	(	int	what,
		timeval *	tv
	)			const [private]

Definition at line 131 of file socket.cc.

---

Member Data Documentation

Domain utilmm::base_socket::m_domain [private]

Definition at line 30 of file socket.hh.

int utilmm::base_socket::m_fd [private]

Definition at line 29 of file socket.hh.

Type utilmm::base_socket::m_type [private]

Definition at line 31 of file socket.hh.

---

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

• socket.hh
• socket.cc