summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorThomas Haller <thaller@redhat.com>2016-02-13 14:41:57 +0100
committerThomas Haller <thaller@redhat.com>2016-02-16 00:11:13 +0100
commit2204dc1d58aadc9920d0a4c40b51a234d9a97e66 (patch)
treeaa03201ac9371d2162cb21fecd17a013921cff23
parent148b8c1da54bdf7d55fe601886082c449e9f6ffc (diff)
downloadNetworkManager-th/device-applied-connection-bgo760884.tar.gz
introspection: document the meaning of active connectionsth/device-applied-connection-bgo760884
-rw-r--r--introspection/nm-active-connection.xml9
1 files changed, 9 insertions, 0 deletions
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.
</tp:docstring>
<property name="Connection" type="o" access="read">