/usr/include/syslog-ng/plugin.h is in syslog-ng-dev 3.8.1-10.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 | /*
* Copyright (c) 2002-2012 Balabit
* Copyright (c) 1998-2012 Balázs Scheidler
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
*
* As an additional exemption you are allowed to compile & link against the
* OpenSSL libraries as published by the OpenSSL project. See the file
* COPYING for details.
*
*/
#ifndef PLUGIN_H_INCLUDED
#define PLUGIN_H_INCLUDED
#include "cfg-parser.h"
typedef struct _Plugin Plugin;
typedef struct _ModuleInfo ModuleInfo;
/* A plugin actually registered by a module. See PluginCandidate in
* the implementation module, which encapsulates a demand-loadable
* plugin, not yet loaded.
*
* A plugin serves as the factory for an extension point (=plugin). In
* contrast with the "module" which is the shared object itself which
* registers plugins. Each module can register a number of plugins,
* not just one. */
struct _Plugin
{
/* NOTE: the first two fields must match PluginCandidate struct defined in
the plugin.c module, please modify them both at the same time! */
gint type;
const gchar *name;
CfgParser *parser;
void (*setup_context)(Plugin *self, GlobalConfig *cfg, gint plugin_type, const gchar *plugin_name);
gpointer (*construct)(Plugin *self, GlobalConfig *cfg, gint plugin_type, const gchar *plugin_name);
void (*free_fn)(Plugin *s);
};
struct _ModuleInfo
{
/* name of the module to be loaded as */
const gchar *canonical_name;
/* version number if any */
const gchar *version;
/* copyright information, homepage and other important information about the module */
const gchar *description;
/* git sha that identifies the core revision that this was compiled for */
const gchar *core_revision;
Plugin *plugins;
gint plugins_len;
/* the higher the better */
gint preference;
};
/* instantiate a new plugin */
Plugin *plugin_find(GlobalConfig *cfg, gint plugin_type, const gchar *plugin_name);
gpointer plugin_construct(Plugin *self, GlobalConfig *cfg, gint plugin_type, const gchar *plugin_name);
gpointer plugin_parse_config(Plugin *plugin, GlobalConfig *cfg, YYLTYPE *yylloc, gpointer arg);
/* plugin side API */
void plugin_register(GlobalConfig *cfg, Plugin *p, gint number);
gboolean plugin_load_module(const gchar *module_name, GlobalConfig *cfg, CfgArgs *args);
void plugin_list_modules(FILE *out, gboolean verbose);
void plugin_load_candidate_modules(GlobalConfig *cfg);
void plugin_free_candidate_modules(GlobalConfig *cfg);
void plugin_free_plugins(GlobalConfig *cfg);
#endif
|