GoDiscoveryClient.h

Go to the documentation of this file.

#ifndef GO_PXL_SDK_GODISCOVERYCLIENT_H
#define GO_PXL_SDK_GODISCOVERYCLIENT_H

#include <kApi/kApi.h>
#include <GoPxLSdk/GoJson.h>
#include <GoPxLSdk/GoInstance.h>
#include <GoApi/Exception.h>

class GoDiscoveryClientTests;

namespace GoPxLSdk 
{
const k64u GOPXL_BROADCAST_SIGNATURE                = 0x4C58504F47494D4C; // "LMIGOPXL"
const k16u GOPXL_RESERVED_PORT_DISCOVERY_PROTOCOL   = 3320;
const k64u GOPXL_DISCOVERY_MESSAGE_DISCOVER         = 0x0001;
const k64u GOPXL_DISCOVERY_MESSAGE_ANNOUNCE         = 0x1001;
const kSize MAX_MESSAGE_SIZE                        = 1536;
const kSSize CLIENT_BUFFER_SIZE                     = 1536;
const kSSize CLIENT_SOCKET_SIZE                     = -1;

const std::string GOPXL_DISCOVERY_SERIAL_NUMBER     = "SerialNumber";
const std::string GOPXL_DISCOVERY_DEVICE_MODEL      = "DeviceModel";
const std::string GOPXL_DISCOVERY_APP_NAME          = "AppName";
const std::string GOPXL_DISCOVERY_APP_ID            = "AppId";
const std::string GOPXL_DISCOVERY_APP_VERSION       = "AppVersion";
const std::string GOPXL_DISCOVERY_CONTROL_PORT      = "ControlPort";
const std::string GOPXL_DISCOVERY_WEB_PORT          = "WebPort";
const std::string GOPXL_DISCOVERY_GDP_PORT          = "GdpPort";
const std::string GOPXL_DISCOVERY_ADDRESS           = "Address";
const std::string GOPXL_DISCOVERY_MASK              = "Mask";
const std::string GOPXL_DISCOVERY_GATEWAY           = "Gateway";
const std::string GOPXL_DISCOVERY_DHCP              = "Dhcp";
const std::string GOPXL_DISCOVERY_IS_REMOTE         = "IsRemote";
const std::string GOPXL_DISCOVERY_ADDRESS_CONFLICT  = "AddressConflict";

// Message request that is sent to the discovery server.
struct DiscoveryBroadcastHeader
{
    k64u            length;
    k64u            messageId;
    k64u            signature;
};

// Message header of the response that the discovery server sends back 
// to discovery client.
struct DiscoveryServerHeader
{
    k64u            length;
    k64u            messageId;
    k64u            signature;
    k64u            messageStatus;
};

class GoPxLSdkClass GoDiscoveryClient
{
    friend class ::GoDiscoveryClientTests;

public:
    GoDiscoveryClient() = default;
    ~GoDiscoveryClient() = default;

    void BlockingDiscover(k64u timeoutInMilliseconds);

    const std::vector<GoInstance>& InstanceList();

    const GoInstance* Instance(std::string ipAddress, k32u webPort);

private:

    void ConstructReceiver(kUdpClient* receiver);

    void ConstructSender(kUdpClient* sender, kIpAddress address);

    void Broadcast(const void* data, k32u length);

    void ParseReply(Byte bytes[]);

    std::vector<GoInstance> instances;
};

}

#endif