diff options
author | Marcel Holtmann <marcel@holtmann.org> | 2008-01-30 19:26:48 +0100 |
---|---|---|
committer | Marcel Holtmann <marcel@holtmann.org> | 2008-01-30 19:26:48 +0100 |
commit | b627f1b548160dd36aa2edcb98aae210f483babe (patch) | |
tree | c263a02576c9612a806dae04c6cf23b5404be172 | |
parent | 2eed628fda87ad562d765c87a2d8330ee707ca3a (diff) | |
download | connman-b627f1b548160dd36aa2edcb98aae210f483babe.tar.gz connman-b627f1b548160dd36aa2edcb98aae210f483babe.tar.bz2 connman-b627f1b548160dd36aa2edcb98aae210f483babe.zip |
Add agent documentation
-rw-r--r-- | doc/Makefile.am | 2 | ||||
-rw-r--r-- | doc/agent-api.txt | 18 |
2 files changed, 19 insertions, 1 deletions
diff --git a/doc/Makefile.am b/doc/Makefile.am index 33cc0bdd..04bffe2b 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -1,4 +1,4 @@ -EXTRA_DIST = manager-api.txt interface-api.txt +EXTRA_DIST = manager-api.txt interface-api.txt agent-api.txt MAINTAINERCLEANFILES = Makefile.in diff --git a/doc/agent-api.txt b/doc/agent-api.txt new file mode 100644 index 00000000..6a805e8d --- /dev/null +++ b/doc/agent-api.txt @@ -0,0 +1,18 @@ +Agent hierarchy +*************** + +Service name [unique name] +Interface name org.freedesktop.connman.Agent +Object path [random object] + +Methods void Release() + + +Method: Release +=============== +This method will be called when the core releases the agent. This normally +happens when the core shuts down. + +To get notified when the core exits, an agent should also watch out for the +NameOwnerChanged from org.freedesktop.connman service. + |