Change service name from org.moblin.connman to net.connman
[platform/upstream/connman.git] / doc / service-api.txt
index b5617a6..d309736 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()
@@ -104,6 +104,12 @@ Methods            dict GetProperties()
 
                        Possible Errors: [service].Error.InvalidArguments
 
+               void ResetCounters()
+
+                       Reset the counter statistics.
+
+                       Possible Errors: None
+
 Signals                PropertyChanged(string name, variant value)
 
                        This signal indicates a changed value of the given
@@ -114,7 +120,12 @@ Properties string State [readonly]
                        The service state information.
 
                        Valid states are "idle", "failure", "association",
-                       "configuration" and "ready".
+                       "configuration", "ready" and "online".
+
+                       The "ready" state signals a successfully
+                       connected device. "online" signals that an
+                       Internet connection is available and has been
+                       verified.
 
                string Error [readonly]
 
@@ -176,6 +187,12 @@ Properties string State [readonly]
                        This property might be only present for WiFi
                        services.
 
+               boolean LoginRequired [readonly]
+
+                       This property indicates that an additional login
+                       step, like web based authentication, is needed
+                       before the connection establishment can proceed.
+
                string Passphrase [readwrite]
 
                        If the service type is WiFi, then this property
@@ -267,13 +284,45 @@ Properties        string State [readonly]
                        indicates connections to a foreign provider when
                        traveling abroad.
 
-               array{string} Nameservers [readwrite]
+               array{string} Nameservers [readonly]
+
+                       The list of currently active nameservers for this
+                       service. If the server is not in READY or ONLINE
+                       state than this list will be empty.
+
+                       Global nameservers are automatically added to this
+                       list. The array represents a sorted list of the
+                       current nameservers. The first one has the highest
+                       priority and is used by default.
+
+                       When using DHCP this array represents the nameservers
+                       provided by the network. In case of manual settings,
+                       the ones from Nameservers.Configuration are used.
+
+               array{string} Nameservers.Configuration [readwrite]
 
                        The list of manually configured domain name
                        servers. Some 3G networks don't provide correct
                        name servers and this allows for an override.
 
-               array{string} Domains [readwrite]
+                       This array is sorted by priority and the first
+                       entry in the list represents the nameserver with
+                       the highest priority.
+
+                       When using manual configuration and no global
+                       nameservers are configured, then it is useful
+                       to configure this setting.
+
+                       Changes to the domain name servers can be done
+                       at any time. It will not cause a disconnect of
+                       the service. However there might be small window
+                       where name resolution might fail.
+
+               array{string} Domains [readonly]
+
+                       The list of currently used search domains.
+
+               array{string} Domains.Configuration [readwrite]
 
                        The list of manually configured search domains.
 
@@ -284,6 +333,10 @@ Properties string State [readonly]
                                Possible values are "dhcp", "manual"
                                and "off".
 
+                               The value "fixed" indicates an IP address
+                               that can not be modified. For example
+                               cellular networks return fixed information.
+
                        string Address [readonly]
 
                                The current configured IPv4 address.
@@ -302,27 +355,114 @@ Properties       string State [readonly]
                        the actual system configuration while this allows
                        user configuration.
 
-               dict Proxy [readonly]
+                       Changing these settings will cause a state change
+                       of the service. The service will become unavailable
+                       until the new configuration has been successfully
+                       installed.
+
+               dict IPv6 [readonly]
 
                        string Method [readonly]
 
-                               Possible values are "direct", "auto",
-                               "manual" and "auto-config".
+                               Possible values are "dhcp", "manual"
+                               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.
+
+                       string Address [readonly]
+
+                               The current configured IPv6 address.
+
+                       uint8 PrefixLength [readonly]
+
+                               The prefix length of the IPv6 address.
+
+                       string Gateway [readonly]
+
+                               The current configured IPv6 gateway.
 
-                               If the DHCP server provides an automatic
-                               configuration URL, then this value is set
-                               to "auto-config". The PAC file will be
-                               referenced by the URL value.
+               dict IPv6.Configuration [readwrite]
 
-                               If no automatic configuration is available,
-                               then "direct" is set.
+                       Same values as IPv6 property. The IPv6 represents
+                       the actual system configuration while this allows
+                       user configuration.
+
+                       Changing these settings will cause a state change
+                       of the service. The service will become unavailable
+                       until the new configuration has been successfully
+                       installed.
+
+               dict Proxy [readonly]
+
+                       string Method [readonly]
+
+                               Possible values are "direct", "auto" and
+                               "manual".
 
-                               The values "auto" and "manual" are not yet
-                               supported.
+                               In case of "auto" method, the URL file can be
+                               provided unless you want to let DHCP/WPAD
+                               auto-discover to be tried. In such case if DHCP
+                               and WPAD auto-discover methods fails then
+                               method will be "direct".
+
+                               In case of "direct" no additional information
+                               are provided. For the "manual" method the
+                               Servers have to be set, Excludes is optional.
 
                        string URL [readonly]
 
-                               Automatic proxy configuration URL.
+                               Automatic proxy configuration URL. Used by
+                               "auto" method.
+
+                       array{string} Servers [readonly]
+
+                               Used when "manual" method is set.
+
+                               List of proxy URIs. The URI without a protocol
+                               will be interpreted as the generic proxy URI.
+                               All others will target a specific protocol and
+                               only once.
+
+                               Example for generic proxy server entry would
+                               be like this: "server.example.com:911".
+
+                       array{string} Excludes [readonly]
+
+                               Used when "manual" method is set.
+
+                               List of hosts which can be accessed directly.
+
+               dict Proxy.Configuration [readwrite]
+
+                       Same values as Proxy property. The Proxy represents
+                       the actual system configuration while this allows
+                       user configuration.
+
+                       If "auto" method is set with an empty URL, then
+                       DHCP/WPAD auto-discover will be tried. Otherwise the
+                       specified URL will be used.
+
+               dict Provider [readonly]
+
+                       string Host [readonly]
+
+                              VPN host IP.
+
+                       string Domain [readonly]
+
+                              VPN Domain.
+
+                       string Name [readonly]
+
+                              VPN provider Name.
+
+                       string Type [readonly]
+
+                              VPN provider type.
 
                dict Ethernet [readonly]