SimpleTcpServer.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 SIMPLETCPSERVER
#define SIMPLETCPSERVER

#include "TcpTypedServer.h"

namespace core_lib
{
namespace asio
{
namespace tcp
{
class CORE_LIBRARY_DLL_SHARED_API SimpleTcpServer final
{
public:
    SimpleTcpServer() = delete;
    SimpleTcpServer(boost_iocontext_t& ioContext, uint16_t listenPort,
                    const defs::default_message_dispatcher_t& messageDispatcher,
                    eSendOption                               sendOption = eSendOption::nagleOn,
                    size_t maxAllowedUnsentAsyncMessages = MAX_UNSENT_ASYNC_MSG_COUNT,
                    size_t memPoolMsgCount               = 0);
    SimpleTcpServer(uint16_t                                  listenPort,
                    const defs::default_message_dispatcher_t& messageDispatcher,
                    eSendOption                               sendOption = eSendOption::nagleOn,
                    size_t maxAllowedUnsentAsyncMessages = MAX_UNSENT_ASYNC_MSG_COUNT,
                    size_t memPoolMsgCount               = 0);
    ~SimpleTcpServer() = default;
    SimpleTcpServer(const SimpleTcpServer&) = delete;
    SimpleTcpServer& operator=(const SimpleTcpServer&) = delete;
    SimpleTcpServer(SimpleTcpServer&&) = delete;
    SimpleTcpServer& operator=(SimpleTcpServer&&) = delete;
    defs::connection_t GetServerDetailsForClient(const defs::connection_t& client) const;
    uint16_t ListenPort() const;
    size_t NumberOfClients() const;
    void CloseAcceptor();
    void OpenAcceptor();
    bool SendMessageToClientAsync(
        const defs::connection_t& client, int32_t messageId,
        const defs::connection_t& responseAddress = defs::NULL_CONNECTION) const;
    bool SendMessageToClientSync(
        const defs::connection_t& client, int32_t messageId,
        const defs::connection_t& responseAddress = defs::NULL_CONNECTION) const;
    bool SendMessageToAllClients(
        int32_t messageId, const defs::connection_t& responseAddress = defs::NULL_CONNECTION) const;
    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;
    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;
    bool SendMessageToAllClients(
        const defs::char_buffer_t& message, int32_t messageId,
        const defs::connection_t& responseAddress = defs::NULL_CONNECTION) const;
    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
    {
        return m_tcpTypedServer.SendMessageToClientAsync<T, A>(
            message, client, messageId, responseAddress);
    }
    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
    {
        return m_tcpTypedServer.SendMessageToClientSync<T, A>(
            message, client, messageId, responseAddress);
    }
    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
    {
        return m_tcpTypedServer.SendMessageToAllClients<T, A>(message, messageId, responseAddress);
    }
    bool SendMessageToClientAsync(const defs::connection_t&  client,
                                  const defs::char_buffer_t& message) const;
    bool SendMessageToClientSync(const defs::connection_t&  client,
                                 const defs::char_buffer_t& message) const;
    bool SendMessageToAllClients(const defs::char_buffer_t& message) const;
    size_t NumberOfUnsentAsyncMessages(const defs::connection_t& client) const;

    bool IsConnected(const defs::connection_t& client) const;

private:
    messages::MessageBuilder m_messageBuilder{};
    messages::MessageHandler m_messageHandler{};
    TcpTypedServer<messages::MessageBuilder> m_tcpTypedServer;
};

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

#endif // SIMPLETCPSERVER