network: Change the service disconnect state when necessary
[framework/connectivity/connman.git] / doc / service-api.txt
index d774507..2123e91 100644 (file)
@@ -1,8 +1,8 @@
 Service hierarchy
 =================
 
-Service                org.moblin.connman
-Interface      org.moblin.connman.Service
+Service                net.connman
+Interface      net.connman.Service
 Object path    [variable prefix]/{service0,service1,...}
 
 Methods                dict GetProperties()
@@ -132,7 +132,7 @@ Properties  string State [readonly]
                        The service error status details.
 
                        When error occur during connection or disconnection
-                       the detailed information are represented in this
+                       the detailed information is represented in this
                        property to help the user interface to present the
                        user with alternate options.
 
@@ -160,29 +160,15 @@ Properties        string State [readonly]
                        advanced properties or showing the correct icon
                        to the user.
 
-               string Mode [readonly]
-
-                       If the service type is WiFi or Cellular, then this
-                       property is present and contains the mode of the
-                       network.
-
-                       For WiFi services the possible values are "managed"
-                       and "adhoc". For Cellular services it describes the
-                       network technology. Possible values are "gprs", "edge"
-                       and "umts".
-
-                       This property might be only present for WiFi and
-                       Cellular services.
-
-               string Security [readonly]
+               array{string} Security [readonly]
 
                        If the service type is WiFi, then this property is
-                       present and contains the security method or key
-                       management setting.
+                       present and contains the list of security methods
+                       or key management settings.
 
-                       Possible values are "none", "wep", "psk" and
-                       also "ieee8021x". Alternate values for "psk"
-                       can also be "wpa" and "rsn".
+                       Possible values are "none", "wep", "psk", "ieee8021x"
+                       and also "wps". Alternate values for "psk" can also
+                       be "wpa" and "rsn".
 
                        This property might be only present for WiFi
                        services.
@@ -198,7 +184,7 @@ Properties  string State [readonly]
                        If the service type is WiFi, then this property
                        can be used to store a passphrase.
 
-                       No PropertyChanged signals will be send for this
+                       No PropertyChanged signals will be sent for this
                        property. The PassphraseRequired property should
                        be monitored instead.
 
@@ -243,7 +229,9 @@ Properties  string State [readonly]
                boolean AutoConnect [readwrite]
 
                        If set to true, this service will auto-connect
-                       when not other connection is available.
+                       when no other connection is available.
+
+                       The service won't auto-connect while roaming.
 
                        For favorite services it is possible to change
                        this value to prevent or permit automatic
@@ -257,25 +245,6 @@ Properties string State [readonly]
                        In most cases it is required to fill in the APN
                        details.
 
-               string APN [readwrite]
-
-                       If the service is Cellular, then this property
-                       contains the APN details.
-
-                       The APN is network provider specific and even
-                       sometimes data plan specific. Possible examples
-                       are "isp.cingular" or "internet.t-mobile".
-
-               string MCC [readonly]
-
-                       If the service is Cellular, then this property
-                       contains the Mobile Country Code.
-
-               string MNC [readonly]
-
-                       If the service is Cellular, then this property
-                       contains the Mobile Network Code.
-
                boolean Roaming [readonly]
 
                        This property indicates if this service is roaming.
@@ -364,14 +333,16 @@ Properties        string State [readonly]
 
                        string Method [readonly]
 
-                               Possible values are "dhcp", "manual"
+                               Possible values are "auto", "manual", "6to4"
                                and "off".
 
                                The value "fixed" indicates an IP address
                                that can not be modified. For example
                                cellular networks return fixed information.
-
-                               "dhcp" is not supported currently.
+                               The value "6to4" is returned if 6to4 tunnel
+                               is created by connman. The tunnel can only be
+                               created if method was set to "auto" by the
+                               user. User cannot set the method to "6to4".
 
                        string Address [readonly]
 
@@ -385,6 +356,26 @@ Properties string State [readonly]
 
                                The current configured IPv6 gateway.
 
+                       string Privacy [readonly]
+
+                               Enable or disable IPv6 privacy extension
+                               that is described in RFC 4941. The value
+                               has only meaning if Method is set to "auto".
+
+                               Value "disabled" means that privacy extension
+                               is disabled and normal autoconf addresses are
+                               used.
+
+                               Value "enabled" means that privacy extension is
+                               enabled and system prefers to use public
+                               addresses over temporary addresses.
+
+                               Value "prefered" means that privacy extension is
+                               enabled and system prefers temporary addresses
+                               over public addresses.
+
+                               Default value is "disabled".
+
                dict IPv6.Configuration [readwrite]
 
                        Same values as IPv6 property. The IPv6 represents