diff options
| author | Michael Biebl <biebl@debian.org> | 2022-08-12 19:21:11 +0200 |
|---|---|---|
| committer | Michael Biebl <biebl@debian.org> | 2022-08-12 19:21:11 +0200 |
| commit | 6accbd3ec0e42d8633bbde4d47ed7bfe854e7e0b (patch) | |
| tree | a77a0617213a5183a4de43824e3fbae9779e9b8e /docs/api/dbus-org.freedesktop.NetworkManager.Connection.Active.xml | |
| parent | f7c750061dab327e638c0129cfafd5b2215b3a2e (diff) | |
New upstream version 1.38.4 upstream/1.38.4
Diffstat (limited to 'docs/api/dbus-org.freedesktop.NetworkManager.Connection.Active.xml')
| -rw-r--r-- | docs/api/dbus-org.freedesktop.NetworkManager.Connection.Active.xml | 126 |
1 files changed, 75 insertions, 51 deletions
diff --git a/docs/api/dbus-org.freedesktop.NetworkManager.Connection.Active.xml b/docs/api/dbus-org.freedesktop.NetworkManager.Connection.Active.xml index d083906a..00f2a708 100644 --- a/docs/api/dbus-org.freedesktop.NetworkManager.Connection.Active.xml +++ b/docs/api/dbus-org.freedesktop.NetworkManager.Connection.Active.xml @@ -35,20 +35,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> +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"> @@ -60,16 +61,21 @@ StateChanged (u state, u reason); </programlisting> -<para> Emitted when the state of the active connection has changed. +<para> +Emitted when the state of the active connection has changed. </para> <variablelist role="params"> <varlistentry> <term><literal>u <parameter>state</parameter></literal>:</term> - <listitem><para>(<link linkend="NMActiveConnectionState">NMActiveConnectionState</link>) The new state of the active connection.</para></listitem> + <listitem><para> +(<link linkend="NMActiveConnectionState">NMActiveConnectionState</link>) The new state of the active connection. +</para></listitem> </varlistentry> <varlistentry> <term><literal>u <parameter>reason</parameter></literal>:</term> - <listitem><para>(<link linkend="NMActiveConnectionStateReason">NMActiveConnectionStateReason</link>) Reason code describing the change to the new state.</para></listitem> + <listitem><para> +(<link linkend="NMActiveConnectionStateReason">NMActiveConnectionStateReason</link>) Reason code describing the change to the new state. +</para></listitem> </varlistentry> </variablelist> <para role="since">Since 1.8</para> @@ -83,7 +89,8 @@ StateChanged (u state, <programlisting> Connection readable o </programlisting> -<para> The path of the connection. +<para> +The path of the connection. </para> </refsect2> <refsect2 role="property" id="gdbus-property-org-freedesktop-NetworkManager-Connection-Active.SpecificObject"> @@ -92,9 +99,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> +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"> @@ -103,8 +111,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> +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"> @@ -113,8 +122,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> +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"> @@ -123,8 +133,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> +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"> @@ -133,8 +144,9 @@ Type readable s <programlisting> Devices readable ao </programlisting> -<para> Array of object paths representing devices which are part of this active - connection. +<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"> @@ -143,8 +155,10 @@ Devices readable ao <programlisting> State readable u </programlisting> -<para> The state of this active connection. -</para><para> Returns: <link linkend="NMActiveConnectionState">NMActiveConnectionState</link> +<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.StateFlags"> @@ -153,8 +167,10 @@ State readable u <programlisting> StateFlags readable u </programlisting> -<para> The state flags of this active connection. -</para><para> Returns: <link linkend="NMActivationStateFlags">NMActivationStateFlags</link> +<para> +The state flags of this active connection. +</para><para> +Returns: <link linkend="NMActivationStateFlags">NMActivationStateFlags</link> </para> </refsect2> <refsect2 role="property" id="gdbus-property-org-freedesktop-NetworkManager-Connection-Active.Default"> @@ -163,8 +179,9 @@ StateFlags 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> +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"> @@ -173,9 +190,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> +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"> @@ -184,9 +202,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> +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"> @@ -195,8 +214,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> +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"> @@ -205,9 +225,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> +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"> @@ -216,9 +237,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> +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"> @@ -227,7 +249,8 @@ Dhcp6Config readable o <programlisting> Vpn readable b </programlisting> -<para> Whether this active connection is also a VPN connection. +<para> +Whether this active connection is also a VPN connection. </para> </refsect2> <refsect2 role="property" id="gdbus-property-org-freedesktop-NetworkManager-Connection-Active.Master"> @@ -236,7 +259,8 @@ Vpn readable b <programlisting> Master readable o </programlisting> -<para> The path to the master device if the connection is a slave. +<para> +The path to the master device if the connection is a slave. </para> </refsect2> </refsect1> |