nx_cloud_storage_sdk  1.0
Cloud Storage SDK
i_plugin.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_plugin.h>
6 #include <nx/sdk/i_string.h>
7 #include <nx/sdk/interface.h>
8 #include <nx/sdk/result.h>
9 
10 #include "i_archive_update_handler.h"
11 #include "i_engine.h"
12 
13 namespace nx::sdk::cloud_storage {
14 
18 class IPlugin: public Interface<IPlugin, nx::sdk::IPlugin>
19 {
20 public:
21  static auto interfaceId()
22  {
23  return makeIdWithAlternative("nx::sdk::archive::IPlugin",
24  /* Planned future renaming. */ "nx::sdk::archive::IIntegration");
25  }
26 
27  protected: virtual void getManifest(Result<const IString*>* outResult) const = 0;
33  {
35  getManifest(&result);
36  return result;
37  }
38 
39  protected: virtual void doObtainEngine(const char* url,
40  const IArchiveUpdateHandler* archiveUpdateHandler,
41  Result<IEngine*>* outResult) = 0;
42 
50  const char* url, const IArchiveUpdateHandler* archiveUpdateHandler)
51  {
52  Result<IEngine*> result;
53  doObtainEngine(url, archiveUpdateHandler, &result);
54  return result;
55  }
56 };
57 
58 } // namespace nx::sdk::cloud_storage
Result< const IString * > manifest() const
Definition: i_plugin.h:32
Definition: interface.h:48
Definition: i_archive_update_handler.h:39
Definition: result.h:48
Result< IEngine * > obtainEngine(const char *url, const IArchiveUpdateHandler *archiveUpdateHandler)
Definition: i_plugin.h:49
Definition: i_plugin.h:18
Definition: algorithm.cpp:9
static std::vector< const InterfaceId * > makeIdWithAlternative(const char(&charArray)[len], const char(&alternativeCharArray)[alternativeLen])
Definition: i_ref_countable.h:87