From 59c3714a494c3b3765657c0551ad82842d98a7d2 Mon Sep 17 00:00:00 2001 From: Sjoerd Simons Date: Sat, 26 Apr 2014 20:55:09 +0200 Subject: Imported Upstream version 0.9.8.10 --- docs/libnm-glib/html/NMActiveConnection.html | 847 +++++++++++++++------------ 1 file changed, 480 insertions(+), 367 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 9cb406f4..ba775eab 100644 --- a/docs/libnm-glib/html/NMActiveConnection.html +++ b/docs/libnm-glib/html/NMActiveConnection.html @@ -2,36 +2,28 @@ -NMActiveConnection +libnm-glib Reference Manual: NMActiveConnection - + - - - - - - - - - - + + + + + + +
@@ -39,59 +31,192 @@

NMActiveConnection

NMActiveConnection

- +
-
-

Synopsis

-
#define             NM_ACTIVE_CONNECTION_CONNECTION
-#define             NM_ACTIVE_CONNECTION_UUID
-#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_DEFAULT6
-#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_uuid       (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);
-gboolean            nm_active_connection_get_default    (NMActiveConnection *connection);
-gboolean            nm_active_connection_get_default6   (NMActiveConnection *connection);
-const char *        nm_active_connection_get_master     (NMActiveConnection *connection);
-
+
+

Functions

+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+GObject * + +nm_active_connection_new () +
const char * + +nm_active_connection_get_connection () +
const char * + +nm_active_connection_get_uuid () +
const char * + +nm_active_connection_get_specific_object () +
const GPtrArray * + +nm_active_connection_get_devices () +
+NMActiveConnectionState + +nm_active_connection_get_state () +
+gboolean + +nm_active_connection_get_default () +
+gboolean + +nm_active_connection_get_default6 () +
const char * + +nm_active_connection_get_master () +
-

Object Hierarchy

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

Properties

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

Implemented Interfaces

-

-NMActiveConnection implements - GInitable and GAsyncInitable.

+

Types and Values

+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
#defineNM_ACTIVE_CONNECTION_CONNECTION
#defineNM_ACTIVE_CONNECTION_UUID
#defineNM_ACTIVE_CONNECTION_SPECIFIC_OBJECT
#defineNM_ACTIVE_CONNECTION_DEVICES
#defineNM_ACTIVE_CONNECTION_STATE
#defineNM_ACTIVE_CONNECTION_DEFAULT
#defineNM_ACTIVE_CONNECTION_DEFAULT6
#defineNM_ACTIVE_CONNECTION_MASTER
-

Properties

-
-  "connection"               gchar*                : Read
-  "default"                  gboolean              : Read
-  "default6"                 gboolean              : Read
-  "devices"                  NMObjectArray*        : Read
-  "master"                   gchar*                : Read
-  "specific-object"          gchar*                : Read
-  "state"                    guint                 : Read
-  "uuid"                     gchar*                : Read
+
Object Hierarchy

+
    GObject
+    ╰── NMObject
+        ╰── NMActiveConnection
+            ╰── NMVPNConnection
@@ -100,413 +225,401 @@ NMActiveConnection implements

-

Details

+

Functions

-

NM_ACTIVE_CONNECTION_CONNECTION

-
#define NM_ACTIVE_CONNECTION_CONNECTION          "connection"
-
-

-

+

nm_active_connection_new ()

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

Creates a new NMActiveConnection.

+
+

Parameters

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

connection

the DBusGConnection

 

path

the DBus object path of the device

 
-
-
-

NM_ACTIVE_CONNECTION_UUID

-
#define NM_ACTIVE_CONNECTION_UUID                "uuid"
-
-

-

+
+

Returns

+

a new active connection.

+

[transfer full]

-
-
-

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

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

Gets the NMConnection's DBus object path.

+
+

Parameters

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

connection

a NMActiveConnection

 
+
+
+

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_STATE

-
#define NM_ACTIVE_CONNECTION_STATE               "state"
-
-

-

-

NM_ACTIVE_CONNECTION_DEFAULT

-
#define NM_ACTIVE_CONNECTION_DEFAULT             "default"
-
-

-

+

nm_active_connection_get_uuid ()

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

Gets the NMConnection's UUID.

+
+

Parameters

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

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_DEFAULT6

-
#define NM_ACTIVE_CONNECTION_DEFAULT6            "default6"
-
-

-

+

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

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

connection

a NMActiveConnection

 
+
+
+

Returns

+

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

+

+
-

NM_ACTIVE_CONNECTION_MASTER

-
#define NM_ACTIVE_CONNECTION_MASTER              "master"
-
-

-

+

nm_active_connection_get_devices ()

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

Gets the NMDevices used for the active connections.

+
+

Parameters

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

connection

a NMActiveConnection

 
+
+
+

Returns

+

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

+

[element-type NMClient.Device]

+
-

NMActiveConnection

-
typedef struct _NMActiveConnection NMActiveConnection;
-

-

+

nm_active_connection_get_state ()

+
NMActiveConnectionState
+nm_active_connection_get_state (NMActiveConnection *connection);
+

Gets the active connection's state.

+
+

Parameters

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

connection

a NMActiveConnection

 
+
+
+

Returns

+

the state

+

+
-

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_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

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

connection

a NMActiveConnection

 
+
+
+

Returns

+

TRUE if the active connection is the default IPv4 connection

+

+
-

nm_active_connection_new ()

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

-Creates a new NMActiveConnection. -

-
+

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

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

connection :

the DBusGConnection -

path :

the DBus object path of the device

Returns :

a new active connection. [transfer full] -

connection

a NMActiveConnection

 
+
+

Returns

+

TRUE if the active connection is the default IPv6 connection

+

+
+
-

nm_active_connection_get_connection ()

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

-Gets the NMConnection's DBus object path. -

-
+

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

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

connection :

a NMActiveConnection -

Returns :

the object path of the NMConnection inside of NMActiveConnection. -This is the internal string used by the connection, and must not be modified.

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.

+

+
+
+
+
+

Types and Values

+
+

NM_ACTIVE_CONNECTION_CONNECTION

+
#define NM_ACTIVE_CONNECTION_CONNECTION          "connection"
+
+

+

+
-

nm_active_connection_get_uuid ()

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

NM_ACTIVE_CONNECTION_UUID

+
#define NM_ACTIVE_CONNECTION_UUID                "uuid"
+

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

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

NM_ACTIVE_CONNECTION_SPECIFIC_OBJECT

+
#define NM_ACTIVE_CONNECTION_SPECIFIC_OBJECT     "specific-object"
+

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

-
---- - - - - - - - - - - -

connection :

a NMActiveConnection -

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);
+

NM_ACTIVE_CONNECTION_DEVICES

+
#define NM_ACTIVE_CONNECTION_DEVICES             "devices"
+

-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 NMClient.Device] -
-

nm_active_connection_get_state ()

-
NMActiveConnectionState nm_active_connection_get_state  (NMActiveConnection *connection);
+

NM_ACTIVE_CONNECTION_STATE

+
#define NM_ACTIVE_CONNECTION_STATE               "state"
+

-Gets the active connection's state.

-
---- - - - - - - - - - - -

connection :

a NMActiveConnection -

Returns :

the state
-

nm_active_connection_get_default ()

-
gboolean            nm_active_connection_get_default    (NMActiveConnection *connection);
+

NM_ACTIVE_CONNECTION_DEFAULT

+
#define NM_ACTIVE_CONNECTION_DEFAULT             "default"
+

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

-
gboolean            nm_active_connection_get_default6   (NMActiveConnection *connection);
+

NM_ACTIVE_CONNECTION_DEFAULT6

+
#define NM_ACTIVE_CONNECTION_DEFAULT6            "default6"
+

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

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

NM_ACTIVE_CONNECTION_MASTER

+
#define NM_ACTIVE_CONNECTION_MASTER              "master"
+

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

-
---- - - - - - - - - - - -

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.

Property Details

-

The "connection" property

-
  "connection"               gchar*                : Read
-

-The connection's path of the active connection. -

+

The “connection” property

+
  “connection”               gchar *
+

Connection.

+

Flags: Read

Default value: NULL

-

The "default" property

-
  "default"                  gboolean              : Read
-

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

+

The “default” property

+
  “default”                  gboolean
+

Is the default IPv4 active connection.

+

Flags: Read

Default value: FALSE

-

The "default6" property

-
  "default6"                 gboolean              : Read
-

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

+

The “default6” property

+
  “default6”                 gboolean
+

Is the default IPv6 active connection.

+

Flags: Read

Default value: FALSE

-

The "devices" property

-
  "devices"                  NMObjectArray*        : Read
+

The “devices” property

+
  “devices”                  NMObjectArray *

Devices.

+

Flags: Read

-

The "master" property

-
  "master"                   gchar*                : Read
-

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

+

The “master” property

+
  “master”                   gchar *
+

Path of the master device.

+

Flags: Read

Default value: NULL

-

The "specific-object" property

-
  "specific-object"          gchar*                : Read
-

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

+

The “specific-object” property

+
  “specific-object”          gchar *
+

Specific object.

+

Flags: Read

Default value: NULL

-

The "state" property

-
  "state"                    guint                 : Read
-

-The state of the active connection. -

+

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 -

+

The “uuid” property

+
  “uuid”                     gchar *
+

UUID.

+

Flags: Read

Default value: NULL

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