summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorMarcel Holtmann <marcel@holtmann.org>2009-04-21 04:56:24 +0100
committerMarcel Holtmann <marcel@holtmann.org>2009-04-21 04:56:24 +0100
commit87c4130bdb16e8ce0b033708e219d22b19e29a04 (patch)
tree4d32812cb38aea6dc4f38198b5e7fd490c9c199c /doc
parent4b16c48074a5468804625de0092b20343fa97a27 (diff)
downloadconnman-87c4130bdb16e8ce0b033708e219d22b19e29a04.tar.gz
connman-87c4130bdb16e8ce0b033708e219d22b19e29a04.tar.bz2
connman-87c4130bdb16e8ce0b033708e219d22b19e29a04.zip
Describe the special carrier service state
Diffstat (limited to 'doc')
-rw-r--r--doc/overview-api.txt12
1 files changed, 12 insertions, 0 deletions
diff --git a/doc/overview-api.txt b/doc/overview-api.txt
index afb996de..92aed886 100644
--- a/doc/overview-api.txt
+++ b/doc/overview-api.txt
@@ -262,6 +262,10 @@ The basic state of every service is "idle". This means that this service
is not in use at all at the moment. It also is not attempting to connect
or do anything else.
+With Ethernet services a special "carrier" state is available. It indicates
+that the cable has been plugged in. This state is only used when the device
+is from type Ethernet.
+
The "association" state indicates that this service tries to establish a
low-level connection to the network. For example associating/connecting
with a WiFi access point.
@@ -285,6 +289,14 @@ the "idle" state since the service is not connected.
+---------------+
| idle |<-------------------------------+
+---------------+ |
+ | | |
+ | +----------------------+ |
+ | | |
+ | V |
+ | +-------------+ |
+ +----------------------| carrier |<----+
+ | +-------------+ |
+ | |
| +-------------+ |
+----------------------| failure | |
| service.Connect() +-------------+ |