Add documentation for GetState method and StateChanged signal
authorMarcel Holtmann <marcel@holtmann.org>
Mon, 7 Apr 2008 02:07:46 +0000 (04:07 +0200)
committerMarcel Holtmann <marcel@holtmann.org>
Mon, 7 Apr 2008 02:07:46 +0000 (04:07 +0200)
doc/manager-api.txt

index 9de15c3..0c4de41 100644 (file)
@@ -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.