diff options
Diffstat (limited to 'introspection/nmdbus-active-connection-org.freedesktop.NetworkManager.Connection.Active.xml')
| -rw-r--r-- | introspection/nmdbus-active-connection-org.freedesktop.NetworkManager.Connection.Active.xml | 78 |
1 files changed, 62 insertions, 16 deletions
diff --git a/introspection/nmdbus-active-connection-org.freedesktop.NetworkManager.Connection.Active.xml b/introspection/nmdbus-active-connection-org.freedesktop.NetworkManager.Connection.Active.xml index a2a352f6..0f002e22 100644 --- a/introspection/nmdbus-active-connection-org.freedesktop.NetworkManager.Connection.Active.xml +++ b/introspection/nmdbus-active-connection-org.freedesktop.NetworkManager.Connection.Active.xml @@ -33,7 +33,21 @@ </refsect1> <refsect1 role="desc" id="gdbus-interface-org-freedesktop-NetworkManager-Connection-Active"> <title role="desc.title">Description</title> - <para>Objects that implement the Connection.Active interface represent an attempt to connect to a network using the details provided by a Connection object. 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.</para> + <para> Objects that implement the Connection.Active interface represent an + attempt to connect to a network using the details provided by a Connection + object. 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. +</para> </refsect1> <refsect1 role="details" id="gdbus-signals-org.freedesktop.NetworkManager.Connection.Active"> <title role="details.title">Signal Details</title> @@ -60,7 +74,8 @@ PropertiesChanged (a{sv} properties); <programlisting> Connection readable o </programlisting> -<para>The path of the connection.</para> +<para> The path of the connection. +</para> </refsect2> <refsect2 role="property" id="gdbus-property-org-freedesktop-NetworkManager-Connection-Active.SpecificObject"> <title>The "SpecificObject" property</title> @@ -68,7 +83,10 @@ Connection readable o <programlisting> SpecificObject readable o </programlisting> -<para>A specific object associated with the active connection. This property reflects the specific object used during connection activation, and will not change over the lifetime of the ActiveConnection once set.</para> +<para> A specific object associated with the active connection. This property + reflects the specific object used during connection activation, and will + not change over the lifetime of the ActiveConnection once set. +</para> </refsect2> <refsect2 role="property" id="gdbus-property-org-freedesktop-NetworkManager-Connection-Active.Id"> <title>The "Id" property</title> @@ -76,7 +94,9 @@ SpecificObject readable o <programlisting> Id readable s </programlisting> -<para>The ID of the connection, provided as a convenience so that clients do not have to retrieve all connection details.</para> +<para> The ID of the connection, provided as a convenience so that clients do not + have to retrieve all connection details. +</para> </refsect2> <refsect2 role="property" id="gdbus-property-org-freedesktop-NetworkManager-Connection-Active.Uuid"> <title>The "Uuid" property</title> @@ -84,7 +104,9 @@ Id readable s <programlisting> Uuid readable s </programlisting> -<para>The UUID of the connection, provided as a convenience so that clients do not have to retrieve all connection details.</para> +<para> The UUID of the connection, provided as a convenience so that clients do + not have to retrieve all connection details. +</para> </refsect2> <refsect2 role="property" id="gdbus-property-org-freedesktop-NetworkManager-Connection-Active.Type"> <title>The "Type" property</title> @@ -92,7 +114,9 @@ Uuid readable s <programlisting> Type readable s </programlisting> -<para>The type of the connection, provided as a convenience so that clients do not have to retrieve all connection details.</para> +<para> The type of the connection, provided as a convenience so that clients do + not have to retrieve all connection details. +</para> </refsect2> <refsect2 role="property" id="gdbus-property-org-freedesktop-NetworkManager-Connection-Active.Devices"> <title>The "Devices" property</title> @@ -100,7 +124,9 @@ Type readable s <programlisting> Devices readable ao </programlisting> -<para>Array of object paths representing devices which are part of this active connection.</para> +<para> Array of object paths representing devices which are part of this active + connection. +</para> </refsect2> <refsect2 role="property" id="gdbus-property-org-freedesktop-NetworkManager-Connection-Active.State"> <title>The "State" property</title> @@ -108,7 +134,9 @@ Devices readable ao <programlisting> State readable u </programlisting> -<para>The state of this active connection.</para> +<para> The state of this active connection. +</para><para> Returns: <link linkend="NMActiveConnectionState">NMActiveConnectionState</link> +</para> </refsect2> <refsect2 role="property" id="gdbus-property-org-freedesktop-NetworkManager-Connection-Active.Default"> <title>The "Default" property</title> @@ -116,7 +144,9 @@ State readable u <programlisting> Default readable b </programlisting> -<para>Whether this active connection is the default IPv4 connection, i.e. whether it currently owns the default IPv4 route.</para> +<para> Whether this active connection is the default IPv4 connection, i.e. + whether it currently owns the default IPv4 route. +</para> </refsect2> <refsect2 role="property" id="gdbus-property-org-freedesktop-NetworkManager-Connection-Active.Ip4Config"> <title>The "Ip4Config" property</title> @@ -124,7 +154,10 @@ Default readable b <programlisting> Ip4Config readable o </programlisting> -<para>Object path of the Ip4Config object describing the configuration of the connection. Only valid when the connection is in the NM_ACTIVE_CONNECTION_STATE_ACTIVATED state.</para> +<para> Object path of the Ip4Config object describing the configuration of the + connection. Only valid when the connection is in the + NM_ACTIVE_CONNECTION_STATE_ACTIVATED state. +</para> </refsect2> <refsect2 role="property" id="gdbus-property-org-freedesktop-NetworkManager-Connection-Active.Dhcp4Config"> <title>The "Dhcp4Config" property</title> @@ -132,7 +165,10 @@ Ip4Config readable o <programlisting> Dhcp4Config readable o </programlisting> -<para>Object path of the Dhcp4Config object describing the DHCP options returned by the DHCP server (assuming the connection used DHCP). Only valid when the connection is in the NM_ACTIVE_CONNECTION_STATE_ACTIVATED state.</para> +<para> Object path of the Dhcp4Config object describing the DHCP options returned + by the DHCP server (assuming the connection used DHCP). Only valid when + the connection is in the NM_ACTIVE_CONNECTION_STATE_ACTIVATED state. +</para> </refsect2> <refsect2 role="property" id="gdbus-property-org-freedesktop-NetworkManager-Connection-Active.Default6"> <title>The "Default6" property</title> @@ -140,7 +176,9 @@ Dhcp4Config readable o <programlisting> Default6 readable b </programlisting> -<para>Whether this active connection is the default IPv6 connection, i.e. whether it currently owns the default IPv6 route.</para> +<para> Whether this active connection is the default IPv6 connection, i.e. + whether it currently owns the default IPv6 route. +</para> </refsect2> <refsect2 role="property" id="gdbus-property-org-freedesktop-NetworkManager-Connection-Active.Ip6Config"> <title>The "Ip6Config" property</title> @@ -148,7 +186,10 @@ Default6 readable b <programlisting> Ip6Config readable o </programlisting> -<para>Object path of the Ip6Config object describing the configuration of the connection. Only valid when the connection is in the NM_ACTIVE_CONNECTION_STATE_ACTIVATED state.</para> +<para> Object path of the Ip6Config object describing the configuration of the + connection. Only valid when the connection is in the + NM_ACTIVE_CONNECTION_STATE_ACTIVATED state. +</para> </refsect2> <refsect2 role="property" id="gdbus-property-org-freedesktop-NetworkManager-Connection-Active.Dhcp6Config"> <title>The "Dhcp6Config" property</title> @@ -156,7 +197,10 @@ Ip6Config readable o <programlisting> Dhcp6Config readable o </programlisting> -<para>Object path of the Dhcp6Config object describing the DHCP options returned by the DHCP server (assuming the connection used DHCP). Only valid when the connection is in the NM_ACTIVE_CONNECTION_STATE_ACTIVATED state.</para> +<para> Object path of the Dhcp6Config object describing the DHCP options returned + by the DHCP server (assuming the connection used DHCP). Only valid when + the connection is in the NM_ACTIVE_CONNECTION_STATE_ACTIVATED state. +</para> </refsect2> <refsect2 role="property" id="gdbus-property-org-freedesktop-NetworkManager-Connection-Active.Vpn"> <title>The "Vpn" property</title> @@ -164,7 +208,8 @@ Dhcp6Config readable o <programlisting> Vpn readable b </programlisting> -<para>Whether this active connection is also a VPN connection.</para> +<para> Whether this active connection is also a VPN connection. +</para> </refsect2> <refsect2 role="property" id="gdbus-property-org-freedesktop-NetworkManager-Connection-Active.Master"> <title>The "Master" property</title> @@ -172,7 +217,8 @@ Vpn readable b <programlisting> Master readable o </programlisting> -<para>The path to the master device if the connection is a slave.</para> +<para> The path to the master device if the connection is a slave. +</para> </refsect2> </refsect1> </refentry> |