From 2c032d8f1c6292c1338a615e6ec40252889ba85c Mon Sep 17 00:00:00 2001 From: Michael Biebl Date: Thu, 22 Jan 2015 00:29:39 +0100 Subject: Imported Upstream version 1.0.0 --- docs/libnm/html/NMActiveConnection.html | 816 ++++++++++++++++++++++++++++++++ 1 file changed, 816 insertions(+) create mode 100644 docs/libnm/html/NMActiveConnection.html (limited to 'docs/libnm/html/NMActiveConnection.html') diff --git a/docs/libnm/html/NMActiveConnection.html b/docs/libnm/html/NMActiveConnection.html new file mode 100644 index 00000000..15ac0158 --- /dev/null +++ b/docs/libnm/html/NMActiveConnection.html @@ -0,0 +1,816 @@ + + + + +NMActiveConnection + + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+

NMActiveConnection

+

NMActiveConnection

+
+
+

Synopsis

+
#define             NM_ACTIVE_CONNECTION_CONNECTION
+#define             NM_ACTIVE_CONNECTION_ID
+#define             NM_ACTIVE_CONNECTION_UUID
+#define             NM_ACTIVE_CONNECTION_TYPE
+#define             NM_ACTIVE_CONNECTION_SPECIFIC_OBJECT_PATH
+#define             NM_ACTIVE_CONNECTION_DEVICES
+#define             NM_ACTIVE_CONNECTION_STATE
+#define             NM_ACTIVE_CONNECTION_DEFAULT
+#define             NM_ACTIVE_CONNECTION_IP4_CONFIG
+#define             NM_ACTIVE_CONNECTION_DHCP4_CONFIG
+#define             NM_ACTIVE_CONNECTION_DEFAULT6
+#define             NM_ACTIVE_CONNECTION_IP6_CONFIG
+#define             NM_ACTIVE_CONNECTION_DHCP6_CONFIG
+#define             NM_ACTIVE_CONNECTION_VPN
+#define             NM_ACTIVE_CONNECTION_MASTER
+struct              NMActiveConnection;
+                    NMActiveConnectionClass;
+NMRemoteConnection * nm_active_connection_get_connection
+                                                        (NMActiveConnection *connection);
+const char *        nm_active_connection_get_id         (NMActiveConnection *connection);
+const char *        nm_active_connection_get_uuid       (NMActiveConnection *connection);
+const char *        nm_active_connection_get_connection_type
+                                                        (NMActiveConnection *connection);
+const char *        nm_active_connection_get_specific_object_path
+                                                        (NMActiveConnection *connection);
+const GPtrArray *   nm_active_connection_get_devices    (NMActiveConnection *connection);
+NMActiveConnectionState nm_active_connection_get_state  (NMActiveConnection *connection);
+NMDevice *          nm_active_connection_get_master     (NMActiveConnection *connection);
+gboolean            nm_active_connection_get_default    (NMActiveConnection *connection);
+NMIPConfig *        nm_active_connection_get_ip4_config (NMActiveConnection *connection);
+NMDhcpConfig *      nm_active_connection_get_dhcp4_config
+                                                        (NMActiveConnection *connection);
+gboolean            nm_active_connection_get_default6   (NMActiveConnection *connection);
+NMIPConfig *        nm_active_connection_get_ip6_config (NMActiveConnection *connection);
+NMDhcpConfig *      nm_active_connection_get_dhcp6_config
+                                                        (NMActiveConnection *connection);
+gboolean            nm_active_connection_get_vpn        (NMActiveConnection *connection);
+
+
+
+

Object Hierarchy

+
+  GObject
+   +----NMObject
+         +----NMActiveConnection
+               +----NMVpnConnection
+
+
+
+

Implemented Interfaces

+

+NMActiveConnection implements + GInitable and GAsyncInitable.

+
+
+

Properties

+
+  "connection"               NMRemoteConnection*   : Read
+  "default"                  gboolean              : Read
+  "default6"                 gboolean              : Read
+  "devices"                  GPtrArray*            : Read
+  "dhcp4-config"             NMDhcpConfig*         : Read
+  "dhcp6-config"             NMDhcpConfig*         : Read
+  "id"                       gchar*                : Read
+  "ip4-config"               NMIPConfig*           : Read
+  "ip6-config"               NMIPConfig*           : Read
+  "master"                   NMDevice*             : Read
+  "specific-object-path"     gchar*                : Read
+  "state"                    NMActiveConnectionState  : Read
+  "type"                     gchar*                : Read
+  "uuid"                     gchar*                : Read
+  "vpn"                      gboolean              : Read
+
+
+
+

Description

+

+

+
+
+

Details

+
+

NM_ACTIVE_CONNECTION_CONNECTION

+
#define NM_ACTIVE_CONNECTION_CONNECTION           "connection"
+
+

+

+
+
+
+

NM_ACTIVE_CONNECTION_ID

+
#define NM_ACTIVE_CONNECTION_ID                   "id"
+
+

+

+
+
+
+

NM_ACTIVE_CONNECTION_UUID

+
#define NM_ACTIVE_CONNECTION_UUID                 "uuid"
+
+

+

+
+
+
+

NM_ACTIVE_CONNECTION_TYPE

+
#define NM_ACTIVE_CONNECTION_TYPE                 "type"
+
+

+

+
+
+
+

NM_ACTIVE_CONNECTION_SPECIFIC_OBJECT_PATH

+
#define NM_ACTIVE_CONNECTION_SPECIFIC_OBJECT_PATH "specific-object-path"
+
+

+

+
+
+
+

NM_ACTIVE_CONNECTION_DEVICES

+
#define NM_ACTIVE_CONNECTION_DEVICES              "devices"
+
+

+

+
+
+
+

NM_ACTIVE_CONNECTION_STATE

+
#define NM_ACTIVE_CONNECTION_STATE                "state"
+
+

+

+
+
+
+

NM_ACTIVE_CONNECTION_DEFAULT

+
#define NM_ACTIVE_CONNECTION_DEFAULT              "default"
+
+

+

+
+
+
+

NM_ACTIVE_CONNECTION_IP4_CONFIG

+
#define NM_ACTIVE_CONNECTION_IP4_CONFIG           "ip4-config"
+
+

+

+
+
+
+

NM_ACTIVE_CONNECTION_DHCP4_CONFIG

+
#define NM_ACTIVE_CONNECTION_DHCP4_CONFIG         "dhcp4-config"
+
+

+

+
+
+
+

NM_ACTIVE_CONNECTION_DEFAULT6

+
#define NM_ACTIVE_CONNECTION_DEFAULT6             "default6"
+
+

+

+
+
+
+

NM_ACTIVE_CONNECTION_IP6_CONFIG

+
#define NM_ACTIVE_CONNECTION_IP6_CONFIG           "ip6-config"
+
+

+

+
+
+
+

NM_ACTIVE_CONNECTION_DHCP6_CONFIG

+
#define NM_ACTIVE_CONNECTION_DHCP6_CONFIG         "dhcp6-config"
+
+

+

+
+
+
+

NM_ACTIVE_CONNECTION_VPN

+
#define NM_ACTIVE_CONNECTION_VPN                  "vpn"
+
+

+

+
+
+
+

NM_ACTIVE_CONNECTION_MASTER

+
#define NM_ACTIVE_CONNECTION_MASTER               "master"
+
+

+

+
+
+
+

struct NMActiveConnection

+
struct NMActiveConnection;
+

+

+
+
+
+

NMActiveConnectionClass

+
typedef struct {
+	NMObjectClass parent;
+} NMActiveConnectionClass;
+
+

+

+
+
+
+

nm_active_connection_get_connection ()

+
NMRemoteConnection * nm_active_connection_get_connection
+                                                        (NMActiveConnection *connection);
+

+Gets the NMRemoteConnection associated with connection. +

+
++++ + + + + + + + + + + +

connection :

a NMActiveConnection +

Returns :

the NMRemoteConnection which this +NMActiveConnection is an active instance of. [transfer none] +
+
+
+
+

nm_active_connection_get_id ()

+
const char *        nm_active_connection_get_id         (NMActiveConnection *connection);
+

+Gets the NMConnection's ID. +

+
++++ + + + + + + + + + + +

connection :

a NMActiveConnection +

Returns :

the ID of the NMConnection that backs the NMActiveConnection. +This is the internal string used by the connection, and must not be modified.
+
+
+
+

nm_active_connection_get_uuid ()

+
const char *        nm_active_connection_get_uuid       (NMActiveConnection *connection);
+

+Gets the NMConnection's UUID. +

+
++++ + + + + + + + + + + +

connection :

a NMActiveConnection +

Returns :

the UUID of the NMConnection that backs the NMActiveConnection. +This is the internal string used by the connection, and must not be modified.
+
+
+
+

nm_active_connection_get_connection_type ()

+
const char *        nm_active_connection_get_connection_type
+                                                        (NMActiveConnection *connection);
+

+Gets the NMConnection's type. +

+
++++ + + + + + + + + + + +

connection :

a NMActiveConnection +

Returns :

the type of the NMConnection that backs the NMActiveConnection. +This is the internal string used by the connection, and must not be modified.
+
+
+
+

nm_active_connection_get_specific_object_path ()

+
const char *        nm_active_connection_get_specific_object_path
+                                                        (NMActiveConnection *connection);
+

+Gets the path of the "specific object" used at activation. +

+

+Currently there is no single method that will allow you to automatically turn +this into an appropriate NMObject; you need to know what kind of object it +is based on other information. (Eg, if connection corresponds to a Wi-Fi +connection, then the specific object will be an NMAccessPoint, and you can +resolve it with nm_device_wifi_get_access_point_by_path().) +

+
++++ + + + + + + + + + + +

connection :

a NMActiveConnection +

Returns :

the specific object's D-Bus path. This is the internal string used +by the connection, and must not be modified.
+
+
+
+

nm_active_connection_get_devices ()

+
const GPtrArray *   nm_active_connection_get_devices    (NMActiveConnection *connection);
+

+Gets the NMDevices used for the active connections. +

+
++++ + + + + + + + + + + +

connection :

a NMActiveConnection +

Returns :

the GPtrArray containing NMDevices. +This is the internal copy used by the connection, and must not be modified. [element-type NMDevice] +
+
+
+
+

nm_active_connection_get_state ()

+
NMActiveConnectionState nm_active_connection_get_state  (NMActiveConnection *connection);
+

+Gets the active connection's state. +

+
++++ + + + + + + + + + + +

connection :

a NMActiveConnection +

Returns :

the state
+
+
+
+

nm_active_connection_get_master ()

+
NMDevice *          nm_active_connection_get_master     (NMActiveConnection *connection);
+

+Gets the master NMDevice of the connection. +

+
++++ + + + + + + + + + + +

connection :

a NMActiveConnection +

Returns :

the master NMDevice of the NMActiveConnection. [transfer none] +
+
+
+
+

nm_active_connection_get_default ()

+
gboolean            nm_active_connection_get_default    (NMActiveConnection *connection);
+

+Whether the active connection is the default IPv4 one (that is, is used for +the default IPv4 route and DNS information). +

+
++++ + + + + + + + + + + +

connection :

a NMActiveConnection +

Returns :

 +TRUE if the active connection is the default IPv4 connection
+
+
+
+

nm_active_connection_get_ip4_config ()

+
NMIPConfig *        nm_active_connection_get_ip4_config (NMActiveConnection *connection);
+

+Gets the current IPv4 NMIPConfig associated with the NMActiveConnection. +

+
++++ + + + + + + + + + + +

connection :

an NMActiveConnection +

Returns :

the IPv4 NMIPConfig, or NULL if the connection is +not in the NM_ACTIVE_CONNECTION_STATE_ACTIVATED state. [transfer none] +
+
+
+
+

nm_active_connection_get_dhcp4_config ()

+
NMDhcpConfig *      nm_active_connection_get_dhcp4_config
+                                                        (NMActiveConnection *connection);
+

+Gets the current IPv4 NMDhcpConfig (if any) associated with the +NMActiveConnection. +

+
++++ + + + + + + + + + + +

connection :

an NMActiveConnection +

Returns :

the IPv4 NMDhcpConfig, or NULL if the connection +does not use DHCP, or is not in the NM_ACTIVE_CONNECTION_STATE_ACTIVATED +state. [transfer none] +
+
+
+
+

nm_active_connection_get_default6 ()

+
gboolean            nm_active_connection_get_default6   (NMActiveConnection *connection);
+

+Whether the active connection is the default IPv6 one (that is, is used for +the default IPv6 route and DNS information). +

+
++++ + + + + + + + + + + +

connection :

a NMActiveConnection +

Returns :

 +TRUE if the active connection is the default IPv6 connection
+
+
+
+

nm_active_connection_get_ip6_config ()

+
NMIPConfig *        nm_active_connection_get_ip6_config (NMActiveConnection *connection);
+

+Gets the current IPv6 NMIPConfig associated with the NMActiveConnection. +

+
++++ + + + + + + + + + + +

connection :

an NMActiveConnection +

Returns :

the IPv6 NMIPConfig, or NULL if the connection is +not in the NM_ACTIVE_CONNECTION_STATE_ACTIVATED state. [transfer none] +
+
+
+
+

nm_active_connection_get_dhcp6_config ()

+
NMDhcpConfig *      nm_active_connection_get_dhcp6_config
+                                                        (NMActiveConnection *connection);
+

+Gets the current IPv6 NMDhcpConfig (if any) associated with the +NMActiveConnection. +

+
++++ + + + + + + + + + + +

connection :

an NMActiveConnection +

Returns :

the IPv6 NMDhcpConfig, or NULL if the connection +does not use DHCPv6, or is not in the NM_ACTIVE_CONNECTION_STATE_ACTIVATED +state. [transfer none] +
+
+
+
+

nm_active_connection_get_vpn ()

+
gboolean            nm_active_connection_get_vpn        (NMActiveConnection *connection);
+

+Whether the active connection is a VPN connection. +

+
++++ + + + + + + + + + + +

connection :

a NMActiveConnection +

Returns :

 +TRUE if the active connection is a VPN connection
+
+
+
+

Property Details

+
+

The "connection" property

+
  "connection"               NMRemoteConnection*   : Read
+

+The connection that this is an active instance of. +

+
+
+
+

The "default" property

+
  "default"                  gboolean              : Read
+

+Whether the active connection is the default IPv4 one. +

+

Default value: FALSE

+
+
+
+

The "default6" property

+
  "default6"                 gboolean              : Read
+

+Whether the active connection is the default IPv6 one. +

+

Default value: FALSE

+
+
+
+

The "devices" property

+
  "devices"                  GPtrArray*            : Read
+

+The devices of the active connection. +

+

+Element-type: NMDevice +

+
+
+
+

The "dhcp4-config" property

+
  "dhcp4-config"             NMDhcpConfig*         : Read
+

+The IPv4 NMDhcpConfig of the connection. +

+
+
+
+

The "dhcp6-config" property

+
  "dhcp6-config"             NMDhcpConfig*         : Read
+

+The IPv6 NMDhcpConfig of the connection. +

+
+
+
+

The "id" property

+
  "id"                       gchar*                : Read
+

+The active connection's ID +

+

Default value: NULL

+
+
+
+

The "ip4-config" property

+
  "ip4-config"               NMIPConfig*           : Read
+

+The IPv4 NMIPConfig of the connection. +

+
+
+
+

The "ip6-config" property

+
  "ip6-config"               NMIPConfig*           : Read
+

+The IPv6 NMIPConfig of the connection. +

+
+
+
+

The "master" property

+
  "master"                   NMDevice*             : Read
+

+The master device if one exists. +

+
+
+
+

The "specific-object-path" property

+
  "specific-object-path"     gchar*                : Read
+

+The path to the "specific object" of the active connection; see +nm_active_connection_get_specific_object_path() for more details. +

+

Default value: NULL

+
+
+
+

The "state" property

+
  "state"                    NMActiveConnectionState  : Read
+

+The state of the active connection. +

+

Default value: NM_ACTIVE_CONNECTION_STATE_UNKNOWN

+
+
+
+

The "type" property

+
  "type"                     gchar*                : Read
+

+The active connection's type +

+

Default value: NULL

+
+
+
+

The "uuid" property

+
  "uuid"                     gchar*                : Read
+

+The active connection's UUID +

+

Default value: NULL

+
+
+
+

The "vpn" property

+
  "vpn"                      gboolean              : Read
+

+Whether the active connection is a VPN connection. +

+

Default value: FALSE

+
+
+
+
+
+ Generated by GTK-Doc V1.19
+ + \ No newline at end of file -- cgit 1.3.0-6-gf8a5