Update Agent interface description
authorMarcel Holtmann <marcel@holtmann.org>
Sat, 6 Dec 2008 02:43:48 +0000 (03:43 +0100)
committerMarcel Holtmann <marcel@holtmann.org>
Sat, 6 Dec 2008 02:43:48 +0000 (03:43 +0100)
doc/agent-api.txt

index ff7aa53..f39c966 100644 (file)
@@ -1,17 +1,14 @@
 Agent hierarchy
-***************
+===============
 
-Service name   [unique name]
-Interface name org.moblin.connman.Agent
-Object path    [random object]
+Service                unique name
+Interface      org.moblin.connman.Agent
+Object path    freely definable
 
 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.moblin.connman service.
+                       This method gets called when the service daemon
+                       unregisters the agent. An agent can use it to do
+                       cleanup tasks. There is no need to unregister the
+                       agent, because when this method gets called it has
+                       already been unregistered.