Network::Socket Class Reference

This class represent an abstract socket connection (udp | tcp server | tcp client) More...

#include <socket.hh>

Inheritance diagram for Network::Socket:

Public Member Functions
	Socket (SOCKET_KIND kind, SOCKET_VERSION version=V4)
	Socket (SOCKET_KIND kind, PROTO_KIND pkind, SOCKET_VERSION version=V4)
virtual	~Socket ()
void	write (const std::string &str)
	function used by << operator (write a string on current socket)
bool	connected () const
	return true when socket is connected
int	get_socket ()
	get socket (fd) warning: be very carefull with this method
void	add_delim (const std::string &delim)
	set the delimitor for the text mode
void	del_delim (const std::string &delim)
	delete this delimitor for the socket
void	allow_empty_lines ()
	, if set, empty lines will be returned in text procols (if not, they are skipped)
void	init_tls (GnuTLSKind kind, unsigned size=1024, const std::string &certfile="", const std::string &keyfile="", const std::string &trustfile="", const std::string &crlfile="")
void	enable_tls ()
	Enable TLS on socket.
virtual std::string	read ()=0
	function used by >> operator (read a string on current socket)
virtual std::string	read (int timeout)=0
	read a string with a timeout
virtual std::string	readn (unsigned int size)=0
	read a string from socket
virtual std::string	readn (int timeout, unsigned int size)=0
	read a string with a timeout

Protected Member Functions
void	_close (int socket) const
	Close a connnection.
void	_listen (int socket) const
	Listen on port.
virtual std::string	_read_line (int socket)=0
	Get a line from socket (when used with textual protocol)
virtual std::string	_read_line_bin (int socket, unsigned int size)=0
	Get a line from socket (when used with binary protocol)
void	_write_str (int socket, const std::string &str) const
	Write a string to a socket (when used with textual protocol)
void	_write_str_bin (int socket, const std::string &str) const
	Write a string to a socket (when used with binary protocol)
void	_set_timeout (bool enable, int socket, int timeout)
	set a timeout on a socket
std::pair< int, int >	_find_delim (const std::string &str, int start) const
bool	_update_buffer (std::pair< int, int > &delim, int &i, std::string &str)
	look delimiter and remove delimiter at begining of buffer if needed
bool	_check_answer (int res, std::string &str)
	return the content of the buffer is there is

Protected Attributes
SOCKET_KIND	_kind
SOCKET_VERSION	_version
unsigned	_state_timeout
int	_socket
int	_recv_flags
struct sockaddr_in	_addr
PROTO_KIND	_proto_kind
std::list< std::string >	_delim
bool	_empty_lines
std::string	_buffer
bool	_tls

Detailed Description

This class represent an abstract socket connection (udp | tcp server | tcp client)

Author

Julien Lemoine <speedblue at happycoders dot org>

Definition at line 100 of file socket.hh.

Constructor & Destructor Documentation

Socket() [1/2]

Network::Socket::Socket	(	SOCKET_KIND	kind,
		SOCKET_VERSION	version = V4
	)

Definition at line 31 of file socket.cc.

                                                         :
    _kind(kind), _version(version), _state_timeout(0),
    _socket(0), _recv_flags(kind), _proto_kind(text), _empty_lines(false),
    _buffer(""), _tls(false)
  {
    _delim.push_back("\0");
#ifdef LIBSOCKET_WIN
    WSADATA wsadata;
    if (WSAStartup(MAKEWORD(1, 1), &wsadata) != 0)
      throw WSAStartupError("WSAStartup failed", HERE);
#endif
#ifndef IPV6_ENABLED
    if (version == V6)
      throw Ipv6SupportError("lib was not compiled with ipv6 support", HERE);
#endif
  }

References _delim, HERE, and Network::V6.

Socket() [2/2]

Network::Socket::Socket	(	SOCKET_KIND	kind,
		PROTO_KIND	pkind,
		SOCKET_VERSION	version = V4
	)

Definition at line 48 of file socket.cc.

                                                                           :
    _kind(kind), _version(version), _state_timeout(0),
    _socket(0), _recv_flags(kind), _proto_kind(pkind), _empty_lines(false),
    _buffer(""), _tls(false)
  {
    _delim.push_back("\0");
#ifdef LIBSOCKET_WIN
    WSADATA wsadata;
    if (WSAStartup(MAKEWORD(1, 1), &wsadata) != 0)
      throw WSAStartupError("WSAStartup failed", HERE);
#endif
#ifndef IPV6_ENABLED
    if (version == V6)
      throw Ipv6SupportError("lib was not compiled with ipv6 support", HERE);
#endif
  }

References _delim, HERE, and Network::V6.

~Socket()

Network::Socket::~Socket ( )

virtual

Definition at line 65 of file socket.cc.

  {
  }

Member Function Documentation

_check_answer()

bool Network::Socket::_check_answer ( int  res, std::string &  str  )

inlineprotected

return the content of the buffer is there is

Definition at line 28 of file socket.hxx.

  {
    if (res <= 0)
      {
        if (!_buffer.size()) // No more data...
          throw ConnectionClosed("Connection Closed", HERE);
        else
          {
            str += _buffer;
            _buffer = "";
            _state_timeout = 0;
            return true;
          }
      }
    return false;
  }

References _buffer, _state_timeout, and HERE.

Referenced by Network::NetSocket::_read_line(), and Network::NetSocket::_read_line().

_close()

void Network::Socket::_close ( int  socket ) const

protected

Close a connnection.

Exceptions

CloseException

when close libc function return a negative value

Definition at line 167 of file socket.cc.

  {
#ifndef LIBSOCKET_WIN
    if (socket < 0 || close(socket) < 0)
      throw CloseError("Close Error", HERE);
    socket = 0;
#else
    if (socket < 0 || closesocket(socket) < 0)
      throw CloseError("Close Error", HERE);
    socket = 0;
#endif
#ifdef TLS
    if (_tls)
      {
        std::cout << "Deletion..." << std::endl;
        gnutls_deinit(_session);
        if (_tls_main)
          {
            gnutls_certificate_free_credentials(_x509_cred);
            gnutls_global_deinit();
          }
      }
#endif
  }

References _tls, and HERE.

Referenced by Network::LocalSocket::close(), Network::TcpSocket::close(), and Network::UdpSocket::close().

_find_delim()

std::pair< int, int > Network::Socket::_find_delim ( const std::string &  str, int  start  ) const

protected

Definition at line 339 of file socket.cc.

  {
    int                                         i = -1;
    int                                         pos = -1, size = 0;
    std::list<std::string>::const_iterator      it;
 
    // Looking for the first delimiter.
    if (_delim.size() > 0)
      {
        it = _delim.begin();
        while (it != _delim.end())
          {
            if (*it == "")
              i = str.find('\0', start);
            else
              i = str.find(*it, start);
            if ((i >= 0) && ((unsigned int)i < str.size()) &&
                (pos < 0 || i < pos))
              {
                pos = i;
                size = it->size() ? it->size() : 1;
              }
            it++;
          }
      }
    return std::pair<int, int>(pos, size);
  }

References _delim.

Referenced by _update_buffer().

_listen()

void Network::Socket::_listen ( int  socket ) const

protected

Listen on port.

Exceptions

ListenException

when listen libc function return a negative value

Definition at line 192 of file socket.cc.

  {
    if (socket < 0 || listen(socket, 5) < 0)
      throw ListenError("Listen Error", HERE);
  }

References HERE.

Referenced by Network::TcpSocket::connect().

_read_line()

virtual std::string Network::Socket::_read_line ( int  socket )

protectedpure virtual

Get a line from socket (when used with textual protocol)

Exceptions

NoConnection	when there is no open socket
ConnectionClosed	when there is no more connection

Implemented in Network::LocalSocket, and Network::NetSocket.

_read_line_bin()

virtual std::string Network::Socket::_read_line_bin ( int  socket, unsigned int  size  )

protectedpure virtual

Get a line from socket (when used with binary protocol)

Exceptions

NoConnection	when there is no open socket
ConnectionClosed	when there is no more connection

Implemented in Network::TcpSocket, Network::LocalSocket, Network::UdpSocket, and Network::NetSocket.

_set_timeout()

void Network::Socket::_set_timeout ( bool  enable, int  socket, int  timeout  )

protected

set a timeout on a socket

Parameters

timeout

is in second

Exceptions

Timeout	when there is a timeout
SelectError	when select libc function return a negative value

Definition at line 272 of file socket.cc.

  {
    fd_set              fdset;
    struct timeval      timetowait;
    int         res;
 
    if (enable)
      timetowait.tv_sec = timeout;
    else
      timetowait.tv_sec = 65535;
    timetowait.tv_usec = 0;
    FD_ZERO(&fdset);
    FD_SET(socket, &fdset);
    if (enable)
      res = select(socket + 1, &fdset, NULL, NULL, &timetowait);
    else
      res = select(socket + 1, &fdset, NULL, NULL, NULL);
    if (res < 0)
      throw SelectError("Select error", HERE);
    if (res == 0)
      throw Timeout("Timeout on socket", HERE);
  }

References HERE.

Referenced by Network::NetSocket::_read_line(), Network::NetSocket::_read_line(), Network::NetSocket::read(), Network::LocalSocket::read(), Network::NetSocket::read(), Network::LocalSocket::read(), Network::NetSocket::readn(), Network::LocalSocket::readn(), Network::NetSocket::readn(), and Network::LocalSocket::readn().

_update_buffer()

bool Network::Socket::_update_buffer ( std::pair< int, int > &  delim, int &  i, std::string &  str  )

inlineprotected

look delimiter and remove delimiter at begining of buffer if needed

Definition at line 45 of file socket.hxx.

  {
    delim = _find_delim(_buffer, 0);
    i = delim.first;
    while (!_empty_lines && !i)
      {
        // remove delimiter in front of buffer
        _buffer = _buffer.substr(delim.second, _buffer.size() - delim.second);
        delim = _find_delim(_buffer, 0);
        i = delim.first;
      }
    if ((i > 0 || _empty_lines) && ((unsigned int)i < _buffer.size()))
      {
        str = _buffer.substr(0, i);
        _buffer = _buffer.substr(i + delim.second, 
                                 _buffer.size() - i - delim.second);
        return true;
      }
    else 
      return false;
  }

References _buffer, _empty_lines, and _find_delim().

Referenced by Network::LocalSocket::_read_line(), Network::NetSocket::_read_line(), Network::NetSocket::_read_line(), and Network::LocalSocket::_read_line().

_write_str()

void Network::Socket::_write_str ( int  socket, const std::string &  str  ) const

protected

Write a string to a socket (when used with textual protocol)

Exceptions

NoConnection	when there is no open socket
ConnectionClosed	when there is no more connection

Definition at line 198 of file socket.cc.

  {
    int                         res = 1;
    unsigned int                count = 0;
    const char                  *buf;
 
    buf = str.c_str();
    if (socket < 0)
      throw NoConnection("No Socket", HERE);
    while (res && count < str.size())
      {
#ifdef IPV6_ENABLED
        if (V4 == _version)
#endif
#ifdef TLS
          if (_tls)
            res = gnutls_record_send(_session, buf + count, str.size() - count);
          else
#endif
            res = sendto(socket, buf + count, str.size() - count, SENDTO_FLAGS,
                         (const struct sockaddr*)&_addr, sizeof(_addr));
#ifdef IPV6_ENABLED
        else
          res = sendto(socket, buf + count, str.size() - count, SENDTO_FLAGS,
                       (const struct sockaddr*)&_addr6, sizeof(_addr6));
#endif
        if (res <= 0)
          throw ConnectionClosed("Connection Closed", HERE);
        count += res;
      }
  }

References _addr, _tls, _version, HERE, SENDTO_FLAGS, and Network::V4.

Referenced by write().

_write_str_bin()

void Network::Socket::_write_str_bin ( int  socket, const std::string &  str  ) const

protected

Write a string to a socket (when used with binary protocol)

Exceptions

NoConnection	when there is no open socket
ConnectionClosed	when there is no more connection

Definition at line 230 of file socket.cc.

  {
    int                         res = 1;
    unsigned int                count = 0;
#ifdef LIBSOCKET_WIN
    char*                       buf = new char[str.size() + 2];
#else
    char                        buf[str.size() + 2];
#endif
    buf[0] = str.size() / 256;
    buf[1] = str.size() % 256;
    memcpy(buf + 2, str.c_str(), str.size());
    if (socket < 0)
      throw NoConnection("No Socket", HERE);
    while (res && count < str.size() + 2)
      {
#ifdef IPV6_ENABLED
        if (V4 == _version)
#endif
#ifdef TLS
          if (_tls)
            res = gnutls_record_send(_session, buf + count, str.size() + 2 - count);
          else
#endif
            res = sendto(socket, buf + count, str.size() + 2 - count, 
                         SENDTO_FLAGS,
                         (const struct sockaddr*)&_addr, sizeof(_addr));
#ifdef IPV6_ENABLED
        else
          res = sendto(socket, buf + count, str.size() + 2 - count, 
                       \   SENDTO_FLAGS,
                       (const struct sockaddr*)&_addr6, sizeof(_addr6));
#endif
        if (res <= 0)
          throw ConnectionClosed("Connection Closed", HERE);
        count += res;
      }
#ifdef LIBSOCKET_WIN
    delete[] buf;
#endif
  }

References _addr, _tls, _version, HERE, SENDTO_FLAGS, and Network::V4.

Referenced by write().

add_delim()

void Network::Socket::add_delim

(

const std::string &

delim

)

set the delimitor for the text mode

Definition at line 318 of file socket.cc.

  {
    _delim.push_back(delim);
  }

References _delim.

allow_empty_lines()

void Network::Socket::allow_empty_lines

(

)

, if set, empty lines will be returned in text procols (if not, they are skipped)

Definition at line 308 of file socket.cc.

  {
    _empty_lines = true;
  }

References _empty_lines.

connected()

bool Network::Socket::connected

(

)

const

return true when socket is connected

Definition at line 303 of file socket.cc.

  {
    return _socket != 0;
  }

References _socket.

Referenced by enable_tls().

del_delim()

void Network::Socket::del_delim

(

const std::string &

delim

)

delete this delimitor for the socket

Definition at line 323 of file socket.cc.

  {
    std::list<std::string>::iterator    it, it2;
 
    for (it = _delim.begin(); it != _delim.end(); )
      {
        if (*it == delim)
          {
            it2 = it++;
            _delim.erase(it2);
          }
        else
          it++;
      }
  }

References _delim.

enable_tls()

void Network::Socket::enable_tls

(

)

Enable TLS on socket.

Definition at line 69 of file socket.cc.

  {
#ifdef TLS
    int         ret;
 
    if (_kind != TCP)
      throw TLSError("You need to have a TCP connection", HERE);
    if (!connected())
      throw NoConnection("You need to have a connection", HERE);
    
    gnutls_transport_set_ptr(_session, (gnutls_transport_ptr)_socket);
    ret = gnutls_handshake(_session);
    if (ret < 0)
      {
        close(_socket);
        gnutls_deinit(_session);
        throw TLSError(gnutls_strerror(ret), HERE);
      }
#else
    throw TLSSupportError("lib was not compiled with TLS support", HERE);
#endif
  }

References _kind, _socket, connected(), HERE, and Network::TCP.

Referenced by Network::TcpSocket::accept().

get_socket()

int Network::Socket::get_socket

(

)

get socket (fd) warning: be very carefull with this method

Definition at line 313 of file socket.cc.

  {
    return _socket;
  }

References _socket.

init_tls()

void Network::Socket::init_tls	(	GnuTLSKind	kind,
		unsigned	size = 1024,
		const std::string &	certfile = "",
		const std::string &	keyfile = "",
		const std::string &	trustfile = "",
		const std::string &	crlfile = ""
	)

Exceptions

TLSSupportError

when TLS is not enabled

Definition at line 92 of file socket.cc.

  {
#ifdef TLS
    static bool                                 init = false;
    static gnutls_dh_params                     dh_params;
    const int protocol_tls[] = { GNUTLS_TLS1, 0 };
    const int protocol_ssl[] = { GNUTLS_SSL3, 0 };
    const int cert_type_priority[] = { GNUTLS_CRT_X509, 
                                       GNUTLS_CRT_OPENPGP, 0 };
 
    if (!init)
      {
        gnutls_global_init();
        init = true;
      }
    _tls = true;
    _tls_main = true;
    gnutls_certificate_allocate_credentials(&_x509_cred);
    if (keyfile.size() > 0 && certfile.size() > 0)
      {
        std::ifstream key(keyfile.c_str()), cert(certfile.c_str());
        if (!key.is_open() || !cert.is_open())
          throw InvalidFile("key or cert invalid", HERE);
        key.close();
        cert.close();
        // Only for server...
        _nbbits = size;
        if (trustfile.size() > 0)
          gnutls_certificate_set_x509_trust_file(_x509_cred, trustfile.c_str(), 
                                                 GNUTLS_X509_FMT_PEM);
        if (crlfile.size() > 0)
          gnutls_certificate_set_x509_crl_file(_x509_cred, crlfile.c_str(), 
                                               GNUTLS_X509_FMT_PEM);
        gnutls_certificate_set_x509_key_file(_x509_cred, certfile.c_str(), 
                                             keyfile.c_str(), 
                                             GNUTLS_X509_FMT_PEM);
        gnutls_dh_params_init(&dh_params);
        gnutls_dh_params_generate2(dh_params, _nbbits);
        gnutls_certificate_set_dh_params(_x509_cred, dh_params);
 
        if (gnutls_init(&_session, GNUTLS_SERVER))
          throw TLSError("gnutls_init failed", HERE);
      }
    else
      {
        if (gnutls_init(&_session, GNUTLS_CLIENT))
          throw TLSError("gnutls_init failed", HERE);
      }
    
    gnutls_set_default_priority(_session);
    if (kind == TLS)
      gnutls_protocol_set_priority(_session, protocol_tls);
    else
      gnutls_protocol_set_priority(_session, protocol_ssl);
 
    if (keyfile.size() > 0 && certfile.size() > 0)
      {
        gnutls_credentials_set(_session, GNUTLS_CRD_CERTIFICATE, _x509_cred);
        gnutls_certificate_server_set_request(_session, GNUTLS_CERT_REQUEST);
        gnutls_dh_set_prime_bits(_session, _nbbits);
      }
    else
      {
        gnutls_certificate_type_set_priority(_session, cert_type_priority);
        gnutls_credentials_set(_session, GNUTLS_CRD_CERTIFICATE, _x509_cred);
      }
#else
    throw TLSSupportError("lib was not compiled with TLS support", HERE);
#endif
  }

References _tls, and HERE.

read() [1/2]

virtual std::string Network::Socket::read ( )

pure virtual

function used by >> operator (read a string on current socket)

Implemented in Network::LocalSocket, and Network::NetSocket.

Referenced by Network::operator>>().

read() [2/2]

virtual std::string Network::Socket::read ( int  timeout )

pure virtual

read a string with a timeout

Implemented in Network::LocalSocket, and Network::NetSocket.

readn() [1/2]

virtual std::string Network::Socket::readn ( int  timeout, unsigned int  size  )

pure virtual

read a string with a timeout

Parameters

size	represente the number of byte to read

Implemented in Network::LocalSocket, and Network::NetSocket.

readn() [2/2]

virtual std::string Network::Socket::readn ( unsigned int  size )

pure virtual

read a string from socket

Parameters

size	represente the number of byte to read

Implemented in Network::LocalSocket, and Network::NetSocket.

write()

void Network::Socket::write

(

const std::string &

str

)

function used by << operator (write a string on current socket)

Definition at line 295 of file socket.cc.

  {
    if (_proto_kind == binary)
      _write_str_bin(_socket, str);
    else
      _write_str(_socket, str);
  }

References _proto_kind, _socket, _write_str(), _write_str_bin(), and Network::binary.

Referenced by Network::operator<<().

Member Data Documentation

_addr

struct sockaddr_in Network::Socket::_addr

protected

Definition at line 195 of file socket.hh.

Referenced by Network::NetSocket::_bind(), _write_str(), Network::NetSocket::_write_str(), _write_str_bin(), and Network::NetSocket::_write_str_bin().

_buffer

std::string Network::Socket::_buffer

protected

Definition at line 202 of file socket.hh.

Referenced by _check_answer(), Network::LocalSocket::_read_line(), Network::NetSocket::_read_line(), Network::NetSocket::_read_line(), Network::LocalSocket::_read_line(), Network::UdpSocket::_read_line_bin(), Network::TcpSocket::_read_line_bin(), Network::LocalSocket::_read_line_bin(), Network::TcpSocket::_read_line_bin(), Network::LocalSocket::_read_line_bin(), Network::UdpSocket::_read_line_bin(), _update_buffer(), Network::NetSocket::readn(), Network::LocalSocket::readn(), Network::NetSocket::readn(), and Network::LocalSocket::readn().

_delim

std::list<std::string> Network::Socket::_delim

protected

Definition at line 200 of file socket.hh.

Referenced by _find_delim(), add_delim(), del_delim(), Socket(), and Socket().

_empty_lines

bool Network::Socket::_empty_lines

protected

Definition at line 201 of file socket.hh.

Referenced by _update_buffer(), and allow_empty_lines().

_kind

SOCKET_KIND Network::Socket::_kind

protected

Definition at line 190 of file socket.hh.

Referenced by Network::NetSocket::_bind(), Network::NetSocket::_bind(), Network::NetSocket::_read_line(), Network::NetSocket::_read_line(), and enable_tls().

_proto_kind

PROTO_KIND Network::Socket::_proto_kind

protected

Definition at line 199 of file socket.hh.

Referenced by Network::TcpSocket::accept(), Network::LocalSocket::read(), Network::NetSocket::read(), Network::NetSocket::read(), Network::NetSocket::read(), Network::LocalSocket::read(), Network::NetSocket::read(), Network::LocalSocket::read(), Network::LocalSocket::read(), write(), Network::LocalSocket::writeto(), and Network::NetSocket::writeto().

_recv_flags

int Network::Socket::_recv_flags

protected

Definition at line 194 of file socket.hh.

_socket

int Network::Socket::_socket

protected

Definition at line 193 of file socket.hh.

Referenced by Network::NetSocket::_read_line(), Network::NetSocket::_read_line(), Network::TcpSocket::accept(), Network::LocalSocket::close(), Network::TcpSocket::close(), Network::UdpSocket::close(), Network::TcpSocket::connect(), Network::UdpSocket::connect(), Network::TcpSocket::connect(), Network::UdpSocket::connect(), connected(), enable_tls(), Network::TcpSocket::get_ip(), get_socket(), Network::LocalSocket::init(), Network::LocalSocket::read(), Network::NetSocket::read(), Network::NetSocket::read(), Network::NetSocket::read(), Network::LocalSocket::read(), Network::NetSocket::read(), Network::LocalSocket::read(), Network::LocalSocket::read(), Network::NetSocket::readn(), Network::NetSocket::readn(), Network::LocalSocket::readn(), Network::NetSocket::readn(), Network::LocalSocket::readn(), Network::LocalSocket::readn(), Network::LocalSocket::readn(), Network::NetSocket::readn(), Network::TcpSocket::TcpSocket(), Network::TcpSocket::TcpSocket(), write(), Network::LocalSocket::writeto(), and Network::NetSocket::writeto().

_state_timeout

unsigned Network::Socket::_state_timeout

protected

Definition at line 192 of file socket.hh.

Referenced by _check_answer(), Network::LocalSocket::_read_line(), Network::NetSocket::_read_line(), Network::NetSocket::_read_line(), Network::LocalSocket::_read_line(), Network::NetSocket::read(), Network::LocalSocket::read(), Network::NetSocket::read(), and Network::LocalSocket::read().

_tls

bool Network::Socket::_tls

protected

Definition at line 203 of file socket.hh.

Referenced by _close(), Network::NetSocket::_read_line(), Network::NetSocket::_read_line(), Network::TcpSocket::_read_line_bin(), Network::TcpSocket::_read_line_bin(), _write_str(), Network::NetSocket::_write_str(), _write_str_bin(), Network::NetSocket::_write_str_bin(), Network::TcpSocket::accept(), and init_tls().

_version

SOCKET_VERSION Network::Socket::_version

protected

Definition at line 191 of file socket.hh.

Referenced by Network::NetSocket::_accept(), Network::NetSocket::_bind(), Network::NetSocket::_bind(), Network::NetSocket::_connect(), Network::NetSocket::_read_line(), Network::UdpSocket::_read_line_bin(), Network::TcpSocket::_read_line_bin(), _write_str(), Network::NetSocket::_write_str(), _write_str_bin(), Network::NetSocket::_write_str_bin(), and Network::TcpSocket::accept().

---

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

• socket.hh
• socket.cc
• socket.hxx