diff options
author | Marcel Holtmann <marcel@holtmann.org> | 2008-04-07 04:07:46 +0200 |
---|---|---|
committer | Marcel Holtmann <marcel@holtmann.org> | 2008-04-07 04:07:46 +0200 |
commit | b55e7165b179c3c97a372647ef0a889e4ef81675 (patch) | |
tree | 4464365e7c790bbd6fa389bd96b310955dd7d350 /doc/manager-api.txt | |
parent | 56b36256ff076ccc319b0d591c96fef98e3ce893 (diff) | |
download | connman-b55e7165b179c3c97a372647ef0a889e4ef81675.tar.gz connman-b55e7165b179c3c97a372647ef0a889e4ef81675.tar.bz2 connman-b55e7165b179c3c97a372647ef0a889e4ef81675.zip |
Add documentation for GetState method and StateChanged signal
Diffstat (limited to 'doc/manager-api.txt')
-rw-r--r-- | doc/manager-api.txt | 13 |
1 files changed, 13 insertions, 0 deletions
diff --git a/doc/manager-api.txt b/doc/manager-api.txt index 9de15c30..0c4de41b 100644 --- a/doc/manager-api.txt +++ b/doc/manager-api.txt @@ -6,11 +6,13 @@ Interface name org.freedesktop.connman.Manager Object path / Methods array{object} ListInterfaces() + string GetState() void RegisterAgent(object path) void UnregisterAgent(object path) Signals InterfaceAdded(object) InterfaceRemoved(object) + StateChanged(string state) Method: ListInferfaces @@ -20,6 +22,12 @@ object paths. Every attached network interface (eth0, wlan0 etc.) of the system is presented by an object path with additional interfaces on it. The main interface is org.freedesktop.connman.Interface. +Method: GetState +================ +This method gets the overall master state of the Internet connection. Possible +return values are "offline" and "online". If at least one interface is +connected it will return "online". + Method: RegisterAgent ===================== This method allows the user interace to register an agent. There can be only @@ -44,3 +52,8 @@ Signal: InterfaceRemoved This signal is emitted every time an interface has been removed. This can happen at any time in case of hotplug devices. When the system shuts down, this signal is also emitted. + +Signal: StateChanged +==================== +This signal is emitted every time the master state changes. Possible values +are "offline" and "online" and reflect the state of the Internet connection. |