TcpTypedServer.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 TCPTYPEDSERVER
#define TCPTYPEDSERVER

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

namespace core_lib
{
namespace asio
{
namespace tcp
{
template <typename MsgBldr> class TcpTypedServer final
{
public:
    TcpTypedServer() = delete;
    TcpTypedServer(boost_iocontext_t& ioContext, uint16_t listenPort, 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_tcpServer{ioContext,
                      listenPort,
                      minAmountToRead,
                      checkBytesLeftToRead,
                      messageReceivedHandler,
                      sendOption,
                      maxAllowedUnsentAsyncMessages}
    {
    }
    TcpTypedServer(uint16_t listenPort, 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_tcpServer{listenPort,
                      minAmountToRead,
                      checkBytesLeftToRead,
                      messageReceivedHandler,
                      sendOption,
                      maxAllowedUnsentAsyncMessages}
    {
    }
    ~TcpTypedServer() = default;
    TcpTypedServer(const TcpTypedServer&) = delete;
    TcpTypedServer& operator=(const TcpTypedServer&) = delete;
    TcpTypedServer(TcpTypedServer&&) = delete;
    TcpTypedServer& operator=(TcpTypedServer&&) = delete;
    defs::connection_t GetServerDetailsForClient(const defs::connection_t& client) const
    {
        return m_tcpServer.GetServerDetailsForClient(client);
    }
    uint16_t ListenPort() const
    {
        return m_tcpServer.ListenPort();
    }
    size_t NumberOfClients() const
    {
        return m_tcpServer.NumberOfClients();
    }
    void CloseAcceptor()
    {
        m_tcpServer.CloseAcceptor();
    }
    void OpenAcceptor()
    {
        m_tcpServer.OpenAcceptor();
    }
    bool SendMessageToClientAsync(
        const defs::connection_t& client, int32_t messageId,
        const defs::connection_t& responseAddress = defs::NULL_CONNECTION) const
    {
        std::lock_guard<std::mutex> lock(m_sendMutex);

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

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

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

            return m_tcpServer.SendMessageToClientSync(client, messageBuffer);
        }
        catch (...)
        {
            return false;
        }
    }
    bool
    SendMessageToAllClients(int32_t                   messageId,
                            const defs::connection_t& responseAddress = defs::NULL_CONNECTION) const
    {
        std::lock_guard<std::mutex> lock(m_sendMutex);

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

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

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

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

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

            return m_tcpServer.SendMessageToClientSync(client, messageBuffer);
        }
        catch (...)
        {
            return false;
        }
    }
    bool
    SendMessageToAllClients(int32_t messageId, const defs::char_buffer_t& message,
                            const defs::connection_t& responseAddress = defs::NULL_CONNECTION) const
    {
        std::lock_guard<std::mutex> lock(m_sendMutex);

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

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

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

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

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

            return m_tcpServer.SendMessageToClientSync(client, messageBuffer);
        }
        catch (...)
        {
            return false;
        }
    }
    template <typename T, typename A = serialize::archives::out_port_bin_t>
    bool
    SendMessageToAllClients(const T& message, int32_t messageId,
                            const defs::connection_t& responseAddress = defs::NULL_CONNECTION) const
    {
        std::lock_guard<std::mutex> lock(m_sendMutex);

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

            return m_tcpServer.SendMessageToAllClients(messageBuffer);
#
        }
        catch (...)
        {
            // Do nothing.
            return false;
        }
    }
    bool SendMessageToClientAsync(const defs::connection_t&  client,
                                  const defs::char_buffer_t& message) const
    {
        try
        {
            return m_tcpServer.SendMessageToClientAsync(client, message);
        }
        catch (...)
        {
            // Do nothing.
            return false;
        }
    }
    bool SendMessageToClientSync(const defs::connection_t&  client,
                                 const defs::char_buffer_t& message) const
    {
        try
        {
            return m_tcpServer.SendMessageToClientSync(client, message);
        }
        catch (...)
        {
            return false;
        }
    }
    bool SendMessageToAllClients(const defs::char_buffer_t& message) const
    {
        try
        {
            return m_tcpServer.SendMessageToAllClients(message);
        }
        catch (...)
        {
            // Do nothing.
            return false;
        }
    }
    size_t NumberOfUnsentAsyncMessages(const defs::connection_t& client) const
    {
        return m_tcpServer.NumberOfUnsentAsyncMessages(client);
    }

    bool IsConnected(const defs::connection_t& client) const
    {
        return m_tcpServer.IsConnected(client);
    }

private:
    mutable std::mutex m_sendMutex;
    const MsgBldr& m_messageBuilder;
    TcpServer m_tcpServer;
};

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

#endif // TCPTYPEDCLIENT