Add counter API document
authorMarcel Holtmann <marcel@holtmann.org>
Thu, 7 Jan 2010 11:48:05 +0000 (03:48 -0800)
committerMarcel Holtmann <marcel@holtmann.org>
Thu, 7 Jan 2010 11:48:05 +0000 (03:48 -0800)
Makefile.am
doc/counter-api.txt [new file with mode: 0644]

index fa3c666..ce348ed 100644 (file)
@@ -153,6 +153,7 @@ EXTRA_DIST += doc/overview-api.txt doc/behavior-api.txt \
                                doc/ipconfig-api.txt doc/plugin-api.txt \
                                doc/manager-api.txt doc/agent-api.txt \
                                doc/profile-api.txt doc/service-api.txt \
+                               doc/counter-api.txt \
                                doc/device-lowlevel-api.txt \
                                doc/network-lowlevel-api.txt \
                                doc/advanced-configuration.txt
diff --git a/doc/counter-api.txt b/doc/counter-api.txt
new file mode 100644 (file)
index 0000000..593e932
--- /dev/null
@@ -0,0 +1,14 @@
+Counter hierarchy
+=================
+
+Service                unique name
+Interface      org.moblin.connman.Counter
+Object path    freely definable
+
+Methods                void Release()
+
+                       This method gets called when the service daemon
+                       unregisters the counter. A counter can use it to do
+                       cleanup tasks. There is no need to unregister the
+                       counter, because when this method gets called it has
+                       already been unregistered.