visualdebugclient.h

Go to the documentation of this file.

/*
* Copyright 2016 Autodesk, Inc. All rights reserved.
* Use of this software is subject to the terms of the Autodesk license agreement and any attachments or Appendices thereto provided at the time of installation or download,
* or which otherwise accompanies this software in either electronic or hard copy form, or which is signed by you and accepted by Autodesk.
*/

#pragma once

#include "gwnavruntime/kernel/SF_Types.h"
#include "gwnavruntime/kernel/SF_Threads.h"
#include "gwnavruntime/base/types.h"
#include "gwnavruntime/base/memory.h"

#if defined(KY_CONFIG_RELEASE) || !defined(KY_ENABLE_SOCKETS)
# define KY_DISABLE_VISUALDEBUGCLIENT
#endif

#ifndef KY_DISABLE_VISUALDEBUGCLIENT

#include "gwnavruntime/visualdebug/internal/socketdispatcher.h"
#include "gwnavruntime/visualdebug/amp/Amp_ThreadMgr.h"
#include "gwnavruntime/visualdebug/messagereceiverregistry.h"
#include "gwnavruntime/visualdebug/messages/messageblobhandler.h"
#include "gwnavruntime/visualdebug/visualdebugunknownblobtypehandling.h"
#include "gwnavruntime/blob/baseblobbuilder.h"
#include "gwnavruntime/containers/kyarray.h"

namespace Kaim
{

class FileOpenerBase;
class File;

class IQuery;
class MessageBlob;
class MessageAggregatedBlob;
class SocketDispatcherFactory;
class ClientStatusChangedCallback;
class AcknowledgeConnectionMessageReceiver;

class VisualDebugClientScopedFileWriter;


class MessagePortHandler;

class VisualDebugClient
{
    KY_DEFINE_NEW_DELETE_OPERATORS(MemStat_VisualDebug)
public:
    enum RunMode
    {
        RunSynchronously = 0, 
        RunAsynchronously = 1 
    };


    // ------------------ Main API ------------------

    VisualDebugClient();
    ~VisualDebugClient();

    static KyUInt32 GetInfiniteWaitDelay() { return KY_WAIT_INFINITE; }

    KyResult SetupReceiverRegistry(MessageReceiverRegistry& receiverRegistry, VisualDebugUnknownBlobTypeHandling unknownBlobTypeHandling = VisualDebugUnknownBlobTypeHandling::Log);


    // ------------------ Server Connection Mode ------------------

    KyResult ConnectToServer(const char* ipAddress, KyUInt32 port, RunMode runMode = RunSynchronously);

    void CloseConnection();

    bool IsConnected() const;

    bool IsConnectionEstablished() const;

    bool IsReceptionPipelineEmpty()
    { return (m_socketThreadMgr ? m_socketThreadMgr->IsReceptionPipelineEmpty() : true); }

    KyResult Update();


    template <class T>
    KyResult Send(BaseBlobBuilder<T>& blobBuilder)
    {
        if (m_socketThreadMgr)
        {
            blobBuilder.m_heap = GetHeap();
            Ptr<BaseBlobHandler> blobHandler = *KY_HEAP_NEW(blobBuilder.m_heap) BlobHandler<T>;
            blobBuilder.Build((BlobHandler<T>&)*blobHandler);
            return this->CreateMessageAndSend(blobHandler);
        }
        return KY_ERROR;
    }

    KyResult SendEndOfSynchronization();

    KyResult Send(Kaim::BaseBlobHandler& blobHandler);

    KyResult SendFlatBlob(KyUInt32 blobtypeId, KyUInt32 size, char* blob);

    // Used to send queries to be exectued remotely
    KyResult Send(IQuery* query);

    // Wait until connection is established, or until the specified time interval has passed.
    bool WaitWhileEstablishingConnection(KyUInt32 maxDelayMilliseconds);


    // ------------------ Broadcast Mode ------------------
    void StartListeningForAvailableServers(KyUInt32 port, RunMode runMode = RunAsynchronously); 
    void ListenForAvailableServers();
    void GetAvailableServers(KyArray<Ptr<Net::AMP::MessagePort> >& availableServers);
    void StopListeningForAvailableServers();

    // ------------------ File Modes ------------------
    KyResult ReadFromFile(const char* readFromFile, Kaim::FileOpenerBase* fileOpener, RunMode runMode = RunSynchronously);
    KyResult WriteToFile(const char* writeToFile, Kaim::FileOpenerBase* fileOpener, VisualDebugClientScopedFileWriter & writer, RunMode runMode = RunSynchronously);

private:
    void SetupMessageRegistryForServerPorts(Net::AMP::MessageTypeRegistry& customMsgTypeRegistry);
    void SetupMessageRegistryForBlobs(Net::AMP::MessageTypeRegistry& customMsgTypeRegistry);
    void CreateManager(SocketDispatchMode mode, Net::AMP::MessageTypeRegistry& customMsgTypeRegistry, bool initSocketConnection);
    void DestroyManager();

    KyResult OnConnection(); //< called from the socketThread when conneciton is established

    KyResult CreateMessageAndSend(Ptr<BaseBlobHandler> handlerPtr);
    KyResult CreateMessageAndSend(KyUInt32 blobtypeId, KyUInt32 shallowBlobSize, KyUInt32 deepBlobSize, char* blob);
    KyResult SendMessage(MessageBlob* msg);

    Ptr<Net::AMP::Message> CreateAndReadMessage(File& stream);

    void HandleAllReceivedMessages();
    void Handle(Ptr<Net::AMP::Message> msg);

public: //internal
    Net::AMP::ThreadMgr*       GetThreadMgr()       { return m_socketThreadMgr.GetPtr(); }
    const Net::AMP::ThreadMgr* GetThreadMgr() const { return m_socketThreadMgr.GetPtr(); }
    MemoryHeap* GetHeap() { return Memory::GetHeapByAddress(m_socketThreadMgr.GetPtr()); }

    void WaitForEmptiedSendQueue();

    RunMode GetRunMode() const { return m_runMode; }

    File* GetFile() { return m_file; }

private:
    static const KyUInt32 NotConnected = 0;
    std::atomic<KyUInt32> m_wasConnected; //used to check the connection.
    bool m_isSynchronized;

    KyArray<char> m_receiveBuffer;

    Kaim::Ptr<Net::AMP::ThreadMgr> m_socketThreadMgr;
    Kaim::Ptr<Net::AMP::DiscardMessageHandler> m_msgDiscarder;
    Kaim::Ptr<MessagePortHandler> m_receivedMsgPort;
    Kaim::Ptr<MessageBlobHandler> m_msgBlobHandler;
    Kaim::Ptr<MessageAggregatedBlobHandler> m_msgAggregatedBlobHandler;
    Kaim::SocketDispatcherFactory* m_socketFactory;
    Kaim::Ptr<File> m_file;

    // Callback for connection status change
    friend class ClientStatusChangedCallback;
    Kaim::Ptr<ClientStatusChangedCallback> m_statusCallback;
    Kaim::Event m_connectedEvent;

    RunMode m_runMode;
};

class VisualDebugClientScopedFileWriter
{
    KY_DEFINE_NEW_DELETE_OPERATORS(MemStat_VisualDebug)
public:
    VisualDebugClientScopedFileWriter();
    ~VisualDebugClientScopedFileWriter();

    KyResult Write(char* blob, KyUInt32 blobTypeId, KyUInt32 deepBlobSize);
    KyResult WriteFrame(char* blob, KyUInt32 blobTypeId, KyUInt32 deepBlobSize); // call WriteFrame to end the frame previous Write belonged to

private:
    KyResult CreateAggregateMessage(KyUInt32 deepBlobSize);
    KyResult WriteMessageToFile(Net::AMP::Message*& message);
    KyResult WriteToFile();

public: //internal
    void Init(VisualDebugClient* visualDebugClient, VisualDebugClient::RunMode runMode);

private:
    VisualDebugClient* m_visualDebugClient;
    VisualDebugClient::RunMode m_runMode;
    MessageAggregatedBlob* m_aggregatedBlobMsg;
};



} // namespace Kaim

#else

// Only keep symbols that could be used as parameters.
// VisualDebugClient is not expected to be used in Release.
namespace Kaim
{

class VisualDebugClient
{
    KY_DEFINE_NEW_DELETE_OPERATORS(MemStat_VisualDebug)
public:
    enum RunMode
    {
        RunSynchronously = 0,
        RunAsynchronously = 1
    };

    static KyUInt32 GetInfiniteWaitDelay() { return KY_WAIT_INFINITE; }
};

}

#endif