diff options
| author | Jussi Kukkonen <jku@linux.intel.com> | 2010-10-12 16:58:20 +0300 |
|---|---|---|
| committer | Samuel Ortiz <sameo@linux.intel.com> | 2010-10-12 16:10:19 +0200 |
| commit | e4f22fd31d47a4b97a5cf07f9b1efb168d4cd95f (patch) | |
| tree | fbd157b1b86cddfd7a1b933ae8f47553feeb362c /doc | |
| parent | e7dd8cd2f0ac59064f87f9f22163dd2fe44a0337 (diff) | |
| download | connman-e4f22fd31d47a4b97a5cf07f9b1efb168d4cd95f.tar.gz connman-e4f22fd31d47a4b97a5cf07f9b1efb168d4cd95f.tar.bz2 connman-e4f22fd31d47a4b97a5cf07f9b1efb168d4cd95f.zip | |
docs: Update Service State and LoginRequired docs
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/overview-api.txt | 30 | ||||
| -rw-r--r-- | doc/service-api.txt | 13 |
2 files changed, 21 insertions, 22 deletions
diff --git a/doc/overview-api.txt b/doc/overview-api.txt index 8ab687f8..b83e89a1 100644 --- a/doc/overview-api.txt +++ b/doc/overview-api.txt @@ -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 ================== diff --git a/doc/service-api.txt b/doc/service-api.txt index 46245222..d774507c 100644 --- a/doc/service-api.txt +++ b/doc/service-api.txt @@ -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] |