TcpClientList.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 TCPCLIENTLIST_H
#define TCPCLIENTLIST_H

#include <map>
#include <mutex>
#include "AsioDefines.h"

namespace core_lib
{
namespace asio
{
namespace tcp
{

class TcpClient;

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

public:
    TcpClientList() = delete;
    TcpClientList(TcpClientList const&) = delete;
    TcpClientList& operator=(TcpClientList const&) = delete;
    TcpClientList(TcpClientList&&) = delete;
    TcpClientList& operator=(TcpClientList&&) = delete;
    TcpClientList(boost_iocontext_t& ioContext, size_t minAmountToRead,
                  defs::check_bytes_left_to_read_t const& checkBytesLeftToRead,
                  defs::message_received_handler_t const& messageReceivedHandler,
                  eSendOption                             sendOption = eSendOption::nagleOn,
                  size_t maxAllowedUnsentAsyncMessages               = MAX_UNSENT_ASYNC_MSG_COUNT);
    TcpClientList(size_t                                  minAmountToRead,
                  defs::check_bytes_left_to_read_t const& checkBytesLeftToRead,
                  defs::message_received_handler_t const& messageReceivedHandler,
                  eSendOption                             sendOption = eSendOption::nagleOn,
                  size_t maxAllowedUnsentAsyncMessages               = MAX_UNSENT_ASYNC_MSG_COUNT);
    ~TcpClientList();
    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,
                                  defs::char_buffer_t const& message);
    bool SendMessageToServerSync(defs::connection_t const&  server,
                                 defs::char_buffer_t const& 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};
    size_t m_minAmountToRead{0};
    defs::check_bytes_left_to_read_t m_checkBytesLeftToRead{};
    defs::message_received_handler_t m_messageReceivedHandler{};
    eSendOption m_sendOption{eSendOption::nagleOn};
    size_t m_maxAllowedUnsentAsyncMessages{MAX_UNSENT_ASYNC_MSG_COUNT};
    client_map_t m_clientMap{};
};

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

#endif // TCPCLIENTLIST_H