From 2eed628fda87ad562d765c87a2d8330ee707ca3a Mon Sep 17 00:00:00 2001 From: Marcel Holtmann Date: Wed, 30 Jan 2008 19:18:50 +0100 Subject: Add initial interface documentation --- doc/Makefile.am | 2 +- doc/interface-api.txt | 24 ++++++++++++++++++++++++ 2 files changed, 25 insertions(+), 1 deletion(-) create mode 100644 doc/interface-api.txt (limited to 'doc') diff --git a/doc/Makefile.am b/doc/Makefile.am index fadc659d..33cc0bdd 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -1,4 +1,4 @@ -EXTRA_DIST = manager-api.txt +EXTRA_DIST = manager-api.txt interface-api.txt MAINTAINERCLEANFILES = Makefile.in diff --git a/doc/interface-api.txt b/doc/interface-api.txt new file mode 100644 index 00000000..1b0d468a --- /dev/null +++ b/doc/interface-api.txt @@ -0,0 +1,24 @@ +Interface hierarchy +******************* + +Service name org.freedesktop.connman +Interface name org.freedesktop.connman.Interface +Object path [interface object] + +Methods dict GetProperties() + string GetState() + uint16 GetSignal() + string GetPolicy() + void SetPolicy(string policy) + dict GetNetwork() + void SetNetwork(dict network) + dict GetIPv4() + void SetIPv4(dict ipv4) + +Signals StateChanged(string state) + SignalChanged(uint16 signal) + PolicyChanged(string policy) + NetworkFound(dict network) + NetworkChanged(dict network) + IPv4Changed(dict ipv4) + -- cgit v1.2.3