From: Marcel Holtmann <marcel@holtmann.org>
Date: Thu, 4 Dec 2008 10:13:35 +0000 (+0100)
Subject: Add API skeleton for service interface
X-Git-Tag: accepted/2.0alpha-wayland/20121110.002834~4544
X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=8bda03b4654dd6dd4875c70dcdb7e1befe77421a;p=profile%2Fivi%2Fconnman.git

Add API skeleton for service interface
---

diff --git a/doc/Makefile.am b/doc/Makefile.am
index 7fe3070..4a52ec2 100644
--- a/doc/Makefile.am
+++ b/doc/Makefile.am
@@ -37,5 +37,5 @@ else
 EXTRA_DIST = $(DOC_MAIN_SGML_FILE) connman-introduction.xml
 endif
 
-EXTRA_DIST += manager-api.txt device-api.txt network-api.txt \
-			connection-api.txt agent-api.txt plugin-api.txt
+EXTRA_DIST += manager-api.txt device-api.txt network-api.txt service-api.txt \
+				connection-api.txt agent-api.txt plugin-api.txt
diff --git a/doc/connman-docs.xml b/doc/connman-docs.xml
index d709168..542c4e1 100644
--- a/doc/connman-docs.xml
+++ b/doc/connman-docs.xml
@@ -78,6 +78,20 @@
     </para>
   </reference>
 
+  <reference id="service">
+    <title>Service interface</title>
+    <para>
+<programlisting><xi:include href="service-api.txt" parse="text" /></programlisting>
+    </para>
+  </reference>
+
+  <reference id="connection">
+    <title>Connection interface</title>
+    <para>
+<programlisting><xi:include href="connection-api.txt" parse="text" /></programlisting>
+    </para>
+  </reference>
+
   <reference id="reference">
     <title>Plugin API Reference</title>
     <partintro>
diff --git a/doc/service-api.txt b/doc/service-api.txt
new file mode 100644
index 0000000..0e5b13e
--- /dev/null
+++ b/doc/service-api.txt
@@ -0,0 +1,23 @@
+Service hierarchy
+=================
+
+Service		org.moblin.connman
+Interface	org.moblin.connman.Service
+Object path	[variable prefix]/{service0,service1,...}
+
+Methods		dict GetProperties()
+
+			Returns properties for the service object. See
+			the properties section for available properties.
+
+			Possible Errors: [service].Error.InvalidArguments
+					 [service].Error.DoesNotExist
+
+Signals		PropertyChanged(string name, variant value)
+
+			This signal indicates a changed value of the given
+			property.
+
+Properties	string Identifier [readonly]
+
+			Unique identifier for this service.