Horizon::Networking::Connector Class Reference

Connector object that allows connecting to remote endpoints. More...

#include <Connector.hpp>

Collaboration diagram for Horizon::Networking::Connector:

Public Types
typedef std::function< void(std::string &, std::shared_ptr< tcp::socket >, uint32_t)>	ConnectorCallback

Public Member Functions
	Connector (std::string const &connection_name, Server *server, std::string const &connect_ip, uint16_t port)
	Connector contructor. More...
	Connector ()
	Destructor of the object that handles joining of all socket polling threads. More...
void	connect_with_callback (ConnectorCallback callback, int connections=1)
	Attempts connections to the remote endpoint that the object was initiated with. More...
void	set_socket_factory (std::function< std::pair< std::shared_ptr< tcp::socket >, uint32_t >()> &&func)
	Sets a socket factory method that provides a socket for new connections. More...

Private Member Functions
std::pair< std::shared_ptr< tcp::socket >, uint32_t >	default_socket_factory ()

Private Attributes
Server *	server
std::string	_connection_name
tcp::endpoint	_endpoint
std::function< std::pair< std::shared_ptr< tcp::socket >, uint32_t >()>	_socket_factory

Detailed Description

Connector object that allows connecting to remote endpoints.

Connections are passed to network connected threads that handle them separately from accepted threads.

Member Typedef Documentation

ConnectorCallback

typedef std::function<void(std::string &, std::shared_ptr<tcp::socket>, uint32_t)> Horizon::Networking::Connector::ConnectorCallback

Constructor & Destructor Documentation

Connector() [1/2]

Horizon::Networking::Connector::Connector ( std::string const &  connection_name, Server *  server, std::string const &  connect_ip, uint16_t  port  )

inline

Connector contructor.

Parameters

	[in|out]	connection_name constant reference to the name string of the connection being created.
	[in|out]	server pointer to the server object that is instantiating the connection.
	[in|out]	connect_ip constant reference to the ip string of the endpoint to connect to.
[in]	port	port number of the endpoint to connect to.

    : server(server), _connection_name(connection_name), _endpoint(boost::asio::ip::make_address(connect_ip), port),
    _socket_factory(std::bind(&Connector::default_socket_factory, this))
    {
    }

Connector() [2/2]

Horizon::Networking::Connector::Connector ( )

inline

Destructor of the object that handles joining of all socket polling threads.

    {
    }

Member Function Documentation

connect_with_callback()

void Horizon::Networking::Connector::connect_with_callback ( ConnectorCallback  callback, int  connections = 1  )

inline

Attempts connections to the remote endpoint that the object was initiated with.

The responsibilities of this method are - 1) Attempt to open connections to an endpoint and retry on failure. 2) Execute callbacks to functions that handle the ownership of the connected socket. 3) Start threads that execute state-verification checks of each connection.

Parameters

[in]	callback	the callback function that handles socket ownership.
[in]	connections	the number of connections to the endpoint that will be initiated and handled.

    {
        for (int i = 0; i < connections; i++) {
            std::shared_ptr<tcp::socket> socket;
            uint32_t network_thread_idx;
            boost::system::error_code error;
 
            // Get a new socket from a thread with the minimum connections.
            std::tie(socket, network_thread_idx) = _socket_factory();
 
            do {
                HLog(info) << "Trying to establish connection for '" << _connection_name << "' at tcp://" << _endpoint.address().to_string() << ":" << _endpoint.port();
 
                // Try connecting to the endpoint.
                socket->connect(_endpoint, error);
 
                if (error.value() != 0) {
                    HLog(info) << "Error connecting to '" << _connection_name << "' at tcp://" << _endpoint.address().to_string() << ":" << _endpoint.port();
                    std::this_thread::sleep_for(std::chrono::seconds(10));
                    socket->close();
                    error.clear();
                } else {
                    callback(_connection_name, socket, network_thread_idx);
                    HLog(info) << "Successfully connected to '" << _connection_name << "' at tcp://" << _endpoint.address().to_string() << ":" << _endpoint.port();
                }
            } while (!socket->is_open());
        }
    }

References _connection_name, _endpoint, _socket_factory, and HLog.

default_socket_factory()

std::pair< std::shared_ptr< tcp::socket >, uint32_t > Horizon::Networking::Connector::default_socket_factory ( )

inlineprivate

{ return std::make_pair(nullptr, 0); }

set_socket_factory()

void Horizon::Networking::Connector::set_socket_factory ( std::function< std::pair< std::shared_ptr< tcp::socket >, uint32_t >()> &&  func )

inline

Sets a socket factory method that provides a socket for new connections.

{ _socket_factory = func; }

References _socket_factory.

Member Data Documentation

_connection_name

std::string Horizon::Networking::Connector::_connection_name

private

Referenced by connect_with_callback().

_endpoint

tcp::endpoint Horizon::Networking::Connector::_endpoint

private

Referenced by connect_with_callback().

_socket_factory

std::function<std::pair<std::shared_ptr<tcp::socket>, uint32_t>()> Horizon::Networking::Connector::_socket_factory

private

Referenced by connect_with_callback(), and set_socket_factory().

server

Server* Horizon::Networking::Connector::server

private

---

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

• src/Libraries/Networking/Connector.hpp