tcp::DataSocket Class Reference

Represents a buffered socket that can send and receive data using optional SSL encryption. More...

#include <tcpsocket.h>

Collaboration diagram for tcp::DataSocket:

Public Member Functions
	DataSocket (EPoll &epoll, const int domain=AF_INET, const int socket=0, const bool blocking=false, const int events=(EPOLLIN|EPOLLRDHUP))
size_t	available ()
	Returns the number of bytes available in the inputBuffer.
size_t	read (void *buffer, size_t size)
	Reads up to size bytes from inputBuffer into buffer. More...
size_t	write (const void *buffer, size_t size)
	Writes the contents of buffer to the outputBuffer. More...
Public Member Functions inherited from 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. 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)

Protected Member Functions
void	readToInputBuffer ()
	Reads all available data from the socket into inputBuffer.
void	sendOutputBuffer ()
	Writes all available data from the outputBuffer to the socket. More...
void	canSend (bool value)
	Sets the epoll event flags. More...
void	handleEvents (uint32_t events) override
	Called by the EPoll class when the listening socket recieves an epoll event. More...
void	disconnect () override
	Shuts down any SSL connection gracefully. More...
void	disconnected () override
	Called when a connection is disconnected. More...
virtual void	dataAvailable ()=0
	Called whenever new data is appended to the inputBuffer. More...
virtual SSL *	createSSL (SSLContext *context)
	Factory method for returning an SSL object. More...
Protected Member Functions inherited from tcp::Socket
bool	setEvents (int events)
	Changes which epoll events the socket listens for. More...
EPoll &	epoll ()
	Returns a reference to the epoll instance used by this socket.

Protected Attributes
SSL *	ssl_ {nullptr}
	Exposes the underlying SSL record used for openSSL calls to descendant classes.
Protected Attributes inherited from tcp::Socket
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	SSL

Detailed Description

Represents a buffered socket that can send and receive data using optional SSL encryption.

This class provides properties and methods common to both the Client and Session classes

Definition at line 159 of file tcpsocket.h.

Member Function Documentation

canSend()

void tcp::DataSocket::canSend ( bool  value )

protected

Sets the epoll event flags.

The flags will include EPOLLOUT if value==true

Definition at line 247 of file tcpsocket.cpp.

{
  int events = EPOLLIN | EPOLLRDHUP;
  if (value)
    events |= EPOLLOUT;
  setEvents(events);
}

Here is the call graph for this function:

Here is the caller graph for this function:

createSSL()

SSL * tcp::DataSocket::createSSL ( SSLContext *  context )

protectedvirtual

Factory method for returning an SSL object.

Override to replace the SSL class used.

Definition at line 348 of file tcpsocket.cpp.

{
  if (context) {
    return new SSL(*this,*context);
  } else {
    return nullptr;
  }
}

dataAvailable()

virtual void tcp::DataSocket::dataAvailable ( )

protectedpure virtual

Called whenever new data is appended to the inputBuffer.

Clients should override the dataAvailable method to do something in response to received data

disconnect()

void tcp::DataSocket::disconnect ( )

overrideprotectedvirtual

Shuts down any SSL connection gracefully.

Socket::disconnect() is called to shutdown the underlying socket

Reimplemented from tcp::Socket.

Definition at line 189 of file tcpsocket.cpp.

{ 
  mtx.lock();
  if (ssl_ && (state_ == SocketState::CONNECTED)) {
    ssl_->shutdown();
    delete ssl_;
    ssl_ = nullptr;
    printSSLErrors();
  }
  mtx.unlock();
  Socket::disconnect();
}

disconnected()

void tcp::DataSocket::disconnected ( )

overrideprotectedvirtual

Called when a connection is disconnected.

Frees the SSL object that is associated with the connection

Reimplemented from tcp::Socket.

Definition at line 202 of file tcpsocket.cpp.

{
  mtx.lock();  // Do I need to use lock here?
  if (ssl_) {
    delete ssl_;
    ssl_ = nullptr;
    printSSLErrors();
  }
  mtx.unlock();
  Socket::disconnected();
}

Here is the call graph for this function:

Here is the caller graph for this function:

handleEvents()

void tcp::DataSocket::handleEvents ( uint32_t  events )

overrideprotectedvirtual

Called by the EPoll class when the listening socket recieves an epoll event.

Calls either disconnected(), readToInputBuffer() + dataAvailable() or sendOutputBuffer() depending on the events that have been set.

Implements tcp::Socket.

Definition at line 255 of file tcpsocket.cpp.

{
  if (state_ == SocketState::CONNECTED) {
    if (events & EPOLLRDHUP) {
      disconnected();
    } else {
      if (events & EPOLLIN) {
        mtx.lock();
        readToInputBuffer();
        dataAvailable();
        if (outputBuffer.size() > 0U) {
          sendOutputBuffer();
          canSend(outputBuffer.size() > 0U);
        } else {
          canSend(false);  
        }
        mtx.unlock();
      }
      if (events & EPOLLOUT) {
        mtx.lock();
        sendOutputBuffer();
        canSend(outputBuffer.size() > 0U);
        mtx.unlock();
      }
    }
  }
}

read()

size_t tcp::DataSocket::read	(	void *	buffer,
		size_t	size
	)

Reads up to size bytes from inputBuffer into buffer.

Returns

The number of bytes actually read

Definition at line 313 of file tcpsocket.cpp.

{
  size_t result = 0;
  if (size) {
    mtx.lock();
    result = max<size_t>(size,inputBuffer.size());
    if (result > 0) {
      for (size_t i=0;i<result;++i) {
        ((uint8_t*)buffer)[i] = inputBuffer.at(0);
        inputBuffer.pop_front();
      }
    }
    mtx.unlock();
  }
  return result;
}

sendOutputBuffer()

void tcp::DataSocket::sendOutputBuffer ( )

protected

Writes all available data from the outputBuffer to the socket.

Any data that could not be written will be retained in the outputBuffer and sent with the next call to sendOutputBuffer()

Definition at line 226 of file tcpsocket.cpp.

{
  mtx.lock();
  size_t size = outputBuffer.size();
  if (size == 0) return;
  uint8_t *buffer = (uint8_t*)malloc(size);
  for (size_t i=0;i<size;i++) {
    buffer[i] = outputBuffer.at(0);
    outputBuffer.pop_front();
  }
  size_t res = write_(buffer,size);
  canSend(res!=size);
  if (res != size) {
    for (size_t i=res;i<size;i++) {
      outputBuffer.push_front(buffer[i]);
    }
  }
  free(buffer);
  mtx.unlock();
}

Here is the call graph for this function:

write()

size_t tcp::DataSocket::write	(	const void *	buffer,
		size_t	size
	)

Writes the contents of buffer to the outputBuffer.

The content of the outputBuffer will be sent automatically at the next EPoll event

Definition at line 330 of file tcpsocket.cpp.

{
  size_t result = 0U;
  if (size) {
    mtx.lock();
    try {
      for (size_t i=0;i<size;++i) {
        outputBuffer.push_back(((uint8_t*)buffer)[i]);
        ++result;
      }
      canSend(true);
    } catch (const std::bad_alloc&) {
      mtx.unlock();
    }
  }
  return result;
}

Here is the call graph for this function:

---

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

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