summaryrefslogtreecommitdiff
path: root/introspection/org.freedesktop.NetworkManager.Connection.Active.xml
diff options
context:
space:
mode:
authorLubomir Rintel <lkundrak@v3.sk>2016-11-23 13:14:08 +0100
committerLubomir Rintel <lkundrak@v3.sk>2016-11-23 15:43:42 +0100
commit972e0d28031d4837fbb7d07dce0a7354e5c1a975 (patch)
treeaa8b64b71a9925af7457b78713787553c9426208 /introspection/org.freedesktop.NetworkManager.Connection.Active.xml
parent0ce7da1e22abf7a4415ef40fca9f1755b8ddfa30 (diff)
downloadNetworkManager-972e0d28031d4837fbb7d07dce0a7354e5c1a975.tar.gz
all: rename the introspection data to use the interface paths in names
This makes it easier to install the files with proper names. Also, it makes the makefile rules slightly simpler. Lastly, the documentation is now generated into docs/api, which makes it possible to get rid of the awkward relative file names in docbook.
Diffstat (limited to 'introspection/org.freedesktop.NetworkManager.Connection.Active.xml')
-rw-r--r--introspection/org.freedesktop.NetworkManager.Connection.Active.xml158
1 files changed, 158 insertions, 0 deletions
diff --git a/introspection/org.freedesktop.NetworkManager.Connection.Active.xml b/introspection/org.freedesktop.NetworkManager.Connection.Active.xml
new file mode 100644
index 0000000000..383ede34a9
--- /dev/null
+++ b/introspection/org.freedesktop.NetworkManager.Connection.Active.xml
@@ -0,0 +1,158 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<node name="/">
+
+ <!--
+ org.freedesktop.NetworkManager.Connection.Active:
+
+ 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.
+ -->
+ <interface name="org.freedesktop.NetworkManager.Connection.Active">
+ <annotation name="org.gtk.GDBus.C.Name" value="ActiveConnection"/>
+
+ <!--
+ Connection:
+
+ The path of the connection.
+ -->
+ <property name="Connection" type="o" access="read"/>
+
+ <!--
+ SpecificObject:
+
+ 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.
+ -->
+ <property name="SpecificObject" type="o" access="read"/>
+
+ <!--
+ Id:
+
+ The ID of the connection, provided as a convenience so that clients do not
+ have to retrieve all connection details.
+ -->
+ <property name="Id" type="s" access="read"/>
+
+ <!--
+ Uuid:
+
+ The UUID of the connection, provided as a convenience so that clients do
+ not have to retrieve all connection details.
+ -->
+ <property name="Uuid" type="s" access="read"/>
+
+ <!--
+ Type:
+
+ The type of the connection, provided as a convenience so that clients do
+ not have to retrieve all connection details.
+ -->
+ <property name="Type" type="s" access="read"/>
+
+ <!--
+ Devices:
+
+ Array of object paths representing devices which are part of this active
+ connection.
+ -->
+ <property name="Devices" type="ao" access="read"/>
+
+ <!--
+ State:
+
+ The state of this active connection.
+
+ Returns: <link linkend="NMActiveConnectionState">NMActiveConnectionState</link>
+ -->
+ <property name="State" type="u" access="read"/>
+
+ <!--
+ Default:
+
+ Whether this active connection is the default IPv4 connection, i.e.
+ whether it currently owns the default IPv4 route.
+ -->
+ <property name="Default" type="b" access="read"/>
+
+ <!--
+ Ip4Config:
+
+ 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.
+ -->
+ <property name="Ip4Config" type="o" access="read"/>
+
+ <!--
+ Dhcp4Config:
+
+ 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.
+ -->
+ <property name="Dhcp4Config" type="o" access="read"/>
+
+ <!--
+ Default6:
+
+ Whether this active connection is the default IPv6 connection, i.e.
+ whether it currently owns the default IPv6 route.
+ -->
+ <property name="Default6" type="b" access="read"/>
+
+ <!--
+ Ip6Config:
+
+ 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.
+ -->
+ <property name="Ip6Config" type="o" access="read"/>
+
+ <!--
+ Dhcp6Config:
+
+ 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.
+ -->
+ <property name="Dhcp6Config" type="o" access="read"/>
+
+ <!--
+ Vpn:
+
+ Whether this active connection is also a VPN connection.
+ -->
+ <property name="Vpn" type="b" access="read"/>
+
+ <!--
+ Master:
+
+ The path to the master device if the connection is a slave.
+ -->
+ <property name="Master" type="o" access="read"/>
+
+ <!--
+ PropertiesChanged:
+ @properties: A dictionary mapping property names to variant boxed values
+
+ DEPRECATED. Use the standard "PropertiesChanged" signal from "org.freedesktop.DBus.Properties" instead which exists since version NetworkManager 1.2.0.
+ -->
+ <signal name="PropertiesChanged">
+ <arg name="properties" type="a{sv}"/>
+ </signal>
+ </interface>
+</node>