summaryrefslogtreecommitdiff
path: root/doc/service-api.txt
diff options
context:
space:
mode:
authorMarcel Holtmann <marcel@holtmann.org>2010-05-06 07:49:25 +0200
committerMarcel Holtmann <marcel@holtmann.org>2010-05-06 07:49:25 +0200
commit1cdd39b909b74dec55bcdcc0e50e8c5e4e571437 (patch)
tree4c19b346ad3bbb0d063fa6b658e3c3af86c8f6df /doc/service-api.txt
parent088fa7946662b56d6e463a84340608311b4bb7e5 (diff)
downloadconnman-1cdd39b909b74dec55bcdcc0e50e8c5e4e571437.tar.gz
connman-1cdd39b909b74dec55bcdcc0e50e8c5e4e571437.tar.bz2
connman-1cdd39b909b74dec55bcdcc0e50e8c5e4e571437.zip
Update the Nameservers and Domains property description
Diffstat (limited to 'doc/service-api.txt')
-rw-r--r--doc/service-api.txt31
1 files changed, 29 insertions, 2 deletions
diff --git a/doc/service-api.txt b/doc/service-api.txt
index e488d7af..149e9d73 100644
--- a/doc/service-api.txt
+++ b/doc/service-api.txt
@@ -271,13 +271,40 @@ 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, LOGIN 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.
+
+ array{string} Domains [readonly]
+
+ The list of currently used search domains.
+
+ array{string} Domains.Configuration [readwrite]
The list of manually configured search domains.