diff options
| author | Marcel Holtmann <marcel@holtmann.org> | 2008-12-04 11:13:35 +0100 |
|---|---|---|
| committer | Marcel Holtmann <marcel@holtmann.org> | 2008-12-04 11:13:35 +0100 |
| commit | 8bda03b4654dd6dd4875c70dcdb7e1befe77421a (patch) | |
| tree | 23e723fdd5679c3f4c5f59d45626c156f194b4ce | |
| parent | 76a376b0671b6e791ee3b5aa859e3f2dabd7bcd1 (diff) | |
| download | connman-8bda03b4654dd6dd4875c70dcdb7e1befe77421a.tar.gz connman-8bda03b4654dd6dd4875c70dcdb7e1befe77421a.tar.bz2 connman-8bda03b4654dd6dd4875c70dcdb7e1befe77421a.zip | |
Add API skeleton for service interface
| -rw-r--r-- | doc/Makefile.am | 4 | ||||
| -rw-r--r-- | doc/connman-docs.xml | 14 | ||||
| -rw-r--r-- | doc/service-api.txt | 23 |
3 files changed, 39 insertions, 2 deletions
diff --git a/doc/Makefile.am b/doc/Makefile.am index 7fe30702..4a52ec27 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 d709168f..542c4e18 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 00000000..0e5b13e6 --- /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. |