GoCtrlChannel.h

Go to the documentation of this file.

#ifndef GO_PXL_SDK_GOCTRLCHANNEL_H
#define GO_PXL_SDK_GOCTRLCHANNEL_H


#include <kApi/Io/kNetwork.h>
#include <kApi/kApiDef.h>

#include <GoPxLSdk/Def.h>
#include <GoPxLSdk/GoResponse.h>
#include <GoPxLSdk/GoRequest.h>

namespace GoPxLSdk
{

enum class GoCtrlChannelErrorType : uint8_t
{
    Read,   // Indicates there was an error while reading data.
    Write   // Indicates there was an error while writing data.
};

using GoCtrlChannelResponseHandler = std::function<void(const std::shared_ptr<GoResponse> response)>;

using GoCtrlChannelErrorHandler = std::function<void(GoCtrlChannelErrorType type, k64u id, const std::exception& e)>;

class GoPxLSdkClass GoCtrlChannel
{
public:
    virtual ~GoCtrlChannel() = default;

    virtual void Connect(const kIpAddress& address, k32u port, 
                         k64u connectionTimeout = GO_PXL_SDK_DEFAULT_TCP_TIMEOUT_MILLISECONDS) = 0;

    virtual void Disconnect() = 0;

    virtual bool IsConnected() const = 0;

    virtual void SendRequest(const GoRequest& request) = 0;

    virtual void SetResponseHandler(GoCtrlChannelResponseHandler callback) = 0;


    virtual void SetErrorHandler(GoCtrlChannelErrorHandler callback) = 0;

};

}

#endif