Horizon::Networking::ConnectSocketMgr< SocketType, NetworkThreadType > Class Template Reference

Socket manager that handles sockets that were created by the connector. More...

#include <ConnectSocketMgr.hpp>

Inheritance diagram for Horizon::Networking::ConnectSocketMgr< SocketType, NetworkThreadType >:

Collaboration diagram for Horizon::Networking::ConnectSocketMgr< SocketType, NetworkThreadType >:

Public Member Functions
virtual std::shared_ptr< Connector >	start (std::string const &connection_name, Server *server, std::string const &connect_ip, uint16_t port, uint32_t connections=1, bool minimal=false)
	Initialize and start connecting synchronously. More...
virtual bool	stop_network () override
	Stop the Connector network and clear the connection pool. More...
void	on_socket_open (std::string const &conn_name, std::shared_ptr< tcp::socket > const &tcp_socket, uint32_t thread_index)
	On Server Type Socket Open / Start Routine. More...
void	add_socket_to_connections (std::string const &conn_name, std::shared_ptr< SocketType > sock)
std::shared_ptr< SocketType >	get_socket_from_connections (std::string const &conn_name)
void	remove_socket_from_connections (std::string const &conn_name)
Public Member Functions inherited from Horizon::Networking::SocketMgr< SocketType, NetworkThreadType >
virtual	~SocketMgr ()
virtual bool	StartNetworkThreads (uint32_t threads=1)
	Main function that deals with network thread initiation. More...
virtual bool	stop_network ()
	Stops network threads and clears the thread map. More...
uint32_t	GetNetworkThreadCount () const
	Get the current size of the thread map. More...
uint32_t	SelectThreadWithMinConnections () const
	Select the thread with the least number of connections, for new socket additions. More...
std::shared_ptr< SocketType >	on_socket_open (std::shared_ptr< tcp::socket > const &socket, uint32_t thread_index)
	On Socket Open / Start Routine. More...
std::pair< std::shared_ptr< tcp::socket >, uint32_t >	get_new_socket ()
	Get a socket from the thread for new server connection. More...
network_thread_map &	get_thread_map ()

Private Types
typedef std::map< std::string, std::shared_ptr< SocketType > >	ConnectionMap
typedef SocketMgr< SocketType, NetworkThreadType >	BaseSocketMgr

Private Attributes
std::shared_mutex	_connection_map_mtx
ConnectionMap	_connection_map

Detailed Description

template<class SocketType, class NetworkThreadType>
class Horizon::Networking::ConnectSocketMgr< SocketType, NetworkThreadType >

Socket manager that handles sockets that were created by the connector.

Member Typedef Documentation

BaseSocketMgr

template<class SocketType , class NetworkThreadType >

typedef SocketMgr<SocketType, NetworkThreadType> Horizon::Networking::ConnectSocketMgr< SocketType, NetworkThreadType >::BaseSocketMgr

private

ConnectionMap

template<class SocketType , class NetworkThreadType >

typedef std::map<std::string, std::shared_ptr<SocketType> > Horizon::Networking::ConnectSocketMgr< SocketType, NetworkThreadType >::ConnectionMap

private

Member Function Documentation

add_socket_to_connections()

template<class SocketType , class NetworkThreadType >

void Horizon::Networking::ConnectSocketMgr< SocketType, NetworkThreadType >::add_socket_to_connections ( std::string const &  conn_name, std::shared_ptr< SocketType >  sock  )

inline

    {
        std::unique_lock<std::shared_mutex> _connection_map_mtx;
 
        _connection_map.emplace(conn_name, sock);
    }

References Horizon::Networking::ConnectSocketMgr< SocketType, NetworkThreadType >::_connection_map, and Horizon::Networking::ConnectSocketMgr< SocketType, NetworkThreadType >::_connection_map_mtx.

Referenced by Horizon::Networking::ConnectSocketMgr< SocketType, NetworkThreadType >::on_socket_open().

Here is the caller graph for this function:

get_socket_from_connections()

template<class SocketType , class NetworkThreadType >

std::shared_ptr< SocketType > Horizon::Networking::ConnectSocketMgr< SocketType, NetworkThreadType >::get_socket_from_connections ( std::string const &  conn_name )

inline

    {
        std::shared_lock<std::shared_mutex> _connection_map_mtx;
 
        try {
            return _connection_map.at(conn_name);
        } catch (std::out_of_range &/*e*/) {
            return std::shared_ptr<SocketType>();
        }
    }

References Horizon::Networking::ConnectSocketMgr< SocketType, NetworkThreadType >::_connection_map, and Horizon::Networking::ConnectSocketMgr< SocketType, NetworkThreadType >::_connection_map_mtx.

on_socket_open()

template<class SocketType , class NetworkThreadType >

void Horizon::Networking::ConnectSocketMgr< SocketType, NetworkThreadType >::on_socket_open ( std::string const &  conn_name, std::shared_ptr< tcp::socket > const &  tcp_socket, uint32_t  thread_index  )

inline

On Server Type Socket Open / Start Routine.

• Move the socket ownership from the caller to a new socket and add it to a thread.

  Parameters

  [in]	conn_name	as the name of the connection.
  [in]	socket	shared pointer.
  [in]	thread_index	index of the thread that the socket is being moved from.

    {
        std::shared_ptr<SocketType> socket = SocketMgr<SocketType, NetworkThreadType>::on_socket_open(std::move(tcp_socket), thread_index);
        add_socket_to_connections(conn_name, socket);
    }

References Horizon::Networking::ConnectSocketMgr< SocketType, NetworkThreadType >::add_socket_to_connections(), and Horizon::Networking::SocketMgr< SocketType, NetworkThreadType >::on_socket_open().

Here is the call graph for this function:

remove_socket_from_connections()

template<class SocketType , class NetworkThreadType >

void Horizon::Networking::ConnectSocketMgr< SocketType, NetworkThreadType >::remove_socket_from_connections ( std::string const &  conn_name )

inline

    {
        std::unique_lock<std::shared_mutex> _connection_map_mtx;
 
        auto socket = _connection_map.find(conn_name);
 
        if (socket != _connection_map.end())
            socket->second->delayed_close_socket();
 
        _connection_map.erase(conn_name);
    }

References Horizon::Networking::ConnectSocketMgr< SocketType, NetworkThreadType >::_connection_map, and Horizon::Networking::ConnectSocketMgr< SocketType, NetworkThreadType >::_connection_map_mtx.

start()

template<class SocketType , class NetworkThreadType >

virtual std::shared_ptr< Connector > Horizon::Networking::ConnectSocketMgr< SocketType, NetworkThreadType >::start ( std::string const &  connection_name, Server *  server, std::string const &  connect_ip, uint16_t  port, uint32_t  connections = 1, bool  minimal = false  )

inlinevirtual

Initialize and start connecting synchronously.

This method also starts the networking threads for connected sockets.

Parameters

	[in|out]	connection_name const reference to the connection name string.
	[in|out]	server pointer to the server instance that issued the connection.
	[in|out]	connect_ip const reference to the ip_address string for the connection endpoint.
[in]	port	port number for the connection endpoint.
[in]	connections	number of connections to create and handle.

Returns

true on success, false on failure.

    {
        std::shared_ptr<Connector> connector;
 
        if (!(connector = std::make_shared<Horizon::Networking::Connector>(connection_name, server, connect_ip, port))) {
            HLog(error) << "ConnectSocketMgr::Start: " << connection_name << " failed to connect to tcp::" << connect_ip << "@" << port;
            return nullptr;
        }
 
        if (!BaseSocketMgr::StartNetworkThreads(1)) {
            HLog(error) << "ConnectSocketMgr::Start failed to start network threads.";
            return nullptr;
        }
 
        // Set the socket factory. & Start attempting to connect.
        connector->set_socket_factory(std::bind(&BaseSocketMgr::get_new_socket, this));
        
        if (minimal == false)
            connector->connect_with_callback(
                        std::bind(&ConnectSocketMgr<SocketType, NetworkThreadType>::on_socket_open,
                            this, std::placeholders::_1, std::placeholders::_2, std::placeholders::_3), connections);
 
        return connector;
    }

References Horizon::Networking::SocketMgr< SocketType, NetworkThreadType >::get_new_socket(), HLog, and Horizon::Networking::SocketMgr< SocketType, NetworkThreadType >::StartNetworkThreads().

Here is the call graph for this function:

stop_network()

template<class SocketType , class NetworkThreadType >

virtual bool Horizon::Networking::ConnectSocketMgr< SocketType, NetworkThreadType >::stop_network ( )

inlineoverridevirtual

Stop the Connector network and clear the connection pool.

Reimplemented from Horizon::Networking::SocketMgr< SocketType, NetworkThreadType >.

    {
        if (!SocketMgr<SocketType, NetworkThreadType>::stop_network())
            return false;
 
        return true;
    }

Member Data Documentation

_connection_map

template<class SocketType , class NetworkThreadType >

ConnectionMap Horizon::Networking::ConnectSocketMgr< SocketType, NetworkThreadType >::_connection_map

private

Referenced by Horizon::Networking::ConnectSocketMgr< SocketType, NetworkThreadType >::add_socket_to_connections(), Horizon::Networking::ConnectSocketMgr< SocketType, NetworkThreadType >::get_socket_from_connections(), and Horizon::Networking::ConnectSocketMgr< SocketType, NetworkThreadType >::remove_socket_from_connections().

_connection_map_mtx

template<class SocketType , class NetworkThreadType >

std::shared_mutex Horizon::Networking::ConnectSocketMgr< SocketType, NetworkThreadType >::_connection_map_mtx

private

Referenced by Horizon::Networking::ConnectSocketMgr< SocketType, NetworkThreadType >::add_socket_to_connections(), Horizon::Networking::ConnectSocketMgr< SocketType, NetworkThreadType >::get_socket_from_connections(), and Horizon::Networking::ConnectSocketMgr< SocketType, NetworkThreadType >::remove_socket_from_connections().

---

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

• src/Libraries/Networking/ConnectSocketMgr.hpp