TcpClient.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 TCPCLIENT
#define TCPCLIENT

#include "IoContextThreadGroup.h"
#include "TcpConnections.h"

namespace core_lib
{
namespace asio
{
namespace tcp
{

class CORE_LIBRARY_DLL_SHARED_API TcpClient final
{
public:
    TcpClient() = delete;
    TcpClient(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,
              eSendOption                             sendOption = eSendOption::nagleOn,
              size_t maxAllowedUnsentAsyncMessages               = MAX_UNSENT_ASYNC_MSG_COUNT);
    TcpClient(const defs::connection_t& server, size_t minAmountToRead,
              const defs::check_bytes_left_to_read_t& checkBytesLeftToRead,
              const defs::message_received_handler_t& messageReceivedHandler,
              eSendOption                             sendOption = eSendOption::nagleOn,
              size_t maxAllowedUnsentAsyncMessages               = MAX_UNSENT_ASYNC_MSG_COUNT);
    ~TcpClient();
    TcpClient(const TcpClient&) = delete;
    TcpClient& operator=(const TcpClient&) = delete;
    TcpClient(TcpClient&&) = delete;
    TcpClient& operator=(TcpClient&&) = delete;
    defs::connection_t ServerConnection() const;
    bool Connected() const;
    defs::connection_t GetClientDetailsForServer() const;
    bool CheckAndCreateConnection();
    void CloseConnection();
    bool SendMessageToServerAsync(const defs::char_buffer_t& message);
    bool SendMessageToServerSync(const defs::char_buffer_t& message);
    size_t NumberOfUnsentAsyncMessages() const;

private:
    void CreateConnection();

private:
    std::unique_ptr<IoContextThreadGroup> m_ioThreadGroup{};
    boost_iocontext_t& m_ioContext;
    defs::connection_t m_server{};
    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};
    TcpConnections m_serverConnection{};
};

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

#endif // TCPCLIENT