src/libstrongswan/plugins/plugin_loader.h

   1 /*
   2  * Copyright (C) 2007 Martin Willi
   3  * 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_loader plugin_loader
  18  * @{ @ingroup plugin
  19  */
  20
  21 #ifndef PLUGIN_LOADER_H_
  22 #define PLUGIN_LOADER_H_
  23
  24 typedef struct plugin_loader_t plugin_loader_t;
  25
  26 /**
  27  * The plugin_loader loads plugins from a directory and initializes them
  28  */
  29 struct plugin_loader_t {
  30
  31         /**
  32          * Load plugins from a directory.
  33          *
  34          * @param path                  path containing loadable plugins
  35          * @param prefix                prefix of plugin libraries to load
  36          * @return                              number of successfully loaded plugins
  37          */
  38         int (*load)(plugin_loader_t *this, char *path, char *prefix);
  39
  40         /**
  41      * Unload loaded plugins, destroy plugin_loader instance.
  42      */
  43     void (*destroy)(plugin_loader_t *this);
  44 };
  45
  46 /**
  47  * Create a plugin_loader instance.
  48  *
  49  * @return                      plugin loader instance
  50  */
  51 plugin_loader_t *plugin_loader_create();
  52
  53 #endif /* PLUGIN_LOADER_H_ @}*/