Return to plugin.h CVS log

Up to [ELWIX - Embedded LightWeight unIX -] / embedaddon / strongswan / src / libstrongswan / plugins

Annotation of embedaddon/strongswan/src/libstrongswan/plugins/plugin.h, revision 1.1

1.1     ! misho       1: /*
        !             2:  * Copyright (C) 2008 Martin Willi
        !             3:  * HSR Hochschule fuer Technik Rapperswil
        !             4:  *
        !             5:  * This program is free software; you can redistribute it and/or modify it
        !             6:  * under the terms of the GNU General Public License as published by the
        !             7:  * Free Software Foundation; either version 2 of the License, or (at your
        !             8:  * option) any later version.  See <http://www.fsf.org/copyleft/gpl.txt>.
        !             9:  *
        !            10:  * This program is distributed in the hope that it will be useful, but
        !            11:  * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
        !            12:  * or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
        !            13:  * for more details.
        !            14:  */
        !            15: 
        !            16: /**
        !            17:  * @defgroup plugin plugin
        !            18:  * @{ @ingroup plugins
        !            19:  */
        !            20: 
        !            21: #ifndef PLUGIN_H_
        !            22: #define PLUGIN_H_
        !            23: 
        !            24: typedef struct plugin_t plugin_t;
        !            25: 
        !            26: #include <library.h>
        !            27: #include <plugins/plugin_feature.h>
        !            28: 
        !            29: /**
        !            30:  * Interface definition of a plugin.
        !            31:  */
        !            32: struct plugin_t {
        !            33: 
        !            34:        /**
        !            35:         * Get the name of the plugin.
        !            36:         *
        !            37:         * @return              plugin name
        !            38:         */
        !            39:        char* (*get_name)(plugin_t *this);
        !            40: 
        !            41:        /**
        !            42:         * Get plugin features with dependencies.
        !            43:         *
        !            44:         * The returned array contains features provided by the plugin and
        !            45:         * dependencies for that feature. See plugin_feature_t for details.
        !            46:         *
        !            47:         * @param features      pointer receiving plugin features
        !            48:         * @return                      number of features
        !            49:         */
        !            50:        int (*get_features)(plugin_t *this, plugin_feature_t *features[]);
        !            51: 
        !            52:        /**
        !            53:         * Try to reload plugin configuration.
        !            54:         *
        !            55:         * @return              TRUE if reloaded, FALSE if reloading not supported by plugin
        !            56:         */
        !            57:        bool (*reload)(plugin_t *this);
        !            58: 
        !            59:        /**
        !            60:         * Destroy a plugin instance.
        !            61:         */
        !            62:        void (*destroy)(plugin_t *this);
        !            63: };
        !            64: 
        !            65: 
        !            66: /**
        !            67:  * Plugin constructor function definition.
        !            68:  *
        !            69:  * Each plugin has a constructor function. This function is called on daemon
        !            70:  * startup to initialize each plugin.
        !            71:  * The plugin function is named plugin_name_plugin_create().
        !            72:  *
        !            73:  * @return                             plugin_t instance
        !            74:  */
        !            75: typedef plugin_t *(*plugin_constructor_t)(void);
        !            76: 
        !            77: #endif /** PLUGIN_H_ @}*/