docs: Update Service State and LoginRequired docs
authorJussi Kukkonen <jku@linux.intel.com>
Tue, 12 Oct 2010 13:58:20 +0000 (16:58 +0300)
committerSamuel Ortiz <sameo@linux.intel.com>
Tue, 12 Oct 2010 14:10:19 +0000 (16:10 +0200)
doc/overview-api.txt
doc/service-api.txt

index 8ab687f..b83e89a 100644 (file)
@@ -263,10 +263,6 @@ with a WiFi access point.
 With the "configuration" state the service indicates that it is trying
 to retrieve/configure IP settings.
 
-Some service might require special authentication procedure like a web based
-confirmation. The "login" should be used for this in the future. Currently
-this is not implemented.
-
 The "ready" state signals a successful connected device. This doesn't mean
 it has the default route, but basic IP operations will succeed.
 
@@ -292,18 +288,16 @@ the "idle" state since the service is not connected.
                      V                           |              |
                +---------------+                 |              |
                | configuration |-----------------+              |
-               +---------------+      error      |              |
-                     |                           |              |
-                     | success                   |              |
-                     V                           |              |
-               +---------------+            +-------------+     |
-               | ready         |----------->| login       |     |
-               +---------------+            +-------------+     |
-                     |                           |              |
-                     | success                   |              |
-                     |                           |              |
-                     +---------------------------+              |
-                     |           authentication                 |
+               +---------------+      error                     |
+                     |                                          |
+                     | success                                  |
+                     V                                          |
+               +---------------+                                |
+               | ready         |                                |
+               +---------------+                                |
+                     |                                          |
+                     | success                                  |
+                     |                                          |
                      V                                          |
                +---------------+                                |
                | online        |<----------------+              |
@@ -323,6 +317,10 @@ to give the user feedback on what is currently going on. Especially in
 cases where networks are flaky or DHCP servers take a long time these
 information are helpful for the user.
 
+Some services might require special authentication procedure like a web
+based confirmation. The LoginRequired property should be used to check
+for this.
+
 
 Application basics
 ==================
index 4624522..d774507 100644 (file)
@@ -120,11 +120,12 @@ Properties        string State [readonly]
                        The service state information.
 
                        Valid states are "idle", "failure", "association",
-                       "configuration" and "ready".
+                       "configuration", "ready" and "online".
 
-                       Also "login" and "online" states are used. The
-                       state "online" signals that an Internet connection
-                       is available and has been verified.
+                       The "ready" state signals a successfully
+                       connected device. "online" signals that an
+                       Internet connection is available and has been
+                       verified.
 
                string Error [readonly]
 
@@ -189,8 +190,8 @@ Properties  string State [readonly]
                boolean LoginRequired [readonly]
 
                        This property indicates that an additional login
-                       step is needed before the connection establishment
-                       can proceed.
+                       step, like web based authentication, is needed
+                       before the connection establishment can proceed.
 
                string Passphrase [readwrite]