dnsproxy: Only one copy of the relevant buffers will be made to a TCP request

[framework/connectivity/connman.git] / doc / manager-api.txt

diff --git a/doc/manager-api.txt b/doc/manager-api.txt
index 839f1b1..3bd201d 100644 (file)
--- a/doc/manager-api.txt
+++ b/doc/manager-api.txt
@@ -155,24 +155,28 @@ Signals           TechnologyAdded(object path, dict properties)
                        The object path is no longer accessible after this
                        signal and only emitted for reference.
 
-               ServicesAdded(array{object, dict})
+               ServicesChanged(array{object, dict}, array{object})
 
-                       List of service that have been added. The array
-                       is a list of services that is sorted with existing
-                       services containing an empty dictionary and new
-                       services containing the properties.
+                       Signals a list of services that have been changed
+                       via the first array. And a list of service that
+                       have been removed via the second array.
 
-                       This signal will only inform about added services
-                       and in case that services get added and removed at
-                       the same time, a ServicesRemoved signal will be
-                       sent first.
+                       The list of added services is sorted. The dictionary
+                       with the properties might be empty in case none of
+                       the properties have changed. Or only contains the
+                       properties that have changed.
 
-               ServicesRemoved(array{object})
+                       For newly added services the whole set of properties
+                       will be present.
 
-                       Signals a list of services that are no longer valid.
+                       The list of removed services can be empty.
 
-                       The object paths are no longer accessible after
-                       this signal and only emitted for reference.
+                       This signal will only be triggered when the sort
+                       order of the service list or the number of services
+                       changes. It will not be emitted if only a property
+                       of the service object changes. For that it is
+                       required to watch the PropertyChanged signal of
+                       the service object.
 
                PropertyChanged(string name, variant value)
 
@@ -182,12 +186,30 @@ Signals           TechnologyAdded(object path, dict properties)
 Properties     string State [readonly]
 
                        The global connection state of a system. Possible
-                       values are "online" if at least one connection exists
-                       and "offline" if no device is connected.
-
-                       In certain situations the state might change to
-                       the value "connected". This can only be seen if
-                       previously no connection was present.
+                       values are "offline", "idle", "ready" and "online".
+
+                       If the device is in offline mode, the value "offline"
+                       indicates this special global state. It can also be
+                       retrieved via the OfflineMode property, but is kept
+                       here for consistency and to differentiate from "idle".
+
+                       However when OfflineMode property is true, the State
+                       property can still be "idle", "ready" or "online"
+                       since it is possible by the end user to re-enable
+                       individual technologies like WiFi and Bluetooth while
+                       in offline mode.
+
+                       The states "idle", "ready" and "online" match to
+                       states from the services. If no service is in
+                       either "ready" or "online" state it will indicate
+                       the "idle" state.
+
+                       If at least one service is in "ready" state and no
+                       service is in "online" state, then it will indicate
+                       the "ready" state.
+
+                       When at least one service is in "online" state,
+                       this property will indicate "online" as well.
 
                boolean OfflineMode [readwrite]