/usr/include/libinfinoted-plugin-manager-0.7/infinoted/infinoted-plugin-manager.h is in libinfinity-0.7-dev 0.7.1-1.
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 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 | /* libinfinity - a GObject-based infinote implementation
* Copyright (C) 2007-2015 Armin Burgmeier <armin@arbur.net>
*
* 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 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.
*/
#ifndef __INFINOTED_PLUGIN_MANAGER_H__
#define __INFINOTED_PLUGIN_MANAGER_H__
/* Note that this class is compiled into an own shared library. Therefore, it
* must not use any other infinoted API! The reason for this is to allow
* loaded plugins to call plugin manager functions. Calling symbols from the
* application itself would not be portable, so this needs to reside in a
* shared library.
*
* The only API allowed to be used is what is declared in
* infinoted-parameter.h and infinoted-log. The reason for this is that this
* code is also included in the shared library. This allows parameter parsing
* and central logging for plugins. */
#include <infinoted/infinoted-parameter.h>
#include <infinoted/infinoted-log.h>
#include <libinfinity/server/infd-directory.h>
#include <glib-object.h>
G_BEGIN_DECLS
#define INFINOTED_TYPE_PLUGIN_MANAGER (infinoted_plugin_manager_get_type())
#define INFINOTED_PLUGIN_MANAGER(obj) (G_TYPE_CHECK_INSTANCE_CAST((obj), INFINOTED_TYPE_PLUGIN_MANAGER, InfinotedPluginManager))
#define INFINOTED_PLUGIN_MANAGER_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST((klass), INFINOTED_TYPE_PLUGIN_MANAGER, InfinotedPluginManagerClass))
#define INFINOTED_IS_PLUGIN_MANAGER(obj) (G_TYPE_CHECK_INSTANCE_TYPE((obj), INFINOTED_TYPE_PLUGIN_MANAGER))
#define INFINOTED_IS_PLUGIN_MANAGER_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE((klass), INFINOTED_TYPE_PLUGIN_MANAGER))
#define INFINOTED_PLUGIN_MANAGER_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS((obj), INFINOTED_TYPE_PLUGIN_MANAGER, InfinotedPluginManagerClass))
typedef struct _InfinotedPluginManager InfinotedPluginManager;
typedef struct _InfinotedPluginManagerClass InfinotedPluginManagerClass;
/**
* InfinotedPlugin:
* @name: The name of the plugin. The filename of the shared object should
* be <literal>libinfinoted-plugin-<emphasis><name></emphasis></literal>.
* @description: A human-readable description of what the plugin does.
* @options: A 0-terminated list of plugin parameters. The parameters are
* provided to the plugin via the infinoted configuration file or the command
* line. The last element of the list must have the @name field set to %NULL.
* @info_size: The size of the plugin instance structure. When the plugin
* is instantiated, this amount of memory will be allocated for the plugin
* instance. This field must be different from 0.
* @connection_info_size: The size of the plugin's connection info structure.
* For each plugin instance, this amount of memory will be allocated for each
* connection of the server. The plugin can use it to store
* connection-specific data. This field can be 0.
* @session_info_size: The size of the plugin's session info structure. For
* each plugin instance, this amount of memory will be allocated for each
* session that is currently active on the server. The plugin can use it to
* store session-specific data. This field can be 0.
* @session_type: If non-%NULL, specifies the session type handled by the
* plugin. Only for sessions of this type or a derived type a session info
* structure is allocated. The @on_session_added and @on_session_removed
* callbacks are always made, independent of this field.
* @on_info_initialize: Function called after the plugin has been
* instantiated. It should initialize all fields of the plugin instance
* to a sane default value.
* @on_initialize: Function called to initialize the plugin. The function can
* return %FALSE and set the @error parameter to prevent the plugin from
* being used. The server will not be started in this case. Even if this
* function returns %FALSE, @on_deinitialize will be called on the plugin to
* clean up partly constructed plugin data by this function.
* @on_deinitialize: Function called when the plugin is unloaded. Should clean
* up all resources the plugin has allocated.
* @on_connection_added: Function called when there is a new connection to the
* server. It is also called for all existing connections at the time the
* plugin is loaded.
* @on_connection_removed: Function called when a client connection has been
* dropped. It is also called for all existing connections right before the
* plugin is unloaded.
* @on_session_added: Function called when a new session has become active on
* the server. It is also called for all existing sessions at the time the
* plugin is loaded.
* @on_session_removed: Function called when a session has become inactive and
* the server is freeing resources allocated to it. It is also called for all
* existing sessions right before the plugin is unloaded.
*
* Declares a InfinotedPlugin. If an instance of this structure is called
* <literal>INFINOTED_PLUGIN</literal> and exported from a shared object, it
* can be loaded as a plugin by infinoted.
*/
typedef struct _InfinotedPlugin InfinotedPlugin;
struct _InfinotedPlugin {
const gchar* name;
const gchar* description;
const InfinotedParameterInfo* options;
gsize info_size;
gsize connection_info_size;
gsize session_info_size;
const gchar* session_type;
void(*on_info_initialize)(gpointer plugin_info);
gboolean(*on_initialize)(InfinotedPluginManager* manager,
gpointer plugin_info,
GError** error);
void(*on_deinitialize)(gpointer plugin_info);
void(*on_connection_added)(InfXmlConnection* connection,
gpointer plugin_info,
gpointer connection_info);
void(*on_connection_removed)(InfXmlConnection* connection,
gpointer plugin_info,
gpointer connection_info);
void(*on_session_added)(const InfBrowserIter* iter,
InfSessionProxy* proxy,
gpointer plugin_info,
gpointer session_info);
void(*on_session_removed)(const InfBrowserIter* iter,
InfSessionProxy* proxy,
gpointer plugin_info,
gpointer session_info);
};
/**
* InfinotedPluginManagerClass:
*
* This structure does not contain any public fields.
*/
struct _InfinotedPluginManagerClass {
/*< private >*/
GObjectClass parent_class;
};
/**
* InfinotedPluginManager:
*
* #InfinotedPluginManager is an opaque data type. You should only access it
* via the public API functions.
*/
struct _InfinotedPluginManager {
/*< private >*/
GObject parent;
};
/**
* InfinotedPluginManagerError:
* @INFINOTED_PLUGIN_MANAGER_ERROR_OPEN_FAILED: Failed to open the code module
* of a plugin.
* @INFINOTED_PLUGIN_MANAGER_ERROR_NO_ENTRY_POINT: The code module of a plugin
* does not provide the <literal>INFINOTED_PLUGIN</literal> symbol.
*
* Error codes for the <literal>INFINOTED_PLUGIN_MANAGER_ERROR</literal>
* error domain. These errors can occur when loading a plugin with
* infinoted_plugin_manager_load().
*/
typedef enum _InfinotedPluginManagerError {
INFINOTED_PLUGIN_MANAGER_ERROR_OPEN_FAILED,
INFINOTED_PLUGIN_MANAGER_ERROR_NO_ENTRY_POINT
} InfinotedPluginManagerError;
GType
infinoted_plugin_manager_get_type(void) G_GNUC_CONST;
InfinotedPluginManager*
infinoted_plugin_manager_new(InfdDirectory* directory,
InfinotedLog* log,
InfCertificateCredentials* creds);
gboolean
infinoted_plugin_manager_load(InfinotedPluginManager* manager,
const gchar* plugin_path,
const gchar* const* plugins,
GKeyFile* options,
GError** error);
InfdDirectory*
infinoted_plugin_manager_get_directory(InfinotedPluginManager* manager);
InfIo*
infinoted_plugin_manager_get_io(InfinotedPluginManager* manager);
InfinotedLog*
infinoted_plugin_manager_get_log(InfinotedPluginManager* manager);
InfCertificateCredentials*
infinoted_plugin_manager_get_credentials(InfinotedPluginManager* manager);
GQuark
infinoted_plugin_manager_error_quark(void);
gpointer
infinoted_plugin_manager_get_connection_info(InfinotedPluginManager* mgr,
gpointer plugin_info,
InfXmlConnection* connection);
gpointer
infinoted_plugin_manager_get_session_info(InfinotedPluginManager* mgr,
gpointer plugin_info,
InfSessionProxy* proxy);
G_END_DECLS
#endif /* __INFINOTED_PLUGIN_MANAGER_H__ */
/* vim:set et sw=2 ts=2: */
|