A Network Thread object that handles a number of sockets. More...

#include <NetworkThread.hpp>

Public Member Functions
	NetworkThread ()

virtual	~NetworkThread ()
	Destructor of the network thread, performs a clean network finalisation routine before deleting. More...

virtual void	finalize ()
	Halts the IO Service and marks the network thread as stopped. More...

void	join ()

virtual bool	start (int segment_number=1)
	Initializes the network thread and runs. More...

virtual void	add_socket (std::shared_ptr< SocketType > sock)
	Adds a new socket to a queue that is processed frequently within this network thread. More...

std::shared_ptr< tcp::socket >	get_new_socket ()
	Gets a socket for a new connection. More...

int32_t	connection_count () const
	Gets the total number of network connections or sockets handled by this network thread. More...

bool	is_finalizing ()
	Issues the status of network thread whether it is finalizing or not. More...

Protected Member Functions
virtual void	run ()
	Run the I/O Service loop within this network thread. More...

virtual void	on_socket_removed (std::shared_ptr< SocketType > sock)=0

virtual void	on_socket_added (std::shared_ptr< SocketType > sock)=0

virtual void	update ()
	Updates the network thread and schedules a recursive call to itself. More...

virtual void	add_new_sockets ()
	Processess the new socket queue. More...

Protected Attributes
SocketContainer	_active_sockets

Private Types
typedef std::vector< std::shared_ptr< SocketType > >	SocketContainer

Private Attributes
int	_segment_number {1}

std::atomic< int32_t >	_connections

std::atomic< bool >	_finalizing

std::unique_ptr< std::thread >	_thread

SocketContainer	_new_socket_queue

std::mutex	_new_socket_queue_lock

boost::asio::io_context	_io_context

boost::asio::deadline_timer	_update_timer

Detailed Description

template<class SocketType>
class Horizon::Networking::NetworkThread< SocketType >

A Network Thread object that handles a number of sockets.

Sockets are moved into the thread by SocketMgr, once accepted or connected. Once started, the object blocks to handle I/O events and requires explicit stopping.

Member Typedef Documentation

◆ SocketContainer

template<class SocketType >

typedef std::vector<std::shared_ptr<SocketType> > Horizon::Networking::NetworkThread< SocketType >::SocketContainer

private

Constructor & Destructor Documentation

◆ NetworkThread()

template<class SocketType >

Horizon::Networking::NetworkThread< SocketType >::NetworkThread ( )

inline

    : _connections(0), _finalizing(false), _update_timer(_io_context)
    {
        // Constructor
    }

◆ ~NetworkThread()

template<class SocketType >

virtual Horizon::Networking::NetworkThread< SocketType >::~NetworkThread ( )

inlinevirtual

Destructor of the network thread, performs a clean network finalisation routine before deleting.

    {
        finalize();
    }

References Horizon::Networking::NetworkThread< SocketType >::finalize().

Here is the call graph for this function:

Member Function Documentation

◆ add_new_sockets()

template<class SocketType >

virtual void Horizon::Networking::NetworkThread< SocketType >::add_new_sockets ( )

inlineprotectedvirtual

Processess the new socket queue.

This method is responsible for - 1) Processing the entire list of new sockets and clearing it on every call. 2) removing / closing new sockets that are not open. 3) Starting the new socket once added to the container. (

See also: Socket<SocketType>::start())

    {
        if (is_finalizing())
            return;
 
        std::lock_guard<std::mutex> lock(_new_socket_queue_lock);
 
        if (_new_socket_queue.empty())
            return;
 
        for (std::shared_ptr<SocketType> sock : _new_socket_queue) {
            if (sock->is_open()) {
                _active_sockets.push_back(sock);
                // Start receiving from the socket.
                sock->start();
 
                on_socket_added(sock);
 
                ++_connections; // Increment network connections.
 
                HLog(trace) << "A new socket has been added to network thread " << (void *) (_thread.get()) << " (Connections: " << _connections << ")";
            }
        }
 
        _new_socket_queue.clear();
    }

References HLog.

Referenced by Horizon::Networking::NetworkThread< SocketType >::update().

Here is the caller graph for this function:

◆ add_socket()

template<class SocketType >

virtual void Horizon::Networking::NetworkThread< SocketType >::add_socket ( std::shared_ptr< SocketType > sock )

inlinevirtual

Adds a new socket to a queue that is processed frequently within this network thread.

The method update() is called regularly to add new sockets to the thread's active socket list.

    {
        std::lock_guard<std::mutex> lock(_new_socket_queue_lock);
 
        _new_socket_queue.push_back(sock);  // Add socket to queue.
    }

References Horizon::Networking::NetworkThread< SocketType >::_new_socket_queue, and Horizon::Networking::NetworkThread< SocketType >::_new_socket_queue_lock.

◆ connection_count()

template<class SocketType >

int32_t Horizon::Networking::NetworkThread< SocketType >::connection_count ( ) const

inline

Gets the total number of network connections or sockets handled by this network thread.

Returns: total number of connections in this network thread.

130{ return _connections; }

References Horizon::Networking::NetworkThread< SocketType >::_connections.

◆ finalize()

template<class SocketType >

virtual void Horizon::Networking::NetworkThread< SocketType >::finalize ( )

inlinevirtual

Halts the IO Service and marks the network thread as stopped.

Reimplemented in Horizon::Auth::AuthNetworkThread, Horizon::Char::CharNetworkThread, and Horizon::Zone::ZoneNetworkThread.

    {
        _finalizing.exchange(true);
    }

References Horizon::Networking::NetworkThread< SocketType >::_finalizing.

Referenced by Horizon::Auth::AuthNetworkThread::finalize(), Horizon::Char::CharNetworkThread::finalize(), Horizon::Zone::ZoneNetworkThread::finalize(), and Horizon::Networking::NetworkThread< SocketType >::~NetworkThread().

Here is the caller graph for this function:

◆ get_new_socket()

template<class SocketType >

std::shared_ptr< tcp::socket > Horizon::Networking::NetworkThread< SocketType >::get_new_socket ( )

inline

Gets a socket for a new connection.

This method is used as a socket factory in AsyncAcceptor and Connector classes. Once a socket is accepted or connected, its ownership is moved into a network thread.

Returns: a new shared pointer to a tcp::socket.

123{ return std::make_shared<tcp::socket>(_io_context); }

References Horizon::Networking::NetworkThread< SocketType >::_io_context.

◆ is_finalizing()

template<class SocketType >

bool Horizon::Networking::NetworkThread< SocketType >::is_finalizing ( )

inline

Issues the status of network thread whether it is finalizing or not.

Returns: boolean finalizing of the network thread status.

136{ return _finalizing; }

References Horizon::Networking::NetworkThread< SocketType >::_finalizing.

◆ join()

template<class SocketType >

void Horizon::Networking::NetworkThread< SocketType >::join ( )

inline

    {
        try {
            _thread->join();
        } catch (std::system_error &error) {
            HLog(error) << "Error joining network thread2: " << error.what();
        }
    }

References Horizon::Networking::NetworkThread< SocketType >::_thread, and HLog.

◆ on_socket_added()

template<class SocketType >

virtual void Horizon::Networking::NetworkThread< SocketType >::on_socket_added ( std::shared_ptr< SocketType > sock )

protectedpure virtual

◆ on_socket_removed()

template<class SocketType >

virtual void Horizon::Networking::NetworkThread< SocketType >::on_socket_removed ( std::shared_ptr< SocketType > sock )

protectedpure virtual

◆ run()

template<class SocketType >

virtual void Horizon::Networking::NetworkThread< SocketType >::run ( )

inlineprotectedvirtual

Run the I/O Service loop within this network thread.

Before running, this method gives the I/O service some work by asynchronously running a deadline timer on

See also: update()

Reimplemented in Horizon::Auth::AuthNetworkThread, Horizon::Char::CharNetworkThread, and Horizon::Zone::ZoneNetworkThread.

    {
        _update_timer.expires_from_now(boost::posix_time::microseconds(500));
        _update_timer.async_wait(std::bind(&NetworkThread<SocketType>::update, this));
 
        _io_context.run();
 
        _new_socket_queue.clear();
        _active_sockets.clear();
    }

References Horizon::Networking::NetworkThread< SocketType >::_active_sockets, Horizon::Networking::NetworkThread< SocketType >::_io_context, Horizon::Networking::NetworkThread< SocketType >::_new_socket_queue, and Horizon::Networking::NetworkThread< SocketType >::_update_timer.

Referenced by Horizon::Auth::AuthNetworkThread::run(), Horizon::Char::CharNetworkThread::run(), Horizon::Zone::ZoneNetworkThread::run(), and Horizon::Networking::NetworkThread< SocketType >::start().

Here is the caller graph for this function:

◆ start()

template<class SocketType >

virtual bool Horizon::Networking::NetworkThread< SocketType >::start ( int segment_number = 1 )

inlinevirtual

Initializes the network thread and runs.

Returns: true on success, false if thread is a nullptr.

Reimplemented in Horizon::Auth::AuthNetworkThread, Horizon::Char::CharNetworkThread, and Horizon::Zone::ZoneNetworkThread.

    {
        if (_thread != nullptr)
            return false;
 
        _segment_number = segment_number;
        _thread.reset(new std::thread(&NetworkThread::run, this));
        return true;
    }

References Horizon::Networking::NetworkThread< SocketType >::_segment_number, Horizon::Networking::NetworkThread< SocketType >::_thread, and Horizon::Networking::NetworkThread< SocketType >::run().

Here is the call graph for this function:

◆ update()

template<class SocketType >

virtual void Horizon::Networking::NetworkThread< SocketType >::update ( )

inlineprotectedvirtual

Updates the network thread and schedules a recursive call to itself.

This method is responsible for the following tasks - 1) Issuing a routine to process the new sockets queue. 2) Closes sockets that cannot be updated.

See also: Socket<SocketType>::update()

Reimplemented in Horizon::Auth::AuthNetworkThread, Horizon::Char::CharNetworkThread, and Horizon::Zone::ZoneNetworkThread.

    {
        _update_timer.expires_from_now(boost::posix_time::microseconds(500));
        _update_timer.async_wait(std::bind(&NetworkThread<SocketType>::update, this));
 
        add_new_sockets();
        
        // The following code removes all non-active from the active sockets list by shifting all 
        // active sockets to the left and then erasing the extra
        _active_sockets.erase(std::remove_if(_active_sockets.begin(), _active_sockets.end(),
            [this] (std::shared_ptr<SocketType> sock)
            {
                if (!sock->update() || is_finalizing()) {
 
                    if (sock->is_open())
                        sock->close_socket();
 
                    on_socket_removed(sock);
 
                    --_connections;
 
                    HLog(info) << "Socket closed in networking thread " << (void *) (_thread.get()) << " (Connections: " << _connections << ")";
 
                    return true;
                }
 
                return false;
            }), _active_sockets.end());
 
        if (is_finalizing()) {
            _io_context.stop();
            _finalizing.exchange(false);
            HLog(info) << "Network thread " << (void *) (_thread.get()) << " has been finalized.";
        }
    }

References Horizon::Networking::NetworkThread< SocketType >::_active_sockets, Horizon::Networking::NetworkThread< SocketType >::_update_timer, and Horizon::Networking::NetworkThread< SocketType >::add_new_sockets().

Referenced by Horizon::Auth::AuthNetworkThread::update(), Horizon::Char::CharNetworkThread::update(), and Horizon::Zone::ZoneNetworkThread::update().

Here is the call graph for this function:

Here is the caller graph for this function:

Referenced by Horizon::Networking::NetworkThread< SocketType >::run(), and Horizon::Networking::NetworkThread< SocketType >::update().

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

src/Libraries/Networking/NetworkThread.hpp

Public Member Functions

Protected Member Functions

Protected Attributes

Private Types

Private Attributes

Detailed Description

Member Typedef Documentation

◆ SocketContainer

Constructor & Destructor Documentation

◆ NetworkThread()

◆ ~NetworkThread()

Member Function Documentation

◆ add_new_sockets()

◆ add_socket()

◆ connection_count()

◆ finalize()

◆ get_new_socket()

◆ is_finalizing()

◆ join()

◆ on_socket_added()

◆ on_socket_removed()

◆ run()

◆ start()

◆ update()

Member Data Documentation

◆ _active_sockets

◆ _connections

◆ _finalizing

◆ _io_context

◆ _new_socket_queue

◆ _new_socket_queue_lock

◆ _segment_number

◆ _thread

◆ _update_timer