TcpConnection.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 TCPCONNECTION
#define TCPCONNECTION

#include "AsioDefines.h"
#include "Threads/SyncEvent.h"
#include <mutex>

namespace core_lib
{
namespace asio
{
namespace tcp
{

class TcpConnections;

class CORE_LIBRARY_DLL_SHARED_API TcpConnection final
    : public std::enable_shared_from_this<TcpConnection>
{
public:
    TcpConnection() = delete;
    TcpConnection(boost_iocontext_t& ioContext, TcpConnections& connections, 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);
    TcpConnection(const TcpConnection&) = delete;
    TcpConnection& operator=(const TcpConnection&) = delete;
    TcpConnection(TcpConnection&&) = delete;
    TcpConnection& operator=(TcpConnection&&) = delete;
    virtual ~TcpConnection() = default;
    boost_tcp_t::socket& Socket();
    const boost_tcp_t::socket& Socket() const;
    void Connect(const defs::connection_t& endPoint);
    void CloseConnection();
    void StartAsyncRead();
    bool SendMessageAsync(const defs::char_buffer_t& message);
    bool SendMessageSync(const defs::char_buffer_t& message);
    size_t NumberOfUnsentAsyncMessages() const;

private:
    void SetClosing(bool closing);
    bool IsClosing() const;
    void ProcessCloseSocket();
    void DestroySelf();
    void AsyncReadFromSocket(size_t amountToRead);
    void ReadComplete(const boost_sys::error_code& error, size_t bytesReceived,
                      size_t bytesExpected);
    void AsyncWriteToSocket(defs::char_buffer_t const& message);
    bool IncrementUnsentAsyncCounter();
    void DecrementUnsentAsyncCounter();

private:
    mutable std::mutex m_mutex;
    threads::SyncEvent m_closedEvent{};
    bool m_closing{false};
    boost_iocontext_t::strand m_strand;
    TcpConnections& m_connections;
    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};
    defs::char_buffer_t m_receiveBuffer{};
    defs::char_buffer_t m_messageBuffer{};
    size_t m_maxAllowedUnsentAsyncMessages{MAX_UNSENT_ASYNC_MSG_COUNT};
    size_t m_numUnsentAsyncMessages{0};
    boost_tcp_t::socket m_socket;
};

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

#endif // TCPCONNECTION