From 87c4130bdb16e8ce0b033708e219d22b19e29a04 Mon Sep 17 00:00:00 2001 From: Marcel Holtmann Date: Tue, 21 Apr 2009 04:56:24 +0100 Subject: [PATCH] Describe the special carrier service state --- doc/overview-api.txt | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/doc/overview-api.txt b/doc/overview-api.txt index afb996d..92aed88 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() +-------------+ | -- 2.7.4