summaryrefslogtreecommitdiff
path: root/doc/plugin-api.txt
diff options
context:
space:
mode:
authorMarcel Holtmann <marcel@holtmann.org>2008-03-01 08:33:54 +0100
committerMarcel Holtmann <marcel@holtmann.org>2008-03-01 08:33:54 +0100
commit957896b6bbeae6dc4efef26da8bfe48fece916ca (patch)
treea4a93f18e9f286170724c54d71eec6a5fe0b6049 /doc/plugin-api.txt
parentd7d0cc2a73eef733e792873caa35862e902d3ce4 (diff)
downloadconnman-957896b6bbeae6dc4efef26da8bfe48fece916ca.tar.gz
connman-957896b6bbeae6dc4efef26da8bfe48fece916ca.tar.bz2
connman-957896b6bbeae6dc4efef26da8bfe48fece916ca.zip
Add first draft of plugin API description
Diffstat (limited to 'doc/plugin-api.txt')
-rw-r--r--doc/plugin-api.txt22
1 files changed, 22 insertions, 0 deletions
diff --git a/doc/plugin-api.txt b/doc/plugin-api.txt
new file mode 100644
index 00000000..f8dded07
--- /dev/null
+++ b/doc/plugin-api.txt
@@ -0,0 +1,22 @@
+Plugin programming interface
+****************************
+
+Plugin basics
+=============
+The Connection Manager supports plugins for various actions. The basic plugin
+contains of plugin description via CONNMAN_PLUGIN_DEFINE and also init/exit
+callbacks definied through that description.
+
+#include <connman/plugin.h>
+
+static int example_init(void)
+{
+ return 0;
+}
+
+static void example_exit(void)
+{
+}
+
+CONNMAN_PLUGIN_DEFINE("example", "Example plugin", VERSION,
+ example_init, example_exit)