plugin_api.h

#ifndef _PLUGIN_API
#define _PLUGIN_API
/*
 * Fledge storage service.
 *
 * Copyright (c) 2017,2018 OSisoft, LLC
 *
 * Released under the Apache 2.0 Licence
 *
 * Author: Mark Riddoch, Massimiliano Pinto
 */
#include <string>
 
#define TO_STRING(...) DEFER(TO_STRING_)(__VA_ARGS__)
#define DEFER(x) x
#define TO_STRING_(...) #__VA_ARGS__
#define QUOTE(...) TO_STRING(__VA_ARGS__)
 
typedef struct {
        const char  *name;
        const char  *version;
        unsigned int    options;
        const char  *type;
        const char  *interface;
    const char  *config;
} PLUGIN_INFORMATION;
 
typedef struct {
        char         *message;
        char         *entryPoint;
        bool         retryable;
} PLUGIN_ERROR;
 
typedef struct plugin_parameter {
    std::string name;
    std::string value;
} PLUGIN_PARAMETER;
 
typedef void * PLUGIN_HANDLE;
 
typedef enum controlDestination {
    DestinationAsset,
    DestinationService,
    DestinationBroadcast,
    DestinationScript
} ControlDestination;
 
#define SP_COMMON       0x0001
#define SP_READINGS     0x0002
 
#define SP_ASYNC        0x0004
 
#define SP_PERSIST_DATA     0x0008
 
#define SP_INGEST       0x0010
 
#define SP_GET_MANAGEMENT   0x0020
 
#define SP_GET_STORAGE      0x0040
 
#define SP_DEPRECATED       0x0080
 
#define SP_BUILTIN      0x0100
 
#define SP_CONTROL      0x1000
 
#define PLUGIN_TYPE_STORAGE         "storage"
#define PLUGIN_TYPE_SOUTH           "south"
#define PLUGIN_TYPE_NORTH           "north"
#define PLUGIN_TYPE_FILTER          "filter"
#define PLUGIN_TYPE_NOTIFICATION_RULE       "notificationRule"
#define PLUGIN_TYPE_NOTIFICATION_DELIVERY   "notificationDelivery"
 
#endif