TcpTypedClient.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 TCPTYPEDCLIENT
#define TCPTYPEDCLIENT

#include <mutex>
#include "TcpClient.h"
#include "MessageUtils.h"

namespace core_lib
{
namespace asio
{
namespace tcp
{

template <typename MsgBldr> class TcpTypedClient final
{
public:
    TcpTypedClient() = delete;
    TcpTypedClient(boost_iocontext_t& ioContext, const defs::connection_t& server,
                   size_t                                  minAmountToRead,
                   const defs::check_bytes_left_to_read_t& checkBytesLeftToRead,
                   const defs::message_received_handler_t& messageReceivedHandler,
                   const MsgBldr& messageBuilder, eSendOption sendOption = eSendOption::nagleOn,
                   size_t maxAllowedUnsentAsyncMessages = MAX_UNSENT_ASYNC_MSG_COUNT)
        : m_messageBuilder{messageBuilder}
        , m_tcpClient{ioContext,
                      server,
                      minAmountToRead,
                      checkBytesLeftToRead,
                      messageReceivedHandler,
                      sendOption,
                      maxAllowedUnsentAsyncMessages}
    {
    }
    TcpTypedClient(const defs::connection_t& server, size_t minAmountToRead,
                   const defs::check_bytes_left_to_read_t& checkBytesLeftToRead,
                   const defs::message_received_handler_t& messageReceivedHandler,
                   const MsgBldr& messageBuilder, eSendOption sendOption = eSendOption::nagleOn,
                   size_t maxAllowedUnsentAsyncMessages = MAX_UNSENT_ASYNC_MSG_COUNT)
        : m_messageBuilder{messageBuilder}
        , m_tcpClient{server,
                      minAmountToRead,
                      checkBytesLeftToRead,
                      messageReceivedHandler,
                      sendOption,
                      maxAllowedUnsentAsyncMessages}
    {
    }
    ~TcpTypedClient() = default;
    TcpTypedClient(const TcpTypedClient&) = delete;
    TcpTypedClient& operator=(const TcpTypedClient&) = delete;
    TcpTypedClient(TcpTypedClient&&) = delete;
    TcpTypedClient& operator=(TcpTypedClient&&) = delete;
    defs::connection_t ServerConnection() const
    {
        return m_tcpClient.ServerConnection();
    }
    bool Connected() const
    {
        return m_tcpClient.Connected();
    }
    defs::connection_t GetClientDetailsForServer()
    {
        m_tcpClient.CheckAndCreateConnection();
        return m_tcpClient.GetClientDetailsForServer();
    }
    void CloseConnection()
    {
        m_tcpClient.CloseConnection();
    }
    bool SendMessageToServerAsync(int32_t                   messageId,
                                  const defs::connection_t& responseAddress = defs::NULL_CONNECTION)
    {
        std::lock_guard<std::mutex> lock(m_sendMutex);

        try
        {
            auto const& messageBuffer = messages::BuildMessage(
                messageId, responseAddress, GetClientDetailsForServer(), m_messageBuilder);

            return m_tcpClient.SendMessageToServerAsync(messageBuffer);
        }
        catch (...)
        {
            // Do nothing.
            return false;
        }
    }
    bool SendMessageToServerSync(int32_t                   messageId,
                                 const defs::connection_t& responseAddress = defs::NULL_CONNECTION)
    {
        std::lock_guard<std::mutex> lock(m_sendMutex);

        try
        {
            auto const& messageBuffer = messages::BuildMessage(
                messageId, responseAddress, GetClientDetailsForServer(), m_messageBuilder);
            return m_tcpClient.SendMessageToServerSync(messageBuffer);
        }
        catch (...)
        {
            return false;
        }
    }
    bool SendMessageToServerAsync(const defs::char_buffer_t& message, int32_t messageId,
                                  const defs::connection_t& responseAddress = defs::NULL_CONNECTION)
    {
        std::lock_guard<std::mutex> lock(m_sendMutex);

        try
        {
            auto const& messageBuffer = messages::BuildMessage(
                message, messageId, responseAddress, GetClientDetailsForServer(), m_messageBuilder);

            return m_tcpClient.SendMessageToServerAsync(messageBuffer);
        }
        catch (...)
        {
            // Do nothing.
            return false;
        }
    }
    bool SendMessageToServerSync(const defs::char_buffer_t& message, int32_t messageId,
                                 const defs::connection_t& responseAddress = defs::NULL_CONNECTION)
    {
        std::lock_guard<std::mutex> lock(m_sendMutex);

        try
        {
            auto const& messageBuffer = messages::BuildMessage(
                message, messageId, responseAddress, GetClientDetailsForServer(), m_messageBuilder);
            return m_tcpClient.SendMessageToServerSync(messageBuffer);
        }
        catch (...)
        {
            return false;
        }
    }
    template <typename T, typename A = serialize::archives::out_port_bin_t>
    bool SendMessageToServerAsync(const T& message, int32_t messageId,
                                  const defs::connection_t& responseAddress = defs::NULL_CONNECTION)
    {
        std::lock_guard<std::mutex> lock(m_sendMutex);

        try
        {
            auto const& messageBuffer = messages::BuildMessage<T, A, MsgBldr>(
                message, messageId, responseAddress, GetClientDetailsForServer(), m_messageBuilder);

            return m_tcpClient.SendMessageToServerAsync(messageBuffer);
        }
        catch (...)
        {
            // Do nothing.
            return false;
        }
    }
    template <typename T, typename A = serialize::archives::out_port_bin_t>
    bool SendMessageToServerSync(const T& message, int32_t messageId,
                                 const defs::connection_t& responseAddress = defs::NULL_CONNECTION)
    {
        std::lock_guard<std::mutex> lock(m_sendMutex);

        try
        {
            auto const& messageBuffer = messages::BuildMessage<T, A, MsgBldr>(
                message, messageId, responseAddress, GetClientDetailsForServer(), m_messageBuilder);
            return m_tcpClient.SendMessageToServerSync(messageBuffer);
        }
        catch (...)
        {
            return false;
        }
    }
    bool SendMessageToServerAsync(const defs::char_buffer_t& message)
    {
        try
        {
            return m_tcpClient.SendMessageToServerAsync(message);
        }
        catch (...)
        {
            // Do nothing.
            return false;
        }
    }
    bool SendMessageToServerSync(const defs::char_buffer_t& message)
    {
        try
        {
            return m_tcpClient.SendMessageToServerSync(message);
        }
        catch (...)
        {
            return false;
        }
    }
    size_t NumberOfUnsentAsyncMessages() const
    {
        return m_tcpClient.NumberOfUnsentAsyncMessages();
    }

private:
    mutable std::mutex m_sendMutex;
    const MsgBldr& m_messageBuilder;
    TcpClient m_tcpClient;
};

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

#endif // TCPTYPEDCLIENT