From f40c4798456d2e16b479e5c85424967124dc51b4 Mon Sep 17 00:00:00 2001 From: Thomas Haller Date: Sat, 13 Feb 2016 14:41:57 +0100 Subject: [PATCH] introspection: document the meaning of active connections --- introspection/nm-active-connection.xml | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/introspection/nm-active-connection.xml b/introspection/nm-active-connection.xml index 4d5d15a1e5..203437b7cc 100644 --- a/introspection/nm-active-connection.xml +++ b/introspection/nm-active-connection.xml @@ -9,6 +9,15 @@ The Connection.Active object tracks the life-cycle of the connection attempt and if successful indicates whether the connected network is the "default" or preferred network for access. + NetworkManager has the concept of connections, which can be thought of as + settings, a profile or a configuration that can be applied on a networking + device. + Such settings-connections are exposed as D-Bus object and the active-connection + expresses this relationship between device and settings-connection. + At any time a settings-connection can only be activated on one device and vice + versa. However, during activation and deactivation multiple active-connections + can reference the same device or settings-connection as they are waiting to + be activated or to be deactivated.