SimpleTcpClientList.h

Go to the documentation of this file.

// This file is part of CoreLibrary containing useful reusable utility
// classes.
//
// Copyright (C) 2014 to present, Duncan Crutchley
// Contact <dac1976github@outlook.com>
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU Lesser General Public License as published
// by the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License and GNU Lesser General Public License
// for more details.
//
// You should have received a copy of the GNU General Public License
// and GNU Lesser General Public License along with this program. If
// not, see <http://www.gnu.org/licenses/>.

#ifndef SIMPLETCPCLIENTLIST_H
#define SIMPLETCPCLIENTLIST_H

#include <map>
#include <mutex>
#include "Asio/SimpleTcpClient.h"

namespace core_lib
{
namespace asio
{
namespace tcp
{

class CORE_LIBRARY_DLL_SHARED_API SimpleTcpClientList final
{
    using client_ptr_t = std::shared_ptr<SimpleTcpClient>;
    using client_map_t = std::map<defs::connection_t, client_ptr_t>;

public:
    SimpleTcpClientList() = delete;
    SimpleTcpClientList(SimpleTcpClientList const&) = delete;
    SimpleTcpClientList& operator=(SimpleTcpClientList const&) = delete;
    SimpleTcpClientList(SimpleTcpClientList&&) = delete;
    SimpleTcpClientList& operator=(SimpleTcpClientList&&) = delete;
    SimpleTcpClientList(boost_iocontext_t&                        ioContext,
                        defs::default_message_dispatcher_t const& messageDispatcher,
                        eSendOption                               sendOption = eSendOption::nagleOn,
                        size_t maxAllowedUnsentAsyncMessages = MAX_UNSENT_ASYNC_MSG_COUNT,
                        size_t memPoolMsgCount               = 0);
    SimpleTcpClientList(defs::default_message_dispatcher_t const& messageDispatcher,
                        eSendOption                               sendOption = eSendOption::nagleOn,
                        size_t maxAllowedUnsentAsyncMessages = MAX_UNSENT_ASYNC_MSG_COUNT,
                        size_t memPoolMsgCount               = 0);
    ~SimpleTcpClientList();
    defs::connection_t ServerConnection(defs::connection_t const& clientConn) const;
    bool Connected(defs::connection_t const& server) const;
    defs::connection_t GetClientDetailsForServer(defs::connection_t const& server) const;
    void CloseConnection(defs::connection_t const& server) const;
    void CloseConnections() const;
    void ClearConnections();
    bool
    SendMessageToServerAsync(defs::connection_t const& server, int32_t messageId,
                             defs::connection_t const& responseAddress = defs::NULL_CONNECTION);
    bool SendMessageToServerSync(defs::connection_t const& server, int32_t messageId,
                                 defs::connection_t const& responseAddress = defs::NULL_CONNECTION);
    bool
    SendMessageToServerAsync(defs::connection_t const& server, const defs::char_buffer_t& message,
                             int32_t                   messageId,
                             defs::connection_t const& responseAddress = defs::NULL_CONNECTION);
    bool SendMessageToServerSync(defs::connection_t const&  server,
                                 const defs::char_buffer_t& message, int32_t messageId,
                                 defs::connection_t const& responseAddress = defs::NULL_CONNECTION);
    template <typename T, typename A = serialize::archives::out_port_bin_t>
    bool SendMessageToServerAsync(defs::connection_t const& server, T const& message,
                                  int32_t                   messageId,
                                  defs::connection_t const& responseAddress = defs::NULL_CONNECTION)
    {
        std::lock_guard<std::mutex> lock(m_mutex);

        auto clientPtr = FindTcpClient(server);

        if (!clientPtr)
        {
            clientPtr = CreateTcpClient(server);
        }

        if (clientPtr)
        {
            return clientPtr->SendMessageToServerAsync<T, A>(message, messageId, responseAddress);
        }

        return false;
    }
    template <typename T, typename A = serialize::archives::out_port_bin_t>
    bool SendMessageToServerSync(defs::connection_t const& server, T const& message,
                                 int32_t                   messageId,
                                 defs::connection_t const& responseAddress = defs::NULL_CONNECTION)
    {
        std::lock_guard<std::mutex> lock(m_mutex);

        bool success   = false;
        auto clientPtr = FindTcpClient(server);

        if (!clientPtr)
        {
            clientPtr = CreateTcpClient(server);
        }

        if (clientPtr)
        {
            success = clientPtr->SendMessageToServerSync<T, A>(message, messageId, responseAddress);
        }

        return success;
    }
    bool SendMessageToServerAsync(defs::connection_t const&  server,
                                  const defs::char_buffer_t& message);
    bool SendMessageToServerSync(defs::connection_t const&  server,
                                 const defs::char_buffer_t& message);
    void ClearList();
    std::vector<defs::connection_t> GetServerList() const;
    size_t NumberOfUnsentAsyncMessages(const defs::connection_t& server) const;

private:
    client_ptr_t CreateTcpClient(defs::connection_t const& server);
    client_ptr_t FindTcpClient(defs::connection_t const& server) const;

private:
    mutable std::mutex m_mutex;
    boost_iocontext_t* m_ioContextPtr{nullptr};
    defs::default_message_dispatcher_t m_messageDispatcher{};
    eSendOption m_sendOption{eSendOption::nagleOn};
    size_t m_maxAllowedUnsentAsyncMessages{MAX_UNSENT_ASYNC_MSG_COUNT};
    size_t m_memPoolMsgCount{0};
    client_map_t m_clientMap{};
};

} // namespace tcp
} // namespace asio
} // namespace core_lib

#endif // SIMPLETCPCLIENTLIST_H