Add API skeleton for service interface

diff --git a/doc/Makefile.am b/doc/Makefile.am
index 7fe30702ffdb2953ed918bc9a896085f8986f1e1..4a52ec270c08628965e94c6c3e462a1611a18fd2 100644 (file)
--- 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 d709168fc5e1eb767d1fcde150b5baf09dbe6db3..542c4e1874af76f9b6fd284c3fbac33bcf244d7d 100644 (file)
--- 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 (file)
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.