Fledge
An open source edge computing platform for industrial users
storage_plugin.h
1 #ifndef _STORAGE_PLUGIN
2 #define _STORAGE_PLUGIN
3 /*
4  * Fledge storage service.
5  *
6  * Copyright (c) 2017 OSisoft, LLC
7  *
8  * Released under the Apache 2.0 Licence
9  *
10  * Author: Mark Riddoch, Massimiliano Pinto
11  */
12 
13 #include <plugin.h>
14 #include <plugin_manager.h>
15 #include <string>
16 #include <reading_stream.h>
17 #include <plugin_configuration.h>
18 
19 #define STORAGE_PURGE_RETAIN_ANY 0x0001U
20 #define STORAGE_PURGE_RETAIN_ALL 0x0002U
21 #define STORAGE_PURGE_SIZE 0x0004U
22 
34 class StoragePlugin : public Plugin {
35 
36 public:
37  StoragePlugin(const std::string& name, PLUGIN_HANDLE handle);
38  ~StoragePlugin();
39 
40  int commonInsert(const std::string& table, const std::string& payload, const char *schema = nullptr);
41  char *commonRetrieve(const std::string& table, const std::string& payload, const char *schema = nullptr);
42  int commonUpdate(const std::string& table, const std::string& payload, const char *schema = nullptr);
43  int commonDelete(const std::string& table, const std::string& payload, const char *schema = nullptr);
44  int readingsAppend(const std::string& payload);
45  char *readingsFetch(unsigned long id, unsigned int blksize);
46  char *readingsRetrieve(const std::string& payload);
47  char *readingsPurge(unsigned long age, unsigned int flags, unsigned long sent);
48  long *readingsPurge();
49  char *readingsPurgeAsset(const std::string& asset);
50  void release(const char *response);
51  int createTableSnapshot(const std::string& table, const std::string& id);
52  int loadTableSnapshot(const std::string& table, const std::string& id);
53  int deleteTableSnapshot(const std::string& table, const std::string& id);
54  char *getTableSnapshots(const std::string& table);
55  PLUGIN_ERROR *lastError();
56  bool hasStreamSupport() { return readingStreamPtr != NULL; };
57  int readingStream(ReadingStream **stream, bool commit);
58  bool pluginShutdown();
59  int createSchema(const std::string& payload);
60  StoragePluginConfiguration
61  *getConfig() { return m_config; };
62  const std::string
63  &getName() { return m_name; };
64 
65 private:
66  PLUGIN_HANDLE instance;
67  int (*commonInsertPtr)(PLUGIN_HANDLE, const char *, const char *) = nullptr;
68  char *(*commonRetrievePtr)(PLUGIN_HANDLE, const char *, const char *) = nullptr;
69  int (*commonUpdatePtr)(PLUGIN_HANDLE, const char *, const char *) = nullptr;
70  int (*commonDeletePtr)(PLUGIN_HANDLE, const char *, const char *) = nullptr;
71  int (*storageSchemaInsertPtr)(PLUGIN_HANDLE, const char *, const char *, const char*) = nullptr;
72  char *(*storageSchemaRetrievePtr)(PLUGIN_HANDLE, const char *, const char *, const char*) = nullptr;
73  int (*storageSchemaUpdatePtr)(PLUGIN_HANDLE, const char *, const char *, const char*) = nullptr;
74  int (*storageSchemaDeletePtr)(PLUGIN_HANDLE, const char *, const char *, const char*) = nullptr;
75  int (*readingsAppendPtr)(PLUGIN_HANDLE, const char *);
76  char *(*readingsFetchPtr)(PLUGIN_HANDLE, unsigned long id, unsigned int blksize);
77  char *(*readingsRetrievePtr)(PLUGIN_HANDLE, const char *payload);
78  char *(*readingsPurgePtr)(PLUGIN_HANDLE, unsigned long age, unsigned int flags, unsigned long sent);
79  unsigned int (*readingsPurgeAssetPtr)(PLUGIN_HANDLE, const char *asset);
80  void (*releasePtr)(PLUGIN_HANDLE, const char *payload);
81  int (*createTableSnapshotPtr)(PLUGIN_HANDLE, const char *, const char *);
82  int (*loadTableSnapshotPtr)(PLUGIN_HANDLE, const char *, const char *);
83  int (*deleteTableSnapshotPtr)(PLUGIN_HANDLE, const char *, const char *);
84  char *(*getTableSnapshotsPtr)(PLUGIN_HANDLE, const char *);
85  int (*readingStreamPtr)(PLUGIN_HANDLE, ReadingStream **, bool);
86  PLUGIN_ERROR *(*lastErrorPtr)(PLUGIN_HANDLE);
87  bool (*pluginShutdownPtr)(PLUGIN_HANDLE);
88  int (*createSchemaPtr)(PLUGIN_HANDLE, const char*);
89  std::string m_name;
90  StoragePluginConfiguration
91  *m_config;
92  bool m_bStorageSchemaFlag = false;
93 };
94 
95 #endif
StoragePlugin::commonRetrieve
char * commonRetrieve(const std::string &table, const std::string &payload, const char *schema=nullptr)
Call the retrieve method in the plugin.
Definition: storage_plugin.cpp:159
StoragePlugin::getTableSnapshots
char * getTableSnapshots(const std::string &table)
Call the get table snaphot method in the plugin.
Definition: storage_plugin.cpp:304
StoragePlugin
Class that represents a storage plugin.
Definition: storage_plugin.h:34
StoragePluginConfiguration
The storage service must handle its own configuration differently to other services as it is unable t...
Definition: plugin_configuration.h:28
StoragePlugin::loadTableSnapshot
int loadTableSnapshot(const std::string &table, const std::string &id)
Call the load table snaphot method in the plugin.
Definition: storage_plugin.cpp:288
ReadingStream
Definition: reading_stream.h:42
StoragePlugin::commonInsert
int commonInsert(const std::string &table, const std::string &payload, const char *schema=nullptr)
Call the insert method in the plugin.
Definition: storage_plugin.cpp:142
StoragePlugin::readingsAppend
int readingsAppend(const std::string &payload)
Call the readings append method in the plugin.
Definition: storage_plugin.cpp:210
StoragePlugin::readingsFetch
char * readingsFetch(unsigned long id, unsigned int blksize)
Call the readings fetch method in the plugin.
Definition: storage_plugin.cpp:218
StoragePlugin::pluginShutdown
bool pluginShutdown()
Call the shutdown entry point of the plugin.
Definition: storage_plugin.cpp:320
StoragePlugin::deleteTableSnapshot
int deleteTableSnapshot(const std::string &table, const std::string &id)
Call the delete table snaphot method in the plugin.
Definition: storage_plugin.cpp:296
Plugin
A generic representation of a plugin.
Definition: plugin.h:20
StoragePlugin::commonUpdate
int commonUpdate(const std::string &table, const std::string &payload, const char *schema=nullptr)
Call the update method in the plugin.
Definition: storage_plugin.cpp:176
StoragePlugin::readingsRetrieve
char * readingsRetrieve(const std::string &payload)
Call the readings retrieve method in the plugin.
Definition: storage_plugin.cpp:226
StoragePlugin::readingsPurge
char * readingsPurge(unsigned long age, unsigned int flags, unsigned long sent)
Call the readings purge method in the plugin.
Definition: storage_plugin.cpp:234
StoragePlugin::createSchema
int createSchema(const std::string &payload)
Call the schema create method in the plugin.
Definition: storage_plugin.cpp:330
StoragePlugin::readingStream
int readingStream(ReadingStream **stream, bool commit)
Call the reading stream method in the plugin.
Definition: storage_plugin.cpp:312
StoragePlugin::release
void release(const char *response)
Release a result from a retrieve.
Definition: storage_plugin.cpp:264
StoragePlugin::StoragePlugin
StoragePlugin(const std::string &name, PLUGIN_HANDLE handle)
Constructor for the class that wraps the storage plugin.
Definition: storage_plugin.cpp:24
StoragePlugin::lastError
PLUGIN_ERROR * lastError()
Get the last error from the plugin.
Definition: storage_plugin.cpp:272
StoragePlugin::commonDelete
int commonDelete(const std::string &table, const std::string &payload, const char *schema=nullptr)
Call the delete method in the plugin.
Definition: storage_plugin.cpp:193
StoragePlugin::readingsPurgeAsset
char * readingsPurgeAsset(const std::string &asset)
Call the readings purge asset method in the plugin.
Definition: storage_plugin.cpp:242
PLUGIN_ERROR
Structure used by plugins to return error information.
Definition: plugin_api.h:44
StoragePlugin::createTableSnapshot
int createTableSnapshot(const std::string &table, const std::string &id)
Call the create table snaphot method in the plugin.
Definition: storage_plugin.cpp:280