From b627f1b548160dd36aa2edcb98aae210f483babe Mon Sep 17 00:00:00 2001 From: Marcel Holtmann Date: Wed, 30 Jan 2008 19:26:48 +0100 Subject: [PATCH] Add agent documentation --- doc/Makefile.am | 2 +- doc/agent-api.txt | 18 ++++++++++++++++++ 2 files changed, 19 insertions(+), 1 deletion(-) create mode 100644 doc/agent-api.txt diff --git a/doc/Makefile.am b/doc/Makefile.am index 33cc0bd..04bffe2 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 0000000..6a805e8 --- /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. + -- 1.7.9.5