curly wars / auto-indentation
[oweals/gnunet.git] / src / include / gnunet_plugin_lib.h
index 9608abd4ce3451c70c35a5465413af7981a30584..387ca381c2dd34fd514f26c2d3bf12349e4a7639 100644 (file)
@@ -54,12 +54,14 @@ 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
  */
-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"
@@ -73,7 +75,40 @@ int GNUNET_PLUGIN_test (const char *library_name);
  * @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 'cb'
+ */
+void
+GNUNET_PLUGIN_load_all (const char *basename, void *arg,
+                        GNUNET_PLUGIN_LoaderCallback cb, void *cb_cls);
 
 
 /**
@@ -85,7 +120,8 @@ void *GNUNET_PLUGIN_load (const char *library_name, void *arg);
  * @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 */