diff options
| author | Marcel Holtmann <marcel@holtmann.org> | 2008-01-30 19:18:50 +0100 |
|---|---|---|
| committer | Marcel Holtmann <marcel@holtmann.org> | 2008-01-30 19:18:50 +0100 |
| commit | 2eed628fda87ad562d765c87a2d8330ee707ca3a (patch) | |
| tree | c0f6e6ef919122c6a71be7257507ebfe623e93d1 | |
| parent | 439bdfd6882e3632a4fe67f0d19801524a1c7d8d (diff) | |
| download | connman-2eed628fda87ad562d765c87a2d8330ee707ca3a.tar.gz connman-2eed628fda87ad562d765c87a2d8330ee707ca3a.tar.bz2 connman-2eed628fda87ad562d765c87a2d8330ee707ca3a.zip | |
Add initial interface documentation
| -rw-r--r-- | doc/Makefile.am | 2 | ||||
| -rw-r--r-- | doc/interface-api.txt | 24 |
2 files changed, 25 insertions, 1 deletions
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) + |