nx_server_plugin_sdk  1.0
Server Plugin SDK
i_utility_provider.h
1 // Copyright 2018-present Network Optix, Inc. Licensed under MPL 2.0: www.mozilla.org/MPL/2.0/
2 
3 #pragma once
4 
5 #include <nx/sdk/i_string.h>
6 #include <nx/sdk/interface.h>
7 #include <nx/sdk/result.h>
8 
9 namespace nx::sdk {
10 
21 class IUtilityProvider0: public Interface<IUtilityProvider0>
22 {
23 public:
24  static auto interfaceId() { return makeId("nx::sdk::IUtilityProvider"); }
25 
30  virtual int64_t vmsSystemTimeSinceEpochMs() const = 0;
31 
33  protected: virtual const IString* getHomeDir() const = 0;
45  public: std::string homeDir() const { return Ptr(getHomeDir())->str(); }
46 };
47 
48 class IUtilityProvider1: public Interface<IUtilityProvider1, IUtilityProvider0>
49 {
50 public:
51  static auto interfaceId() { return makeId("nx::sdk::IUtilityProvider1"); }
52 
54  protected: virtual const IString* getServerSdkVersion() const = 0;
58  public: std::string serverSdkVersion() const { return Ptr(getServerSdkVersion())->str(); }
59 };
60 
61 class IUtilityProvider2: public Interface<IUtilityProvider2, IUtilityProvider1>
62 {
63 public:
64  static auto interfaceId() { return makeId("nx::sdk::IUtilityProvider2"); }
65 
66  virtual const char* serverId() const = 0;
67 };
68 
69 class IUtilityProvider3: public Interface<IUtilityProvider3, IUtilityProvider2>
70 {
71 public:
72  static auto interfaceId() { return makeId("nx::sdk::IUtilityProvider3"); }
73 
74  virtual IString* cloudSystemId() const = 0;
75  virtual IString* cloudAuthKey() const = 0;
76 };
77 
78 class IUtilityProvider4: public Interface<IUtilityProvider4, IUtilityProvider3>
79 {
80 public:
81  static auto interfaceId() { return makeId("nx::sdk::IUtilityProvider4"); }
82 
83  enum class HttpDomainName: int
84  {
85  cloud,
86  vms,
87  };
88 
93  class IHttpRequestCompletionHandler: public Interface<IHttpRequestCompletionHandler>
94  {
95  public:
96  static auto interfaceId() { return makeId("nx::sdk::IHttpRequestCompletionHandler"); }
97 
98  virtual void execute(Result<IString*> response) = 0;
99  };
101 
103  protected: virtual void doSendHttpRequest(
104  HttpDomainName requestDomainName,
105  const char* url,
106  const char* httpMethod,
107  const char* mimeType,
108  const char* requestBody,
109  IHttpRequestCompletionHandler* callback) const = 0;
116  public: void sendHttpRequest(
117  HttpDomainName requestDomainName,
118  const char* url,
119  const char* httpMethod,
120  const char* mimeType,
121  const char* requestBody,
122  Ptr<IHttpRequestCompletionHandler> callback) const
123  {
125  requestDomainName, url, httpMethod, mimeType, requestBody, callback.get());
126  }
127 };
128 
129 class ICloudTokenSubscriber : public Interface<ICloudTokenSubscriber>
130 {
131 public:
132  virtual void updated(const char* token) const = 0;
133 };
134 
135 class IUtilityProvider5: public Interface<IUtilityProvider5, IUtilityProvider4>
136 {
137 public:
138  static auto interfaceId() { return makeId("nx::sdk::IUtilityProvider5"); }
139 
144  virtual const char* cloudToken() const = 0;
145 
149  virtual void subscribeForCloudTokenUpdate(ICloudTokenSubscriber* subscriber) = 0;
150 };
151 
152 class IUtilityProvider6: public Interface<IUtilityProvider6, IUtilityProvider5>
153 {
154 public:
155  static auto interfaceId() { return makeId("nx::sdk::IUtilityProvider6"); }
156 
163  virtual IString* supportedVectorizationModels() const = 0;
164 };
165 
166 class IUtilityProvider: public Interface<IUtilityProvider, IUtilityProvider6>
167 {
168 public:
169  static auto interfaceId() { return makeId("nx::sdk::IUtilityProvider7"); }
170 
172  protected: virtual IString* getDataDir() const = 0;
173 
178  public: std::string dataDir() const { return Ptr(getDataDir())->str(); }
179 };
180 
181 using IUtilityProvider7 = IUtilityProvider;
182 
183 } // namespace nx::sdk
Definition: i_utility_provider.h:78
Definition: i_utility_provider.h:61
std::string dataDir() const
Definition: i_utility_provider.h:178
virtual void subscribeForCloudTokenUpdate(ICloudTokenSubscriber *subscriber)=0
void sendHttpRequest(HttpDomainName requestDomainName, const char *url, const char *httpMethod, const char *mimeType, const char *requestBody, Ptr< IHttpRequestCompletionHandler > callback) const
Definition: i_utility_provider.h:116
Definition: interface.h:48
virtual const IString * getHomeDir() const =0
std::string serverSdkVersion() const
Definition: i_utility_provider.h:58
Definition: i_utility_provider.h:69
virtual IString * getDataDir() const =0
Definition: i_utility_provider.h:48
Definition: ptr.h:18
std::string homeDir() const
Definition: i_utility_provider.h:45
virtual int64_t vmsSystemTimeSinceEpochMs() const =0
Definition: i_utility_provider.h:152
Definition: i_string.h:9
virtual void doSendHttpRequest(HttpDomainName requestDomainName, const char *url, const char *httpMethod, const char *mimeType, const char *requestBody, IHttpRequestCompletionHandler *callback) const =0
Definition: result.h:52
Definition: i_utility_provider.h:166
Definition: i_utility_provider.h:21
Definition: device_agent.h:12
Definition: i_utility_provider.h:129
Definition: i_utility_provider.h:135
virtual const char * cloudToken() const =0
virtual IString * supportedVectorizationModels() const =0
virtual const IString * getServerSdkVersion() const =0
static const InterfaceId * makeId(const char(&charArray)[len])
Definition: i_ref_countable.h:77