NET_PacketConnectionHandler.h

Go to the documentation of this file.

/*
 * PROPRIETARY INFORMATION.  This software is proprietary to
 * Side Effects Software Inc., and is not to be reproduced,
 * transmitted, or disclosed in any way without written permission.
 *
 * NAME:        NET_PacketConnectionHandler.h
 *
 * COMMENTS:
 *
 *
 */

#ifndef __NET_PACKETCONNECTIONHANDLER_H__
#define __NET_PACKETCONNECTIONHANDLER_H__

#include "NET_API.h"

#include "NET_ConnectionHandler.h"
#include "NET_PacketSocket.h"

#include <UT/UT_BoostAsio.h>
#include <UT/UT_SharedPtr.h>
#include <UT/UT_WorkBuffer.h>

#include <vector>

class NET_API NET_IPacketConnectionHandler
    : public NET_ConnectionHandler,
      public UTenable_shared_from_this<NET_IPacketConnectionHandler>
{
public:
    NET_IPacketConnectionHandler(
            NET_ConnectionManager& mgr,
            ASIO_TCPSocket socket);
    ~NET_IPacketConnectionHandler() override;

    void start() override;
protected:
    /// Called each time the socket has read a full packet that is ready to
    /// be handled.
    virtual void onPacket(UT_WorkBuffer&& data) = 0;
    /// Called whenever the received ec was an error.
    virtual void fail(const hboost::system::error_code& ec, const char* what);

    /// Hook: override to pause the read loop after onPacket() returns when
    /// the response will be delivered asynchronously via a later write().
    /// Default: false (resume reading immediately, current behaviour).
    virtual bool isResponsePending_() const { return false; }

    /// Thread-safe. Queue a message for sending and wake the writer. Safe
    /// to call from any thread/executor — the queue mutation and flush are
    /// dispatched onto the connection's IO executor.
    void write(const UT_StringHolder& message);

    virtual void requestStop(bool force);

    NET_PacketSocket& socket() { return mySocket; }

private:
    void stop(bool force) override;
    void startRead_();
    void flush_();

    std::vector<char> myInternalBuffer;
    hboost::asio::dynamic_vector_buffer<char, std::allocator<char>> myBuffer;
    NET_PacketSocket mySocket;
    bool myShutdownRequested = false;
    bool myIsWriting = false;
    UT_StringArray myWriteQueue;
};

#endif // __NET_PACKETCONNECTIONHANDLER_H__