summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/Makefile.am2
-rw-r--r--doc/agent-api.txt18
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.
+