plugin_api.h

Go to the documentation of this file.

// BSD 3-Clause License
// Copyright (c) 2021-2025, 🍀☀🌕🌥 🌊
// See the LICENSE file in the project root for full license information.
 
#pragma once
 
#ifdef __cplusplus
extern "C" {
#endif
 
// Plugin API version (increment on breaking changes)
#define PLUGIN_API_VERSION 1
 
// Platform-specific export macro
#if defined(_WIN32) || defined(_WIN64)
    #define PLUGIN_EXPORT __declspec(dllexport)
#elif defined(__GNUC__) || defined(__clang__)
    #define PLUGIN_EXPORT __attribute__((visibility("default")))
#else
    #define PLUGIN_EXPORT
#endif
 
// Forward declaration for collector_plugin
// Actual definition is in collector_plugin.h (C++ header)
namespace kcenon { namespace monitoring { class collector_plugin; } }
 
typedef struct plugin_api_metadata {
    int api_version;
 
    const char* name;
 
    const char* version;
 
    const char* description;
 
    const char* author;
 
    const char* category;
} plugin_api_metadata;
 
typedef kcenon::monitoring::collector_plugin* (*create_plugin_fn)(void);
 
typedef void (*destroy_plugin_fn)(kcenon::monitoring::collector_plugin* plugin);
 
typedef const plugin_api_metadata* (*get_plugin_info_fn)(void);
 
#define CREATE_PLUGIN_FN_NAME "create_plugin"
#define DESTROY_PLUGIN_FN_NAME "destroy_plugin"
#define GET_PLUGIN_INFO_FN_NAME "get_plugin_info"
 
#ifdef __cplusplus
#define IMPLEMENT_PLUGIN(PluginClass, Name, Version, Description, Author, Category) \
    extern "C" { \
        PLUGIN_EXPORT struct collector_plugin* create_plugin() { \
            return new PluginClass(); \
        } \
        \
        PLUGIN_EXPORT void destroy_plugin(struct collector_plugin* plugin) { \
            delete plugin; \
        } \
        \
        PLUGIN_EXPORT const plugin_api_metadata* get_plugin_info() { \
            static plugin_api_metadata metadata = { \
                PLUGIN_API_VERSION, \
                Name, \
                Version, \
                Description, \
                Author, \
                Category \
            }; \
            return &metadata; \
        } \
    }
#endif
 
#ifdef __cplusplus
}
#endif