GNOME.org

NMActiveConnection

NMActiveConnection

Synopsis

#define             NM_ACTIVE_CONNECTION_SERVICE_NAME
#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
                    NMActiveConnection;
                    NMActiveConnectionClass;
GObject *           nm_active_connection_new            (DBusGConnection *connection,
                                                         const char *path);
const char *        nm_active_connection_get_service_name
                                                        (NMActiveConnection *connection);
NMConnectionScope   nm_active_connection_get_scope      (NMActiveConnection *connection);
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);

Object Hierarchy

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

Properties

  "connection"               gchar*                : Read
  "default"                  gboolean              : Read
  "default6"                 gboolean              : Read
  "devices"                  nm-object-array*      : Read
  "service-name"             gchar*                : Read
  "specific-object"          gchar*                : Read
  "state"                    guint                 : Read

Description

Details

NM_ACTIVE_CONNECTION_SERVICE_NAME

#define NM_ACTIVE_CONNECTION_SERVICE_NAME        "service-name"

NM_ACTIVE_CONNECTION_CONNECTION

#define NM_ACTIVE_CONNECTION_CONNECTION          "connection"

NM_ACTIVE_CONNECTION_UUID

#define NM_ACTIVE_CONNECTION_UUID                "uuid"

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_DEFAULT6

#define NM_ACTIVE_CONNECTION_DEFAULT6            "default6"

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.

connection :

 the DBusGConnection

path :

 the DBus object path of the device

Returns :

 a new active connection

nm_active_connection_get_service_name ()

const char *        nm_active_connection_get_service_name
                                                        (NMActiveConnection *connection);

Gets the service name of the active connection.

connection :

 a NMActiveConnection

Returns :

 the service name. This is the internal string used by the connection, and must not be modified.

nm_active_connection_get_scope ()

NMConnectionScope   nm_active_connection_get_scope      (NMActiveConnection *connection);

Gets the scope of the active connection.

connection :

 a NMActiveConnection

Returns :

 the connection's scope

nm_active_connection_get_connection ()

const char *        nm_active_connection_get_connection (NMActiveConnection *connection);

Gets the NMConnection's DBus object path.

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

const char *        nm_active_connection_get_specific_object
                                                        (NMActiveConnection *connection);

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

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.

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

Property Details

The "connection" property

  "connection"               gchar*                : Read

The connection's path of the active connection.

Default value: NULL

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"                  nm-object-array*      : Read

Devices.

The "service-name" property

  "service-name"             gchar*                : Read

The service name of the active connection.

Default value: NULL

The "specific-object" property

  "specific-object"          gchar*                : Read

The specific object's path of the active connection.

Default value: NULL

The "state" property

  "state"                    guint                 : Read

The state of the active connection.

Allowed values: <= 2

Default value: 0

Generated by GTK-Doc V1.15