diff options
Diffstat (limited to 'docs/api/html/gdbus-org.freedesktop.NetworkManager.Connection.Active.html')
| -rw-r--r-- | docs/api/html/gdbus-org.freedesktop.NetworkManager.Connection.Active.html | 79 |
1 files changed, 63 insertions, 16 deletions
diff --git a/docs/api/html/gdbus-org.freedesktop.NetworkManager.Connection.Active.html b/docs/api/html/gdbus-org.freedesktop.NetworkManager.Connection.Active.html index 5d4db35f..cb21000b 100644 --- a/docs/api/html/gdbus-org.freedesktop.NetworkManager.Connection.Active.html +++ b/docs/api/html/gdbus-org.freedesktop.NetworkManager.Connection.Active.html @@ -61,7 +61,21 @@ </div> <div class="refsect1"> <a name="gdbus-interface-org-freedesktop-NetworkManager-Connection-Active"></a><h2>Description</h2> -<p>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.</p> +<p> 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. +</p> </div> <div class="refsect1"> <a name="gdbus-signals-org.freedesktop.NetworkManager.Connection.Active"></a><h2>Signal Details</h2> @@ -90,7 +104,8 @@ PropertiesChanged (a{sv} properties); <pre class="programlisting"> Connection readable o </pre> -<p>The path of the connection.</p> +<p> The path of the connection. +</p> </div> <hr> <div class="refsect2"> @@ -98,7 +113,10 @@ Connection readable o <pre class="programlisting"> SpecificObject readable o </pre> -<p>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.</p> +<p> 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. +</p> </div> <hr> <div class="refsect2"> @@ -106,7 +124,9 @@ SpecificObject readable o <pre class="programlisting"> Id readable s </pre> -<p>The ID of the connection, provided as a convenience so that clients do not have to retrieve all connection details.</p> +<p> The ID of the connection, provided as a convenience so that clients do not + have to retrieve all connection details. +</p> </div> <hr> <div class="refsect2"> @@ -114,7 +134,9 @@ Id readable s <pre class="programlisting"> Uuid readable s </pre> -<p>The UUID of the connection, provided as a convenience so that clients do not have to retrieve all connection details.</p> +<p> The UUID of the connection, provided as a convenience so that clients do + not have to retrieve all connection details. +</p> </div> <hr> <div class="refsect2"> @@ -122,7 +144,9 @@ Uuid readable s <pre class="programlisting"> Type readable s </pre> -<p>The type of the connection, provided as a convenience so that clients do not have to retrieve all connection details.</p> +<p> The type of the connection, provided as a convenience so that clients do + not have to retrieve all connection details. +</p> </div> <hr> <div class="refsect2"> @@ -130,7 +154,9 @@ Type readable s <pre class="programlisting"> Devices readable ao </pre> -<p>Array of object paths representing devices which are part of this active connection.</p> +<p> Array of object paths representing devices which are part of this active + connection. +</p> </div> <hr> <div class="refsect2"> @@ -138,7 +164,10 @@ Devices readable ao <pre class="programlisting"> State readable u </pre> -<p>The state of this active connection.</p> +<p> The state of this active connection. +</p> +<p> Returns: <a href="https://developer.gnome.org/libnm-util/0.9/libnm-util-NetworkManager.html#NMActiveConnectionState">NMActiveConnectionState</a> +</p> </div> <hr> <div class="refsect2"> @@ -146,7 +175,9 @@ State readable u <pre class="programlisting"> Default readable b </pre> -<p>Whether this active connection is the default IPv4 connection, i.e. whether it currently owns the default IPv4 route.</p> +<p> Whether this active connection is the default IPv4 connection, i.e. + whether it currently owns the default IPv4 route. +</p> </div> <hr> <div class="refsect2"> @@ -154,7 +185,10 @@ Default readable b <pre class="programlisting"> Ip4Config readable o </pre> -<p>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.</p> +<p> 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. +</p> </div> <hr> <div class="refsect2"> @@ -162,7 +196,10 @@ Ip4Config readable o <pre class="programlisting"> Dhcp4Config readable o </pre> -<p>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.</p> +<p> 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. +</p> </div> <hr> <div class="refsect2"> @@ -170,7 +207,9 @@ Dhcp4Config readable o <pre class="programlisting"> Default6 readable b </pre> -<p>Whether this active connection is the default IPv6 connection, i.e. whether it currently owns the default IPv6 route.</p> +<p> Whether this active connection is the default IPv6 connection, i.e. + whether it currently owns the default IPv6 route. +</p> </div> <hr> <div class="refsect2"> @@ -178,7 +217,10 @@ Default6 readable b <pre class="programlisting"> Ip6Config readable o </pre> -<p>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.</p> +<p> 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. +</p> </div> <hr> <div class="refsect2"> @@ -186,7 +228,10 @@ Ip6Config readable o <pre class="programlisting"> Dhcp6Config readable o </pre> -<p>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.</p> +<p> 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. +</p> </div> <hr> <div class="refsect2"> @@ -194,7 +239,8 @@ Dhcp6Config readable o <pre class="programlisting"> Vpn readable b </pre> -<p>Whether this active connection is also a VPN connection.</p> +<p> Whether this active connection is also a VPN connection. +</p> </div> <hr> <div class="refsect2"> @@ -202,7 +248,8 @@ Vpn readable b <pre class="programlisting"> Master readable o </pre> -<p>The path to the master device if the connection is a slave.</p> +<p> The path to the master device if the connection is a slave. +</p> </div> </div> </div> |