introspection: document the meaning of active connections
authorThomas Haller <thaller@redhat.com>
Sat, 13 Feb 2016 13:41:57 +0000 (14:41 +0100)
committerThomas Haller <thaller@redhat.com>
Tue, 16 Feb 2016 10:24:49 +0000 (11:24 +0100)
introspection/nm-active-connection.xml

index 4d5d15a..203437b 100644 (file)
@@ -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">