Base class for all UNIX socket classes. More...

#include <unixbase.hpp>

Inheritance diagram for libsocket::unix_socket:

[legend]

Public Member Functions
string	get_path (void)
	Returns the path we're bound or connected to. More...

virtual int	destroy (void)
	Destroys a socket. More...

int	getfd (void) const
	Returns the socket file descriptor. More...

int	set_sock_opt (int level, int optname, const char *optval, socklen_t optlen) const
	Set socket options on the underlying socket. More...

void	set_close_on_destructor (bool cod)

Protected Attributes
string	_path

int	sfd
	sfd is the sockets API file descriptor More...

bool	is_nonblocking

bool	close_on_destructor

Detailed Description

Base class for all UNIX socket classes.

This class provides only the data member _path and is used as base class for every socket class working with UNIX sockets.

Definition at line 53 of file unixbase.hpp.

Member Function Documentation

◆ get_path()

string libsocket::unix_socket::get_path ( void )

Returns the path we're bound or connected to.

Definition at line 50 of file unixbase.cpp.

◆ destroy()

int libsocket::socket::destroy ( void )

virtualinherited

Destroys a socket.

Return values

0	Fine!
<0	Most likely the socket was already closed before.

Definition at line 72 of file socket.cpp.

Here is the caller graph for this function:

◆ getfd()

int libsocket::socket::getfd ( void ) const

inherited

Returns the socket file descriptor.

Returns: The socket file descriptor of the class.

getfd() is a getter you may use to obtain the file descriptor for raw operations on it. It's relatively uncritical as libsocket just wraps other syscalls and doesn't manipulate it using unusual ways.

Definition at line 91 of file socket.cpp.

◆ set_sock_opt()

int libsocket::socket::set_sock_opt	(	int	level,
		int	optname,
		const char *	optval,
		socklen_t	optlen
	)		const

inherited

Set socket options on the underlying socket.

Returns: The return value of setsockopt(2).

Sets socket options using setsockopt(2). See setsockopt(2), tcp(7), udp(7), unix(7) for documentation on how to use this function.

Definition at line 101 of file socket.cpp.

◆ set_close_on_destructor()

void libsocket::socket::set_close_on_destructor ( bool cod )

inlineinherited

close_on_destructor is true by default. If set to false, do not call close(2) on the underlying socket in the destructor.

Definition at line 95 of file socket.hpp.

Member Data Documentation

◆ _path

string libsocket::unix_socket::_path

protected

The path we're connected (client stream) or bound (server stream, server datagram)

Definition at line 55 of file unixbase.hpp.

◆ sfd

int libsocket::socket::sfd

protectedinherited

sfd is the sockets API file descriptor

Definition at line 74 of file socket.hpp.

◆ close_on_destructor

bool libsocket::socket::close_on_destructor