From b627f1b548160dd36aa2edcb98aae210f483babe Mon Sep 17 00:00:00 2001
From: Marcel Holtmann <marcel@holtmann.org>
Date: Wed, 30 Jan 2008 19:26:48 +0100
Subject: Add agent documentation

---
 doc/agent-api.txt | 18 ++++++++++++++++++
 1 file changed, 18 insertions(+)
 create mode 100644 doc/agent-api.txt

(limited to 'doc/agent-api.txt')

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.
+
-- 
cgit v1.2.3