GoRestClient.h

Go to the documentation of this file.

#ifndef GO_PXL_SDK_GORESTCLIENT_H
#define GO_PXL_SDK_GORESTCLIENT_H

#include <kApi/Io/kNetwork.h>

#include <GoPxLSdk/GoJson.h>
#include <GoPxLSdk/GoResponse.h>
#include <GoPxLSdk/GoTransaction.h>
#include <GoPxLSdk/Internal/GoCtrlChannel.h>
#include <GoPxLSdk/Internal/V1/GoCtrlChannelV1.h>

class GoRestClientTests;

namespace GoPxLSdk
{
using GoNotificationHandler = std::function<void(const std::shared_ptr<GoNotificationResponse>&)>;

using GoStreamHandler = std::function<void(const std::shared_ptr<GoStreamResponse>&)>;

class GoPxLSdkClass GoRestClient
{
public:
    GoRestClient();

    ~GoRestClient() = default;

    void Connect(kIpAddress address, k16u port = 0);

    void Disconnect();

    bool IsConnected() const;

    GoTransaction Read(const std::string& uri, const GoJson& content = {}, const GoJson& args = {});

    GoTransaction Update(const std::string& uri, const GoJson& content = {}, const GoJson& args = {});

    GoTransaction Create(const std::string& uri, const GoJson& content = {}, const GoJson& args = {});

    GoTransaction Delete(const std::string& uri, const GoJson& content = {}, const GoJson& args = {});

    GoTransaction Call(const std::string& uri, const GoJson& content = {}, const GoJson& args = {});

    GoTransaction Sub(const std::string& uri, const GoJson& content = {}, const GoJson& args = {});

    GoTransaction UnSub(const std::string& uri, const GoJson& content = {}, const GoJson& args = {});

    void SetSubHandler(const GoNotificationHandler& callback);

    GoTransaction StartStream(const std::string & uri, const GoJson& content = {}, const GoJson& args = {});

    GoTransaction StopStream(const std::string& uri, const GoJson& content = {}, const GoJson& args = {});

    void SetStreamHandler(const GoStreamHandler& callback);

    void SetReadErrorHandler(const GoCtrlChannelReadErrorHandler& callback);

private:
    void ResponseHandler(std::shared_ptr<GoResponse> response);

    void WriteErrorHandler(k64u requestId, const std::exception& e);

    void Callback(std::shared_ptr<GoResponse> response);

    std::mutex commandMutex;

    // Using std::deque instead of std::queue, because it provides iterator used by `HandleReadError` and `HandleWriteError`.
    std::deque<GoTransaction> transactionQueue;

    std::shared_ptr<GoCtrlChannel> channel;
    
    GoStreamHandler streamHandler;
    GoNotificationHandler notificationHandler;

    friend class ::GoRestClientTests;
};

}

#endif