From 33491bc4279481db8ae47213e34a6d695a0e8830 Mon Sep 17 00:00:00 2001 From: Michael Biebl Date: Sun, 6 Jul 2014 02:16:10 +0200 Subject: Imported Upstream version 0.9.10.0 --- docs/libnm-glib/html/NMActiveConnection.html | 1086 ++++++++++++++++---------- 1 file changed, 662 insertions(+), 424 deletions(-) (limited to 'docs/libnm-glib/html/NMActiveConnection.html') diff --git a/docs/libnm-glib/html/NMActiveConnection.html b/docs/libnm-glib/html/NMActiveConnection.html index ba775eab..0e8471d5 100644 --- a/docs/libnm-glib/html/NMActiveConnection.html +++ b/docs/libnm-glib/html/NMActiveConnection.html @@ -2,28 +2,36 @@ -libnm-glib Reference Manual: NMActiveConnection +NMActiveConnection - + - - - - - - - + + + + + + + + + +
@@ -31,595 +39,825 @@

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
+#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
+                    NMActiveConnection;
+                    NMActiveConnectionClass;
+GObject *           nm_active_connection_new            (DBusGConnection *connection,
+                                                         const char *path);
+const char *        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
+                                                        (NMActiveConnection *connection);
+const GPtrArray *   nm_active_connection_get_devices    (NMActiveConnection *connection);
+NMActiveConnectionState nm_active_connection_get_state  (NMActiveConnection *connection);
+const char *        nm_active_connection_get_master     (NMActiveConnection *connection);
+gboolean            nm_active_connection_get_default    (NMActiveConnection *connection);
+NMIP4Config *       nm_active_connection_get_ip4_config (NMActiveConnection *connection);
+NMDHCP4Config *     nm_active_connection_get_dhcp4_config
+                                                        (NMActiveConnection *connection);
+gboolean            nm_active_connection_get_default6   (NMActiveConnection *connection);
+NMIP6Config *       nm_active_connection_get_ip6_config (NMActiveConnection *connection);
+NMDHCP6Config *     nm_active_connection_get_dhcp6_config
+                                                        (NMActiveConnection *connection);
+gboolean            nm_active_connection_get_vpn        (NMActiveConnection *connection);
+
+
-

Functions

-
+

Object Hierarchy

+
+  GObject
+   +----NMObject
+         +----NMActiveConnection
+               +----NMVPNConnection
+
+ +
+

Implemented Interfaces

+

+NMActiveConnection implements + GInitable and GAsyncInitable.

+
+
+

Properties

+
+  "connection"               gchar*                : Read
+  "default"                  gboolean              : Read
+  "default6"                 gboolean              : Read
+  "devices"                  NMObjectArray*        : Read
+  "dhcp4-config"             NMDHCP4Config*        : Read
+  "dhcp6-config"             NMDHCP6Config*        : Read
+  "id"                       gchar*                : Read
+  "ip4-config"               NMIP4Config*          : Read
+  "ip6-config"               NMIP6Config*          : Read
+  "master"                   gchar*                : Read
+  "specific-object"          gchar*                : Read
+  "state"                    guint                 : 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

+
#define NM_ACTIVE_CONNECTION_SPECIFIC_OBJECT     "specific-object"
+
+

+

+
+
+
+

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"
+
+

+

+
+
+
+

NMActiveConnection

+
typedef struct _NMActiveConnection NMActiveConnection;
+

+

+
+
+
+

NMActiveConnectionClass

+
typedef struct {
+	NMObjectClass parent;
+
+	/* Padding for future expansion */
+	void (*_reserved1) (void);
+	void (*_reserved2) (void);
+	void (*_reserved3) (void);
+	void (*_reserved4) (void);
+	void (*_reserved5) (void);
+	void (*_reserved6) (void);
+} NMActiveConnectionClass;
+
+

+

+
+
+
+

nm_active_connection_new ()

+
GObject *           nm_active_connection_new            (DBusGConnection *connection,
+                                                         const char *path);
+

+Creates a new NMActiveConnection. +

+
--++ - - + - - + + - - + + +
-GObject * - -nm_active_connection_new () +

connection :

the DBusGConnection
const char * - -nm_active_connection_get_connection () -

path :

the DBus object path of the device
const char * - -nm_active_connection_get_uuid () +

Returns :

a new active connection. [transfer full]
+
+
+
+

nm_active_connection_get_connection ()

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

+Gets the NMConnection's DBus object path. This is often used with +nm_remote_settings_get_connection_by_path() to retrieve the +NMRemoteConnection object that describes the connection. +

+
++++ + - - + - - + + + +
const char * - -nm_active_connection_get_specific_object () +

connection :

a NMActiveConnection
const GPtrArray * - -nm_active_connection_get_devices () -

Returns :

the object path of the NMConnection which this NMActiveConnection +is an active instance of. This is the internal string used by the +connection, and must not be modified.
+
+
+
+

nm_active_connection_get_id ()

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

+Gets the NMConnection's ID. +

+
++++ + - - + - - + + + +
-NMActiveConnectionState - -nm_active_connection_get_state () +

connection :

a NMActiveConnection
-gboolean - -nm_active_connection_get_default () -

Returns :

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

Since 0.9.10

+
+
+
+

nm_active_connection_get_uuid ()

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

+Gets the NMConnection's UUID. +

+
++++ + - - + - - + +
-gboolean - -nm_active_connection_get_default6 () +

connection :

a NMActiveConnection
const char * - -nm_active_connection_get_master () -

Returns :

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

Properties

-
+
+
+

nm_active_connection_get_connection_type ()

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

+Gets the NMConnection's type. +

+
---++ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + - - - + +
-gchar *connectionRead
gbooleandefaultRead
gbooleandefault6Read
-NMObjectArray *devicesRead
-gchar *masterRead
-gchar *specific-objectRead
guintstateRead

connection :

a NMActiveConnection +
-gchar *uuidRead

Returns :

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

Since 0.9.10

-
-

Types and Values

-
+
+
+

nm_active_connection_get_specific_object ()

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

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

+
--++ - - - - - - - - - - - - - - - - - - + + - - + + + +
#defineNM_ACTIVE_CONNECTION_CONNECTION
#defineNM_ACTIVE_CONNECTION_UUID
#defineNM_ACTIVE_CONNECTION_SPECIFIC_OBJECT
#defineNM_ACTIVE_CONNECTION_DEVICES
#defineNM_ACTIVE_CONNECTION_STATE

connection :

a NMActiveConnection +
#defineNM_ACTIVE_CONNECTION_DEFAULT

Returns :

the specific object's DBus 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. +

+
++++ + - - + + - - + +
#defineNM_ACTIVE_CONNECTION_DEFAULT6

connection :

a NMActiveConnection +
#defineNM_ACTIVE_CONNECTION_MASTER

Returns :

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

Object Hierarchy

-
    GObject
-    ╰── NMObject
-        ╰── NMActiveConnection
-            ╰── NMVPNConnection
-
-
-
-

Description

+
+
+

nm_active_connection_get_state ()

+
NMActiveConnectionState nm_active_connection_get_state  (NMActiveConnection *connection);

+Gets the active connection's state.

-
-
-

Functions

-
-

nm_active_connection_new ()

-
GObject *
-nm_active_connection_new (DBusGConnection *connection,
-                          const char *path);
-

Creates a new NMActiveConnection.

-
-

Parameters

-
+
---++ - - - + + - - - + +

connection

the DBusGConnection

 

connection :

a NMActiveConnection +

path

the DBus object path of the device

 

Returns :

the state
-
-

Returns

-

a new active connection.

-

[transfer full]

-
-
-

nm_active_connection_get_connection ()

-
const char *
-nm_active_connection_get_connection (NMActiveConnection *connection);
-

Gets the NMConnection's DBus object path.

-
-

Parameters

-
+

nm_active_connection_get_master ()

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

+Gets the path to the master NMDevice of the connection. +

+
---++ - - - - - + + + + + + + + + +

connection

a NMActiveConnection

 

connection :

a NMActiveConnection +

Returns :

the path of the master NMDevice of the NMActiveConnection. +This is the internal string used by the connection, and must not be modified.
-
-

Returns

-

the object path of the NMConnection inside of 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.

-
-

Parameters

-
+

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

 

connection :

a NMActiveConnection +

Returns :

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

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_specific_object ()

-
const char *
-nm_active_connection_get_specific_object
-                               (NMActiveConnection *connection);
-

Gets the "specific object" used at the activation.

-
-

Parameters

-
+

nm_active_connection_get_ip4_config ()

+
NMIP4Config *       nm_active_connection_get_ip4_config (NMActiveConnection *connection);
+

+Gets the current NMIP4Config associated with the NMActiveConnection. +

+
---++ - - - - - + + + + + + + + + +

connection

a NMActiveConnection

 

connection :

an NMActiveConnection +

Returns :

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

Returns

-

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

-

-
+

Since 0.9.10

-

nm_active_connection_get_devices ()

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

Gets the NMDevices used for the active connections.

-
-

Parameters

-
+

nm_active_connection_get_dhcp4_config ()

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

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

+
---++ - - - - - + + + + + + + + + +

connection

a NMActiveConnection

 

connection :

an NMActiveConnection +

Returns :

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

Returns

-

the GPtrArray containing NMDevices. -This is the internal copy used by the connection, and must not be modified.

-

[element-type NMClient.Device]

-
+

Since 0.9.10

-

nm_active_connection_get_state ()

-
NMActiveConnectionState
-nm_active_connection_get_state (NMActiveConnection *connection);
-

Gets the active connection's state.

-
-

Parameters

-
+

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

 

connection :

a NMActiveConnection +

Returns :

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

Returns

-

the state

-

-
-
-

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).

-
-

Parameters

-
+

nm_active_connection_get_ip6_config ()

+
NMIP6Config *       nm_active_connection_get_ip6_config (NMActiveConnection *connection);
+

+Gets the current NMIP6Config associated with the NMActiveConnection. +

+
---++ - - - - - + + + + + + + + + +

connection

a NMActiveConnection

 

connection :

an NMActiveConnection +

Returns :

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

Returns

-

TRUE if the active connection is the default IPv4 connection

-

-
+

Since 0.9.10

-

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).

-
-

Parameters

-
+

nm_active_connection_get_dhcp6_config ()

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

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

+
---++ - - - - - + + + + + + + + + +

connection

a NMActiveConnection

 

connection :

an NMActiveConnection +

Returns :

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

Returns

-

TRUE if the active connection is the default IPv6 connection

-

-
+

Since 0.9.10

-

nm_active_connection_get_master ()

-
const char *
-nm_active_connection_get_master (NMActiveConnection *connection);
-

Gets the path to the master NMDevice of the connection.

-
-

Parameters

-
+

nm_active_connection_get_vpn ()

+
gboolean            nm_active_connection_get_vpn        (NMActiveConnection *connection);
+

+Whether the active connection is a VPN connection. +

+
---++ - - - - - + + + + + + + + + +

connection

a NMActiveConnection

 

connection :

a NMActiveConnection +

Returns :

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

Returns

-

the path of the master NMDevice of the NMActiveConnection. -This is the internal string used by the connection, and must not be modified.

-

-
+

Since 0.9.10

-

Types and Values

+

Property Details

-

NM_ACTIVE_CONNECTION_CONNECTION

-
#define NM_ACTIVE_CONNECTION_CONNECTION          "connection"
-
+

The "connection" property

+
  "connection"               gchar*                : Read

+The connection's path of the active connection.

+

Default value: NULL

-

NM_ACTIVE_CONNECTION_UUID

-
#define NM_ACTIVE_CONNECTION_UUID                "uuid"
-
+

The "default" property

+
  "default"                  gboolean              : Read

+Whether the active connection is the default IPv4 one.

+

Default value: FALSE

-

NM_ACTIVE_CONNECTION_SPECIFIC_OBJECT

-
#define NM_ACTIVE_CONNECTION_SPECIFIC_OBJECT     "specific-object"
-
+

The "default6" property

+
  "default6"                 gboolean              : Read

+Whether the active connection is the default IPv6 one.

+

Default value: FALSE

-

NM_ACTIVE_CONNECTION_DEVICES

-
#define NM_ACTIVE_CONNECTION_DEVICES             "devices"
-
-

-

+

The "devices" property

+
  "devices"                  NMObjectArray*        : Read
+

Devices.

-

NM_ACTIVE_CONNECTION_STATE

-
#define NM_ACTIVE_CONNECTION_STATE               "state"
-
+

The "dhcp4-config" property

+
  "dhcp4-config"             NMDHCP4Config*        : Read

+The NMDHCP4Config of the connection.

+

Since 0.9.10

-

NM_ACTIVE_CONNECTION_DEFAULT

-
#define NM_ACTIVE_CONNECTION_DEFAULT             "default"
-
+

The "dhcp6-config" property

+
  "dhcp6-config"             NMDHCP6Config*        : Read

+The NMDHCP6Config of the connection.

+

Since 0.9.10

-

NM_ACTIVE_CONNECTION_DEFAULT6

-
#define NM_ACTIVE_CONNECTION_DEFAULT6            "default6"
-
+

The "id" property

+
  "id"                       gchar*                : Read

+The active connection's ID

+

Default value: NULL

+

Since 0.9.10

-

NM_ACTIVE_CONNECTION_MASTER

-
#define NM_ACTIVE_CONNECTION_MASTER              "master"
-
+

The "ip4-config" property

+
  "ip4-config"               NMIP4Config*          : Read

+The NMIP4Config of the connection.

-
-
-
-

Property Details

-
-

The “connection” property

-
  “connection”               gchar *
-

Connection.

-

Flags: Read

-

Default value: NULL

+

Since 0.9.10

-

The “default” property

-
  “default”                  gboolean
-

Is the default IPv4 active connection.

-

Flags: Read

-

Default value: FALSE

+

The "ip6-config" property

+
  "ip6-config"               NMIP6Config*          : Read
+

+The NMIP6Config of the connection. +

+

Since 0.9.10

-

The “default6” property

-
  “default6”                 gboolean
-

Is the default IPv6 active connection.

-

Flags: Read

-

Default value: FALSE

+

The "master" property

+
  "master"                   gchar*                : Read
+

+The path of the master device if one exists. +

+

Default value: NULL

-

The “devices” property

-
  “devices”                  NMObjectArray *
-

Devices.

-

Flags: Read

+

The "specific-object" property

+
  "specific-object"          gchar*                : Read
+

+The specific object's path of the active connection. +

+

Default value: NULL

-

The “master” property

-
  “master”                   gchar *
-

Path of the master device.

-

Flags: Read

-

Default value: NULL

+

The "state" property

+
  "state"                    guint                 : Read
+

+The state of the active connection. +

+

Allowed values: <= 3

+

Default value: 0

-

The “specific-object” property

-
  “specific-object”          gchar *
-

Specific object.

-

Flags: Read

+

The "type" property

+
  "type"                     gchar*                : Read
+

+The active connection's type +

Default value: NULL

+

Since 0.9.10

-

The “state” property

-
  “state”                    guint
-

State.

-

Flags: Read

-

Allowed values: <= 3

-

Default value: 0

+

The "uuid" property

+
  "uuid"                     gchar*                : Read
+

+The active connection's UUID +

+

Default value: NULL

-

The “uuid” property

-
  “uuid”                     gchar *
-

UUID.

-

Flags: Read

-

Default value: NULL

+

The "vpn" property

+
  "vpn"                      gboolean              : Read
+

+Whether the active connection is a VPN connection. +

+

Default value: FALSE

+

Since 0.9.10

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