SimpleTcpClient.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 SIMPLETCPCLIENT
#define SIMPLETCPCLIENT

#include "TcpTypedClient.h"

namespace core_lib
{
namespace asio
{
namespace tcp
{

class CORE_LIBRARY_DLL_SHARED_API SimpleTcpClient final
{
public:
    SimpleTcpClient() = delete;
    SimpleTcpClient(boost_iocontext_t& ioContext, const defs::connection_t& server,
                    const defs::default_message_dispatcher_t& messageDispatcher,
                    eSendOption                               sendOption = eSendOption::nagleOn,
                    size_t maxAllowedUnsentAsyncMessages = MAX_UNSENT_ASYNC_MSG_COUNT,
                    size_t memPoolMsgCount               = 0);
    SimpleTcpClient(const defs::connection_t&                 server,
                    const defs::default_message_dispatcher_t& messageDispatcher,
                    eSendOption                               sendOption = eSendOption::nagleOn,
                    size_t maxAllowedUnsentAsyncMessages = MAX_UNSENT_ASYNC_MSG_COUNT,
                    size_t memPoolMsgCount               = 0);
    ~SimpleTcpClient() = default;
    SimpleTcpClient(const SimpleTcpClient&) = delete;
    SimpleTcpClient& operator=(const SimpleTcpClient&) = delete;
    SimpleTcpClient(SimpleTcpClient&&) = delete;
    SimpleTcpClient& operator=(SimpleTcpClient&&) = delete;
    defs::connection_t ServerConnection() const;
    bool Connected() const;
    defs::connection_t GetClientDetailsForServer();
    void CloseConnection();
    bool
    SendMessageToServerAsync(int32_t                   messageId,
                             const defs::connection_t& responseAddress = defs::NULL_CONNECTION);
    bool SendMessageToServerSync(int32_t                   messageId,
                                 const defs::connection_t& responseAddress = defs::NULL_CONNECTION);
    bool
    SendMessageToServerAsync(const defs::char_buffer_t& message, int32_t messageId,
                             const defs::connection_t& responseAddress = defs::NULL_CONNECTION);
    bool SendMessageToServerSync(const defs::char_buffer_t& message, int32_t messageId,
                                 const defs::connection_t& responseAddress = defs::NULL_CONNECTION);
    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)
    {
        return m_tcpTypedClient.SendMessageToServerAsync<T, A>(message, messageId, responseAddress);
    }
    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)
    {
        return m_tcpTypedClient.SendMessageToServerSync<T, A>(message, messageId, responseAddress);
    }
    bool SendMessageToServerAsync(const defs::char_buffer_t& message);
    bool SendMessageToServerSync(const defs::char_buffer_t& message);
    size_t NumberOfUnsentAsyncMessages() const;

private:
    messages::MessageBuilder m_messageBuilder{};
    messages::MessageHandler m_messageHandler{};
    TcpTypedClient<messages::MessageBuilder> m_tcpTypedClient;
};

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

#endif // SIMPLETCPCLIENT