doc: Fix race conditions in service handling
[framework/connectivity/connman.git] / doc / manager-api.txt
index d4b9c2a..839f1b1 100644 (file)
@@ -22,23 +22,10 @@ Methods             dict GetProperties()
                        Possible Errors: [service].Error.InvalidArguments
                                         [service].Error.InvalidProperty
 
-               void RequestScan(string type)
+               array{object,dict} GetTechnologies()
 
-                       Request to trigger a scan for the specified
-                       technology. The empty string "" triggers scanning
-                       on all technologies.
-
-                       Possible Errors: [service].Error.InvalidArguments
-
-               void EnableTechnology(string type)
-
-                       Enable specified type of technologies.
-
-                       Possible Errors: [service].Error.InvalidArguments
-
-               void DisableTechnology(string type)
-
-                       Disable specified type of technologies.
+                       Returns a list of tuples with technology object
+                       path and dictionary of technology properties.
 
                        Possible Errors: [service].Error.InvalidArguments
 
@@ -112,7 +99,7 @@ Methods              dict GetProperties()
 
                        Possible Errors: [service].Error.InvalidArguments
 
-               object CreateSession(dict settings, object notifier)
+               object CreateSession(dict settings, object notifier)  [experimental]
 
                        Create a new session for the application. Every
                        application can create multiple session with
@@ -128,7 +115,7 @@ Methods             dict GetProperties()
                        Every application should at least create one session
                        to inform about its requirements and it purpose.
 
-               void DestroySession(object session)
+               void DestroySession(object session)  [experimental]
 
                        Remove the previously created session.
 
@@ -154,7 +141,40 @@ Methods            dict GetProperties()
 
                        Possible Errors: [service].Error.InvalidArguments
 
-Signals                PropertyChanged(string name, variant value)
+Signals                TechnologyAdded(object path, dict properties)
+
+                       Signal that is sent when a new technology is added.
+
+                       It contains the object path of the technology and
+                       also its properties.
+
+               TechnologyRemoved(object path)
+
+                       Signal that is sent when a modem has been removed.
+
+                       The object path is no longer accessible after this
+                       signal and only emitted for reference.
+
+               ServicesAdded(array{object, dict})
+
+                       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.
+
+                       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.
+
+               ServicesRemoved(array{object})
+
+                       Signals a list of services that are no longer valid.
+
+                       The object paths are no longer accessible after
+                       this signal and only emitted for reference.
+
+               PropertyChanged(string name, variant value)
 
                        This signal indicates a changed value of the given
                        property.
@@ -169,26 +189,6 @@ Properties string State [readonly]
                        the value "connected". This can only be seen if
                        previously no connection was present.
 
-               array{string} AvailableTechnologies [readonly]
-
-                       The list of available technologies. The strings
-                       are the same as the ones from the service types.
-
-               array{string} EnabledTechnologies [readonly]
-
-                       The list of enabled technologies. The strings
-                       are the same as the ones from the service types.
-
-               array{string} ConnectedTechnologies [readonly]
-
-                       The list of connected technologies. The strings
-                       are the same as the ones from the service type.
-
-               string DefaultTechnology [readonly]
-
-                       The current connected technology which holds the
-                       default route.
-
                boolean OfflineMode [readwrite]
 
                        The offline mode indicates the global setting for
@@ -202,26 +202,6 @@ Properties string State [readonly]
                        the limited usage of WiFi or Bluetooth devices might
                        be allowed in some situations.
 
-               array{object} Technologies [readonly]
-
-                       List of technology object paths.
-
-               array{object} Services [readonly]
-
-                       List of service object paths. The list is sorted
-                       internally to have the service with the default
-                       route always first and then the favorite services
-                       followed by scan results.
-
-                       This list represents the available services for the
-                       current selected profile. If the profile gets changed
-                       then this list will be updated.
-
-                       The same list is available via the profile object
-                       itself. It is just provided here for convenience of
-                       applications only dealing with the current active
-                       profile.
-
                boolean SessionMode [readwrite]  [experminental]
 
                        This disables the auto connect feature. It should be