tcp::Socket Class Reference

Encapsulates a socket handle that is capable of recieving epoll events. More...

#include <tcpsocket.h>

Public Member Functions
	Socket (EPoll &epoll, const int domain=AF_INET, const int socket=0, const bool blocking=false, const int events=(EPOLLIN|EPOLLRDHUP))
	Construct a blocking or non-blocking socket handle that responds to certain epoll events. More...
	~Socket ()
	Closes and destroys the socket. More...
int	socket () const
	Return the linux socket handle.
int	domain () const
	Return the socket domain (AF_INET or AF_INET6)
virtual void	disconnect ()
	Shuts down the socket gracefully.

Protected Member Functions
bool	setEvents (int events)
	Changes which epoll events the socket listens for. More...
virtual void	handleEvents (uint32_t events)=0
	Called when the socket recieves an epoll event. More...
virtual void	disconnected ()
	Called when a connection is disconnected due to a network error. More...
EPoll &	epoll ()
	Returns a reference to the epoll instance used by this socket.

Protected Attributes
recursive_mutex	mtx
	The mutex used to provide exclusive access to the socket.
SocketState	state_
	Descendant classes can manipulate the socket state directly.

Friends
class	EPoll

Detailed Description

Encapsulates a socket handle that is capable of recieving epoll events.

Definition at line 96 of file tcpsocket.h.

Constructor & Destructor Documentation

Socket()

tcp::Socket::Socket	(	EPoll &	epoll,
		const int	domain = AF_INET,
		const int	socket = 0,
		const bool	blocking = false,
		const int	events = (EPOLLIN | EPOLLRDHUP)
	)

Construct a blocking or non-blocking socket handle that responds to certain epoll events.

Parameters

domain	Either AF_INET or AF_INET6
socket	The socket handle to encapsulate. If 0 is provided, a socket handle will be automatically created.
blocking	If true, a blocking socket will be created. If false, a non-blocking socket will be created.
events	A bit flag of the epoll events to register interest include

Remarks

A client or server listener will typically call the constructor with socket=0 to start with a new socket.

A server session will create a Socket by providing the socket handle returned from an accept command.

Definition at line 97 of file tcpsocket.cpp.

                                                                                                      : epoll_(epoll), events_(events), domain_(domain), socket_(socket) 
{ 
  if ((domain != AF_INET) && (domain != AF_INET6)) {
    error("Socket","Only IPv4 and IPv6 are supported.");
    return;
  }
  if (socket < 0) {
    error("Socket","Socket parameter is < 0");
    return;
  }
  mtx.lock();
  if (socket == 0) {
    socket_ = ::socket(domain,SOCK_STREAM,0);
    if (socket_ == -1) {
      error("socket", strerror(errno));
    }
  }
  int flags = fcntl(socket_,F_GETFL,0);
  if (flags == -1) {
    error("fcntl (get)",strerror(errno));
  } else {
    if (!blocking) {
      flags |= O_NONBLOCK;
    } else {
      flags = flags & ~O_NONBLOCK;
    }
    if (fcntl(socket_,F_SETFL,flags) == -1) {
      error("fcntl (set)",strerror(errno));
    }
  }
  
  if (!epoll_.add(*this,events)) {
    error("Unable to add socket to epoll");
  }
  
  mtx.unlock();
}

Here is the call graph for this function:

~Socket()

tcp::Socket::~Socket

(

)

Closes and destroys the socket.

Remarks

An active socket should first be shut down using the disconnect() command

Definition at line 135 of file tcpsocket.cpp.

{
  if (socket_ > 0) {
    mtx.lock();
    epoll_.remove(*this);
    if (::close(socket_) == -1) {
      error("close",strerror(errno));
    } 
    socket_ = 0;
    mtx.unlock();
  }
}

Here is the call graph for this function:

Member Function Documentation

disconnected()

void tcp::Socket::disconnected ( )

protectedvirtual

Called when a connection is disconnected due to a network error.

Sets the socket state to DISCONNECTED and frees its resources. Override disconnected to perform additional cleanup of a dropped socket connection.

Reimplemented in tcp::DataSocket, and tcp::Session.

Definition at line 173 of file tcpsocket.cpp.

{
  mtx.lock();
  if (state_ != SocketState::DISCONNECTED) {
    ::close(socket_);
    socket_ = 0;
    state_ = SocketState::DISCONNECTED;
    log("Disconnected");
  } else {
    warning("Already disconnected");
  }
  mtx.unlock();
}

Here is the caller graph for this function:

handleEvents()

virtual void tcp::Socket::handleEvents ( uint32_t  events )

protectedpure virtual

Called when the socket recieves an epoll event.

Descendant classes override this abstract method to respond to epoll events

Parameters

events

A bitmask of event flags. See the epoll documentation

Implemented in tcp::DataSocket, tcp::Client, and tcp::Server.

setEvents()

bool tcp::Socket::setEvents ( int  events )

protected

Changes which epoll events the socket listens for.

Descendant classes may want to override this

Parameters

events

A bitmask of event flags. See the epoll documentation

Definition at line 148 of file tcpsocket.cpp.

{ 
  mtx.lock();
  bool result = false;
  if (events != events_) { 
    if (epoll_.update(*this,events)) { 
      events_ = events; 
      result = true;
    } 
  } else {
    result = true;
  }
  mtx.unlock();
  return result;
}

Here is the caller graph for this function:

---

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

• include/tcpsocket.h
• src/tcpsocket.cpp