root/trunk/src/libstrongswan/plugins/plugin.h

/*
 * Copyright (C) 2008 Martin Willi
 * Hochschule fuer Technik Rapperswil
 *
 * This program is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License as published by the
 * Free Software Foundation; either version 2 of the License, or (at your
 * option) any later version.  See <http://www.fsf.org/copyleft/gpl.txt>.
 *
 * This program 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 General Public License
 * for more details.
 */

/**
 * @defgroup plugin plugin
 * @{ @ingroup plugins
 */

#ifndef PLUGIN_H_
#define PLUGIN_H_

typedef struct plugin_t plugin_t;

/**
 * Interface definition of a plugin.
 */
struct plugin_t {
    
    /**
     * Destroy a plugin instance.
     */
    void (*destroy)(plugin_t *this);
};


/**
 * Plugin constructor function definiton.
 *
 * Each plugin has a constructor functions. This function is called on daemon
 * startup to initialize each plugin.
 * The plugin function is named plugin_create().
 *
 * @return              plugin_t instance
 */
typedef plugin_t *(*plugin_constructor_t)(void);

#endif /* PLUGIN_H_ @}*/