/*
This file is part of GNUnet.
- (C) 2001, 2002, 2003, 2004, 2005, 2006 Christian Grothoff (and other contributing authors)
+ Copyright (C) 2001, 2002, 2003, 2004, 2005, 2006 GNUnet e.V.
GNUnet 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, or (at your
+ by the Free Software Foundation; either version 3, or (at your
option) any later version.
GNUnet is distributed in the hope that it will be useful, but
You should have received a copy of the GNU General Public License
along with GNUnet; see the file COPYING. If not, write to the
- Free Software Foundation, Inc., 59 Temple Place - Suite 330,
- Boston, MA 02111-1307, USA.
+ Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
+ Boston, MA 02110-1301, USA.
*/
/**
- * @file include/gnunet_plugin_lib.h
- * @brief plugin loading and unloading
* @author Christian Grothoff
+ *
+ * @file
+ * Plugin loading and unloading
+ *
+ * @defgroup plugin Plugin library
+ * Plugin loading and unloading
+ * @{
*/
#ifndef GNUNET_PLUGIN_LIB_H
* shutdown or if there was an error, otherwise
* the plugin's API on success
*/
-typedef void *(*GNUNET_PLUGIN_Callback) (void *arg);
+typedef void *
+(*GNUNET_PLUGIN_Callback) (void *arg);
/**
* Test if a plugin exists.
*
* Note that the library must export a symbol called
- * "library_name_init" for the test to succeed.
+ * "library_name_init" for the test to succeed.
*
* @param library_name name of the plugin to test if it is installed
- * @return GNUNET_YES if the plugin exists, GNUNET_NO if not
+ * @return #GNUNET_YES if the plugin exists, #GNUNET_NO if not
*/
-int GNUNET_PLUGIN_test (const char *library_name);
+int
+GNUNET_PLUGIN_test (const char *library_name);
+
/**
* Setup plugin (runs the "init" callback and returns whatever "init"
* @param arg argument to the plugin initialization function
* @return whatever the initialization function returned, NULL on error
*/
-void *GNUNET_PLUGIN_load (const char *library_name, void *arg);
+void *
+GNUNET_PLUGIN_load (const char *library_name,
+ void *arg);
+
+
+/**
+ * Signature of a function called by 'GNUNET_PLUGIN_load_all'.
+ *
+ * @param cls closure
+ * @param library_name full name of the library (to be used with
+ * #GNUNET_PLUGIN_unload)
+ * @param lib_ret return value from the initialization function
+ * of the library (same as what #GNUNET_PLUGIN_load would
+ * have returned for the given library name)
+ */
+typedef void
+(*GNUNET_PLUGIN_LoaderCallback) (void *cls,
+ const char *library_name,
+ void *lib_ret);
+
+
+/**
+ * Load all compatible plugins with the given base name.
+ *
+ * Note that the library must export symbols called
+ * "basename_ANYTHING_init" and "basename_ANYTHING__done". These will
+ * be called when the library is loaded and unloaded respectively.
+ *
+ * @param basename basename of the plugins to load
+ * @param arg argument to the plugin initialization function
+ * @param cb function to call for each plugin found
+ * @param cb_cls closure for @a cb
+ */
+void
+GNUNET_PLUGIN_load_all (const char *basename,
+ void *arg,
+ GNUNET_PLUGIN_LoaderCallback cb,
+ void *cb_cls);
/**
* @return whatever the shutdown function returned, typically NULL
* or a "char *" representing the error message
*/
-void *GNUNET_PLUGIN_unload (const char *library_name, void *arg);
+void *
+GNUNET_PLUGIN_unload (const char *library_name,
+ void *arg);
#if 0 /* keep Emacsens' auto-indent happy */
}
#endif
-
/* ifndef GNUNET_PLUGIN_LIB_H */
#endif
+
+/** @} */ /* end of group */
+
/* end of gnunet_plugin_lib.h */