Annotation Glossary

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

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

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

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

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

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

\ No newline at end of file diff --git a/docs/libnm-glib/html/NMClient.html b/docs/libnm-glib/html/NMClient.html index 18eddaf5..842183d9 100644 --- a/docs/libnm-glib/html/NMClient.html +++ b/docs/libnm-glib/html/NMClient.html @@ -2,38 +2,29 @@ -NMClient +libnm-glib Reference Manual: NMClient - + - - - - - - - - - -

			libnm-glib Reference Manual
-Top - \| - Description - \| - Object Hierarchy - \| - Implemented Interfaces - \| - Properties - \| - Signals -

+ + + + + + +

@@ -41,1818 +32,2150 @@

NMClient

- +

Synopsis

#define             NM_CLIENT_VERSION
-#define             NM_CLIENT_STATE
-#define             NM_CLIENT_MANAGER_RUNNING
-#define             NM_CLIENT_NETWORKING_ENABLED
-#define             NM_CLIENT_WIRELESS_ENABLED
-#define             NM_CLIENT_WIRELESS_HARDWARE_ENABLED
-#define             NM_CLIENT_WWAN_ENABLED
-#define             NM_CLIENT_WWAN_HARDWARE_ENABLED
-#define             NM_CLIENT_WIMAX_ENABLED
-#define             NM_CLIENT_WIMAX_HARDWARE_ENABLED
-#define             NM_CLIENT_ACTIVE_CONNECTIONS
-#define             NM_CLIENT_CONNECTIVITY
-#define             NM_CLIENT_PRIMARY_CONNECTION
-#define             NM_CLIENT_ACTIVATING_CONNECTION
-enum                NMClientPermission;
-enum                NMClientPermissionResult;
-                    NMClient;
-                    NMClientClass;
-NMClient *          nm_client_new                       (void);
-void                nm_client_new_async                 (GCancellable *cancellable,
-                                                         GAsyncReadyCallback callback,
-                                                         gpointer user_data);
-NMClient *          nm_client_new_finish                (GAsyncResult *result,
-                                                         GError **error);
-const GPtrArray *   nm_client_get_devices               (NMClient *client);
-NMDevice *          nm_client_get_device_by_path        (NMClient *client,
-                                                         const char *object_path);
-NMDevice *          nm_client_get_device_by_iface       (NMClient *client,
-                                                         const char *iface);
-void                (*NMClientActivateFn)               (NMClient *client,
-                                                         NMActiveConnection *active_connection,
-                                                         GError *error,
-                                                         gpointer user_data);
-void                nm_client_activate_connection       (NMClient *client,
-                                                         NMConnection *connection,
-                                                         NMDevice *device,
-                                                         const char *specific_object,
-                                                         NMClientActivateFn callback,
-                                                         gpointer user_data);
-void                (*NMClientAddActivateFn)            (NMClient *client,
-                                                         NMActiveConnection *connection,
-                                                         const char *new_connection_path,
-                                                         GError *error,
-                                                         gpointer user_data);
-void                nm_client_add_and_activate_connection
-                                                        (NMClient *client,
-                                                         NMConnection *partial,
-                                                         NMDevice *device,
-                                                         const char *specific_object,
-                                                         NMClientAddActivateFn callback,
-                                                         gpointer user_data);
-void                nm_client_deactivate_connection     (NMClient *client,
-                                                         NMActiveConnection *active);
-gboolean            nm_client_networking_get_enabled    (NMClient *client);
-void                nm_client_networking_set_enabled    (NMClient *client,
-                                                         gboolean enabled);
-gboolean            nm_client_wireless_get_enabled      (NMClient *client);
-void                nm_client_wireless_set_enabled      (NMClient *client,
-                                                         gboolean enabled);
-gboolean            nm_client_wireless_hardware_get_enabled
-                                                        (NMClient *client);
-gboolean            nm_client_wwan_get_enabled          (NMClient *client);
-void                nm_client_wwan_set_enabled          (NMClient *client,
-                                                         gboolean enabled);
-gboolean            nm_client_wwan_hardware_get_enabled (NMClient *client);
-gboolean            nm_client_wimax_get_enabled         (NMClient *client);
-void                nm_client_wimax_set_enabled         (NMClient *client,
-                                                         gboolean enabled);
-gboolean            nm_client_wimax_hardware_get_enabled
-                                                        (NMClient *client);
-const char *        nm_client_get_version               (NMClient *client);
-NMState             nm_client_get_state                 (NMClient *client);
-gboolean            nm_client_get_manager_running       (NMClient *client);
-const GPtrArray *   nm_client_get_active_connections    (NMClient *client);
-void                nm_client_sleep                     (NMClient *client,
-                                                         gboolean sleep_);
-NMClientPermissionResult nm_client_get_permission_result
-                                                        (NMClient *client,
-                                                         NMClientPermission permission);
-gboolean            nm_client_get_logging               (NMClient *client,
-                                                         char **level,
-                                                         char **domains,
-                                                         GError **error);
-gboolean            nm_client_set_logging               (NMClient *client,
-                                                         const char *level,
-                                                         const char *domains,
-                                                         GError **error);
-NMConnectivityState nm_client_get_connectivity          (NMClient *client);
-NMConnectivityState nm_client_check_connectivity        (NMClient *client,
-                                                         GCancellable *cancellable,
-                                                         GError **error);
-void                nm_client_check_connectivity_async  (NMClient *client,
-                                                         GCancellable *cancellable,
-                                                         GAsyncReadyCallback callback,
-                                                         gpointer user_data);
-NMConnectivityState nm_client_check_connectivity_finish (NMClient *client,
-                                                         GAsyncResult *result,
-                                                         GError **error);
-NMActiveConnection * nm_client_get_primary_connection   (NMClient *client);
-NMActiveConnection * nm_client_get_activating_connection
-                                                        (NMClient *client);
-

Object Hierarchy

-  GObject
-   +----NMObject
-         +----NMClient
-

Implemented Interfaces

-NMClient implements - GInitable and GAsyncInitable.

Functions

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

+NMClient * +	+nm_client_new () +
+void +	+nm_client_new_async () +
+NMClient * +	+nm_client_new_finish () +
const GPtrArray * +	+nm_client_get_devices () +
+NMDevice * +	+nm_client_get_device_by_path () +
+NMDevice * +	+nm_client_get_device_by_iface () +
+void +	+(*NMClientActivateFn) () +
+void +	+nm_client_activate_connection () +
+void +	+(*NMClientAddActivateFn) () +
+void +	+nm_client_add_and_activate_connection () +
+void +	+nm_client_deactivate_connection () +
+gboolean +	+nm_client_networking_get_enabled () +
+void +	+nm_client_networking_set_enabled () +
+gboolean +	+nm_client_wireless_get_enabled () +
+void +	+nm_client_wireless_set_enabled () +
+gboolean +	+nm_client_wireless_hardware_get_enabled () +
+gboolean +	+nm_client_wwan_get_enabled () +
+void +	+nm_client_wwan_set_enabled () +
+gboolean +	+nm_client_wwan_hardware_get_enabled () +
+gboolean +	+nm_client_wimax_get_enabled () +
+void +	+nm_client_wimax_set_enabled () +
+gboolean +	+nm_client_wimax_hardware_get_enabled () +
const char * +	+nm_client_get_version () +
+NMState +	+nm_client_get_state () +
+gboolean +	+nm_client_get_manager_running () +
const GPtrArray * +	+nm_client_get_active_connections () +
+void +	+nm_client_sleep () +
+NMClientPermissionResult +	+nm_client_get_permission_result () +
+gboolean +	+nm_client_get_logging () +
+gboolean +	+nm_client_set_logging () +
+NMConnectivityState +	+nm_client_get_connectivity () +
+NMConnectivityState +	+nm_client_check_connectivity () +
+void +	+nm_client_check_connectivity_async () +
+NMConnectivityState +	+nm_client_check_connectivity_finish () +
+NMActiveConnection * +	+nm_client_get_primary_connection () +
+NMActiveConnection * +	+nm_client_get_activating_connection () +

Properties

-  "activating-connection"    NMActiveConnection*   : Read
-  "active-connections"       NMObjectArray*        : Read
-  "connectivity"             guint                 : Read
-  "manager-running"          gboolean              : Read
-  "networking-enabled"       gboolean              : Read / Write
-  "primary-connection"       NMActiveConnection*   : Read
-  "state"                    guint                 : Read
-  "version"                  gchar*                : Read
-  "wimax-enabled"            gboolean              : Read / Write
-  "wimax-hardware-enabled"   gboolean              : Read
-  "wireless-enabled"         gboolean              : Read / Write
-  "wireless-hardware-enabled" gboolean              : Read
-  "wwan-enabled"             gboolean              : Read / Write
-  "wwan-hardware-enabled"    gboolean              : Read
-

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

+NMActiveConnection *	activating-connection	Read
+NMObjectArray *	active-connections	Read
guint	connectivity	Read
gboolean	manager-running	Read
gboolean	networking-enabled	Read / Write
+NMActiveConnection *	primary-connection	Read
guint	state	Read
+gchar *	version	Read
gboolean	wimax-enabled	Read / Write
gboolean	wimax-hardware-enabled	Read
gboolean	wireless-enabled	Read / Write
gboolean	wireless-hardware-enabled	Read
gboolean	wwan-enabled	Read / Write
gboolean	wwan-hardware-enabled	Read

Signals

-  "device-added"                                   : Run First
-  "device-removed"                                 : Run First
-  "permission-changed"                             : Run First
-

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

void	device-added	Run First
void	device-removed	Run First
void	permission-changed	Run First

Description

Types and Values

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

#define	NM_CLIENT_VERSION
#define	NM_CLIENT_STATE
#define	NM_CLIENT_MANAGER_RUNNING
#define	NM_CLIENT_NETWORKING_ENABLED
#define	NM_CLIENT_WIRELESS_ENABLED
#define	NM_CLIENT_WIRELESS_HARDWARE_ENABLED
#define	NM_CLIENT_WWAN_ENABLED
#define	NM_CLIENT_WWAN_HARDWARE_ENABLED
#define	NM_CLIENT_WIMAX_ENABLED
#define	NM_CLIENT_WIMAX_HARDWARE_ENABLED
#define	NM_CLIENT_ACTIVE_CONNECTIONS
#define	NM_CLIENT_CONNECTIVITY
#define	NM_CLIENT_PRIMARY_CONNECTION
#define	NM_CLIENT_ACTIVATING_CONNECTION
enum	NMClientPermission
enum	NMClientPermissionResult

Details

NM_CLIENT_VERSION

#define NM_CLIENT_VERSION "version"
-

NM_CLIENT_STATE

#define NM_CLIENT_STATE "state"
-

NM_CLIENT_MANAGER_RUNNING

#define NM_CLIENT_MANAGER_RUNNING "manager-running"
-

NM_CLIENT_NETWORKING_ENABLED

#define NM_CLIENT_NETWORKING_ENABLED "networking-enabled" +

Object Hierarchy

    GObject
+    ╰── NMObject
+        ╰── NMClient

NM_CLIENT_WIRELESS_ENABLED

#define NM_CLIENT_WIRELESS_ENABLED "wireless-enabled"
-

NM_CLIENT_WIRELESS_HARDWARE_ENABLED

#define NM_CLIENT_WIRELESS_HARDWARE_ENABLED "wireless-hardware-enabled"
-

Description

NM_CLIENT_WWAN_ENABLED

#define NM_CLIENT_WWAN_ENABLED "wwan-enabled"
-

Functions

nm_client_new ()

NMClient *
+nm_client_new (void);

Creates a new NMClient.

Note that this will do blocking D-Bus calls to initialize the +client. You can use nm_client_new_async() if you want to avoid +that.

NOTE: NMClient provides information about devices and a mechanism to +control them. To access and modify network configuration data, use the +NMRemoteSettings object.

Returns

a new NMClient

NM_CLIENT_WWAN_HARDWARE_ENABLED

#define NM_CLIENT_WWAN_HARDWARE_ENABLED "wwan-hardware-enabled"
-

NM_CLIENT_WIMAX_ENABLED

#define NM_CLIENT_WIMAX_ENABLED "wimax-enabled"
-

nm_client_new_async ()

void
+nm_client_new_async (GCancellable *cancellable,
+                     GAsyncReadyCallback callback,
+                     gpointer user_data);

Creates a new NMClient and begins asynchronously initializing it. +callback + will be called when it is done; use +nm_client_new_finish() to get the result.

NOTE: NMClient provides information about devices and a mechanism to +control them. To access and modify network configuration data, use the +NMRemoteSettings object.

Parameters

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

cancellable	a GCancellable, or `NULL`
callback	callback to call when the client is created
user_data	data for `callback` +

NM_CLIENT_WIMAX_HARDWARE_ENABLED

#define NM_CLIENT_WIMAX_HARDWARE_ENABLED "wimax-hardware-enabled"
-

nm_client_new_finish ()

NMClient *
+nm_client_new_finish (GAsyncResult *result,
+                      GError **error);

Gets the result of an nm_client_new_async() call.

Parameters

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

result	a GAsyncResult
error	location for a GError, or `NULL`

Returns

a new NMClient, or NULL on error

NM_CLIENT_ACTIVE_CONNECTIONS

#define NM_CLIENT_ACTIVE_CONNECTIONS "active-connections"
-

nm_client_get_devices ()

const GPtrArray *
+nm_client_get_devices (NMClient *client);

Gets all the known network devices. Use nm_device_get_type() or the +NM_IS_DEVICE_XXXX() functions to determine what kind of device member of the +returned array is, and then you may use device-specific methods such as +nm_device_ethernet_get_hw_address().

Parameters

+++++ + + + + + +

client

Returns

a GPtrArray +containing all the NMDevices. The returned array is owned by the +NMClient object and should not be modified.

[transfer none][element-type NMClient.Device]

NM_CLIENT_CONNECTIVITY

#define NM_CLIENT_CONNECTIVITY "connectivity"
-

nm_client_get_device_by_path ()

NMDevice *
+nm_client_get_device_by_path (NMClient *client,
+                              const char *object_path);

Gets a NMDevice from a NMClient.

Parameters

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

client	a NMClient
object_path	the object path to search for

Returns

the NMDevice for the given object_path +or NULL if none is found.

[transfer none]

NM_CLIENT_PRIMARY_CONNECTION

#define NM_CLIENT_PRIMARY_CONNECTION "primary-connection"
-

nm_client_get_device_by_iface ()

NMDevice *
+nm_client_get_device_by_iface (NMClient *client,
+                               const char *iface);

Gets a NMDevice from a NMClient.

Parameters

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

client	a NMClient
iface	the interface name to search for

Returns

the NMDevice for the given iface +or NULL if none is found.

[transfer none]

NM_CLIENT_ACTIVATING_CONNECTION

#define NM_CLIENT_ACTIVATING_CONNECTION "activating-connection"
-

NMClientActivateFn ()

void
+(*NMClientActivateFn) (NMClient *client,
+                       NMActiveConnection *active_connection,
+                       GError *error,
+                       gpointer user_data);

enum NMClientPermission

typedef enum {
-	NM_CLIENT_PERMISSION_NONE = 0,
-	NM_CLIENT_PERMISSION_ENABLE_DISABLE_NETWORK = 1,
-	NM_CLIENT_PERMISSION_ENABLE_DISABLE_WIFI = 2,
-	NM_CLIENT_PERMISSION_ENABLE_DISABLE_WWAN = 3,
-	NM_CLIENT_PERMISSION_ENABLE_DISABLE_WIMAX = 4,
-	NM_CLIENT_PERMISSION_SLEEP_WAKE = 5,
-	NM_CLIENT_PERMISSION_NETWORK_CONTROL = 6,
-	NM_CLIENT_PERMISSION_WIFI_SHARE_PROTECTED = 7,
-	NM_CLIENT_PERMISSION_WIFI_SHARE_OPEN = 8,
-	NM_CLIENT_PERMISSION_SETTINGS_MODIFY_SYSTEM = 9,
-	NM_CLIENT_PERMISSION_SETTINGS_MODIFY_OWN = 10,
-	NM_CLIENT_PERMISSION_SETTINGS_MODIFY_HOSTNAME = 11,
-
-	NM_CLIENT_PERMISSION_LAST = NM_CLIENT_PERMISSION_SETTINGS_MODIFY_HOSTNAME
-} NMClientPermission;
-

-NMClientPermission values indicate various permissions that NetworkManager -clients can obtain to perform certain tasks on behalf of the current user. -

nm_client_activate_connection ()

void
+nm_client_activate_connection (NMClient *client,
+                               NMConnection *connection,
+                               NMDevice *device,
+                               const char *specific_object,
+                               NMClientActivateFn callback,
+                               gpointer user_data);

Starts a connection to a particular network using the configuration settings +from connection + and the network device device +. Certain connection types +also take a "specific object" which is the object path of a connection- +specific object, like an NMAccessPoint for WiFi connections, or an +NMWimaxNsp for WiMAX connections, to which you wish to connect. If the +specific object is not given, NetworkManager can, in some cases, automatically +determine which network to connect to given the settings in connection +.

Parameters

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

`NM_CLIENT_PERMISSION_NONE`	unknown or no permission -
`NM_CLIENT_PERMISSION_ENABLE_DISABLE_NETWORK`	controls whether networking - can be globally enabled or disabled -	client	a NMClient
`NM_CLIENT_PERMISSION_ENABLE_DISABLE_WIFI`	controls whether WiFi can be - globally enabled or disabled -	connection	an NMConnection
`NM_CLIENT_PERMISSION_ENABLE_DISABLE_WWAN`	controls whether WWAN (3G) can be - globally enabled or disabled -	device	the NMDevice.	[allow-none]
`NM_CLIENT_PERMISSION_ENABLE_DISABLE_WIMAX`	controls whether WiMAX can be - globally enabled or disabled -	specific_object	the object path of a connection-type-specific +object this activation should use. This parameter is currently ignored for +wired and mobile broadband connections, and the value of `NULL` should be used +(ie, no specific object). For WiFi or WiMAX connections, pass the object +path of a NMAccessPoint or NMWimaxNsp owned by `device` +, which you can +get using `nm_object_get_path()`, and which will be used to complete the +details of the newly added connection.	[allow-none]
`NM_CLIENT_PERMISSION_SLEEP_WAKE`	controls whether the client can ask - NetworkManager to sleep and wake -	callback	the function to call when the call is done.	[scope async][allow-none]
`NM_CLIENT_PERMISSION_NETWORK_CONTROL`	controls whether networking connections - can be started, stopped, and changed -	user_data	user data to pass to the callback function.	[closure]

NMClientAddActivateFn ()

void
+(*NMClientAddActivateFn) (NMClient *client,
+                          NMActiveConnection *connection,
+                          const char *new_connection_path,
+                          GError *error,
+                          gpointer user_data);

nm_client_add_and_activate_connection ()

void
+nm_client_add_and_activate_connection (NMClient *client,
+                                       NMConnection *partial,
+                                       NMDevice *device,
+                                       const char *specific_object,
+                                       NMClientAddActivateFn callback,
+                                       gpointer user_data);

Adds a new connection using the given details (if any) as a template, +automatically filling in missing settings with the capabilities of the +given device and specific object. The new connection is then activated. +Cannot be used for VPN connections at this time.

Parameters

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

`NM_CLIENT_PERMISSION_WIFI_SHARE_PROTECTED`	controls whether a password - protected WiFi hotspot can be created -	client	a NMClient
`NM_CLIENT_PERMISSION_WIFI_SHARE_OPEN`	controls whether an open WiFi hotspot - can be created -	partial	an NMConnection to add; the connection may be +partially filled (or even `NULL`) and will be completed by NetworkManager +using the given `device` +and `specific_object` +before being added.	[allow-none]
`NM_CLIENT_PERMISSION_SETTINGS_MODIFY_SYSTEM`	controls whether connections - that are available to all users can be modified -	device	the NMDevice
`NM_CLIENT_PERMISSION_SETTINGS_MODIFY_OWN`	controls whether connections - owned by the current user can be modified -	specific_object	the object path of a connection-type-specific +object this activation should use. This parameter is currently ignored for +wired and mobile broadband connections, and the value of `NULL` should be used +(ie, no specific object). For WiFi or WiMAX connections, pass the object +path of a NMAccessPoint or NMWimaxNsp owned by `device` +, which you can +get using `nm_object_get_path()`, and which will be used to complete the +details of the newly added connection.	[allow-none]
`NM_CLIENT_PERMISSION_SETTINGS_MODIFY_HOSTNAME`	controls whether the - persistent hostname can be changed -	callback	the function to call when the call is done.	[scope async][allow-none]
`NM_CLIENT_PERMISSION_LAST`	a reserved boundary value -	user_data	user data to pass to the callback function.	[closure]

enum NMClientPermissionResult

typedef enum {
-	NM_CLIENT_PERMISSION_RESULT_UNKNOWN = 0,
-	NM_CLIENT_PERMISSION_RESULT_YES,
-	NM_CLIENT_PERMISSION_RESULT_AUTH,
-	NM_CLIENT_PERMISSION_RESULT_NO
-} NMClientPermissionResult;
-

-NMClientPermissionResult values indicate what authorizations and permissions -the user requires to obtain a given NMClientPermission -

nm_client_deactivate_connection ()

void
+nm_client_deactivate_connection (NMClient *client,
+                                 NMActiveConnection *active);

Deactivates an active NMActiveConnection.

Parameters

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

`NM_CLIENT_PERMISSION_RESULT_UNKNOWN`	unknown or no authorization -	client	a NMClient
`NM_CLIENT_PERMISSION_RESULT_YES`	the permission is available -	active	the NMActiveConnection to deactivate

nm_client_networking_get_enabled ()

gboolean
+nm_client_networking_get_enabled (NMClient *client);

Whether networking is enabled or disabled.

Parameters

+++++ + + + + + +

client

Returns

TRUE if networking is enabled, FALSE if networking is disabled

nm_client_networking_set_enabled ()

void
+nm_client_networking_set_enabled (NMClient *client,
+                                  gboolean enabled);

Enables or disables networking. When networking is disabled, all controlled +interfaces are disconnected and deactivated. When networking is enabled, +all controlled interfaces are available for activation.

Parameters

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

`NM_CLIENT_PERMISSION_RESULT_AUTH`	authorization is necessary before the - permission is available -	client	a NMClient
`NM_CLIENT_PERMISSION_RESULT_NO`	permission to perform the operation is - denied by system policy -	enabled	`TRUE` to set networking enabled, `FALSE` to set networking disabled

NMClient

typedef struct _NMClient NMClient;

nm_client_wireless_get_enabled ()

gboolean
+nm_client_wireless_get_enabled (NMClient *client);

Determines whether the wireless is enabled.

Parameters

+++++ + + + + + +

client

Returns

TRUE if wireless is enabled

NMClientClass

typedef struct {
-	NMObjectClass parent;
-
-	/* Signals */
-	void (*device_added) (NMClient *client, NMDevice *device);
-	void (*device_removed) (NMClient *client, NMDevice *device);
-	void (*permission_changed) (NMClient *client,
-	                            NMClientPermission permission,
-	                            NMClientPermissionResult result);
-
-	/* Padding for future expansion */
-	void (*_reserved1) (void);
-	void (*_reserved2) (void);
-	void (*_reserved3) (void);
-	void (*_reserved4) (void);
-	void (*_reserved5) (void);
-	void (*_reserved6) (void);
-} NMClientClass;
-

nm_client_wireless_set_enabled ()

void
+nm_client_wireless_set_enabled (NMClient *client,
+                                gboolean enabled);

Enables or disables wireless devices.

Parameters

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

client	a NMClient
enabled	`TRUE` to enable wireless

nm_client_new ()

NMClient *          nm_client_new                       (void);

-Creates a new NMClient. -

-Note that this will do blocking D-Bus calls to initialize the -client. You can use nm_client_new_async() if you want to avoid -that. -

-NOTE: NMClient provides information about devices and a mechanism to -control them. To access and modify network configuration data, use the -NMRemoteSettings object. -

nm_client_wireless_hardware_get_enabled ()

gboolean
+nm_client_wireless_hardware_get_enabled
+                               (NMClient *client);

Determines whether the wireless hardware is enabled.

Parameters

--+++ - - + + +

Returns :

a new NMClient -

client

Returns

TRUE if the wireless hardware is enabled

nm_client_new_async ()

void                nm_client_new_async                 (GCancellable *cancellable,
-                                                         GAsyncReadyCallback callback,
-                                                         gpointer user_data);

-Creates a new NMClient and begins asynchronously initializing it. -callback will be called when it is done; use -nm_client_new_finish() to get the result. -

-NOTE: NMClient provides information about devices and a mechanism to -control them. To access and modify network configuration data, use the -NMRemoteSettings object. -

nm_client_wwan_get_enabled ()

gboolean
+nm_client_wwan_get_enabled (NMClient *client);

Determines whether WWAN is enabled.

Parameters

+++++ + + + + + +

client

Returns

TRUE if WWAN is enabled

nm_client_wwan_set_enabled ()

void
+nm_client_wwan_set_enabled (NMClient *client,
+                            gboolean enabled);

Enables or disables WWAN devices.

Parameters

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

`cancellable` :	a GCancellable, or `NULL` -	client	a NMClient
`callback` :	callback to call when the client is created	enabled	`TRUE` to enable WWAN

nm_client_wwan_hardware_get_enabled ()

gboolean
+nm_client_wwan_hardware_get_enabled (NMClient *client);

Determines whether the WWAN hardware is enabled.

Parameters

+++++ + + + + + +

client

Returns

TRUE if the WWAN hardware is enabled

nm_client_wimax_get_enabled ()

gboolean
+nm_client_wimax_get_enabled (NMClient *client);

Determines whether WiMAX is enabled.

Parameters

+++++ + + + + + +

client

Returns

TRUE if WiMAX is enabled

nm_client_wimax_set_enabled ()

void
+nm_client_wimax_set_enabled (NMClient *client,
+                             gboolean enabled);

Enables or disables WiMAX devices.

Parameters

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

`user_data` :	data for `callback` -	client	a NMClient
enabled	`TRUE` to enable WiMAX

nm_client_wimax_hardware_get_enabled ()

gboolean
+nm_client_wimax_hardware_get_enabled (NMClient *client);

Determines whether the WiMAX hardware is enabled.

Parameters

+++++ + + + + + +

client

Returns

TRUE if the WiMAX hardware is enabled

nm_client_get_version ()

const char *
+nm_client_get_version (NMClient *client);

Gets NetworkManager version.

Parameters

+++++ + + + + + +

client

Returns

string with the version

nm_client_get_state ()

NMState
+nm_client_get_state (NMClient *client);

Gets the current daemon state.

Parameters

+++++ + + + + + +

client

Returns

the current NMState

nm_client_new_finish ()

NMClient *          nm_client_new_finish                (GAsyncResult *result,
-                                                         GError **error);

-Gets the result of an nm_client_new_async() call. -

nm_client_get_manager_running ()

gboolean
+nm_client_get_manager_running (NMClient *client);

Determines whether the daemon is running.

Parameters

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

`result` :	a GAsyncResult -
`error` :	location for a GError, or `NULL` -
Returns :	a new NMClient, or `NULL` on error
client	a NMClient

Returns

TRUE if the daemon is running

nm_client_get_devices ()

const GPtrArray *   nm_client_get_devices               (NMClient *client);

-Gets all the known network devices. Use nm_device_get_type() or the -NM_IS_DEVICE_XXXX() functions to determine what kind of device member of the -returned array is, and then you may use device-specific methods such as -nm_device_ethernet_get_hw_address(). -

nm_client_get_active_connections ()

const GPtrArray *
+nm_client_get_active_connections (NMClient *client);

Gets the active connections.

Parameters

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

`client` :	a NMClient -
Returns :	a GPtrArray -containing all the NMDevices. The returned array is owned by the -NMClient object and should not be modified. [transfer none][element-type NMClient.Device] -
client	a NMClient

Returns

a GPtrArray +containing all the active NMActiveConnections. +The returned array is owned by the client and should not be modified.

[transfer none][element-type NMClient.ActiveConnection]

nm_client_get_device_by_path ()

NMDevice *          nm_client_get_device_by_path        (NMClient *client,
-                                                         const char *object_path);

-Gets a NMDevice from a NMClient. -

nm_client_sleep ()

void
+nm_client_sleep (NMClient *client,
+                 gboolean sleep_);

Deprecated; use nm_client_networking_set_enabled() instead.

Parameters

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

`client` :	a NMClient -
`object_path` :	the object path to search for	client	a NMClient
Returns :	the NMDevice for the given `object_path` or `NULL` if none is found. [transfer none] -	sleep_	`TRUE` to put the daemon to sleep

nm_client_get_device_by_iface ()

NMDevice *          nm_client_get_device_by_iface       (NMClient *client,
-                                                         const char *iface);

-Gets a NMDevice from a NMClient. -

nm_client_get_permission_result ()

NMClientPermissionResult
+nm_client_get_permission_result (NMClient *client,
+                                 NMClientPermission permission);

Requests the result of a specific permission, which indicates whether the +client can or cannot perform the action the permission represents

Parameters

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

`client` :	a NMClient -
`iface` :	the interface name to search for	client	a NMClient
Returns :	the NMDevice for the given `iface` or `NULL` if none is found. [transfer none] -	permission	the permission for which to return the result, one of NMClientPermission

NMClientActivateFn ()

void                (*NMClientActivateFn)               (NMClient *client,
-                                                         NMActiveConnection *active_connection,
-                                                         GError *error,
-                                                         gpointer user_data);

Returns

the permission's result, one of NMClientPermissionResult

nm_client_activate_connection ()

void                nm_client_activate_connection       (NMClient *client,
-                                                         NMConnection *connection,
-                                                         NMDevice *device,
-                                                         const char *specific_object,
-                                                         NMClientActivateFn callback,
-                                                         gpointer user_data);

-Starts a connection to a particular network using the configuration settings -from connection and the network device device. Certain connection types -also take a "specific object" which is the object path of a connection- -specific object, like an NMAccessPoint for WiFi connections, or an -NMWimaxNsp for WiMAX connections, to which you wish to connect. If the -specific object is not given, NetworkManager can, in some cases, automatically -determine which network to connect to given the settings in connection. -

nm_client_get_logging ()

gboolean
+nm_client_get_logging (NMClient *client,
+                       char **level,
+                       char **domains,
+                       GError **error);

Gets NetworkManager current logging level and domains.

Parameters

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

`client` :	a NMClient -
`connection` :	an NMConnection -
`device` :	the NMDevice. [allow-none] -	client	a NMClient
`specific_object` :	the object path of a connection-type-specific -object this activation should use. This parameter is currently ignored for -wired and mobile broadband connections, and the value of `NULL` should be used -(ie, no specific object). For WiFi or WiMAX connections, pass the object -path of a NMAccessPoint or NMWimaxNsp owned by `device`, which you can -get using `nm_object_get_path()`, and which will be used to complete the -details of the newly added connection. [allow-none] -	level	return location for logging level string.	[allow-none]
`callback` :	the function to call when the call is done. [scope async][allow-none] -	domains	return location for log domains string. The string is +a list of domains separated by ",".	[allow-none]
`user_data` :	user data to pass to the callback function. [closure] -	error	return location for a GError, or `NULL`.	[allow-none]

NMClientAddActivateFn ()

void                (*NMClientAddActivateFn)            (NMClient *client,
-                                                         NMActiveConnection *connection,
-                                                         const char *new_connection_path,
-                                                         GError *error,
-                                                         gpointer user_data);

Returns

TRUE on success, FALSE otherwise

Since 0.9.8

nm_client_add_and_activate_connection ()

void                nm_client_add_and_activate_connection
-                                                        (NMClient *client,
-                                                         NMConnection *partial,
-                                                         NMDevice *device,
-                                                         const char *specific_object,
-                                                         NMClientAddActivateFn callback,
-                                                         gpointer user_data);

-Adds a new connection using the given details (if any) as a template, -automatically filling in missing settings with the capabilities of the -given device and specific object. The new connection is then activated. -Cannot be used for VPN connections at this time. -

nm_client_set_logging ()

gboolean
+nm_client_set_logging (NMClient *client,
+                       const char *level,
+                       const char *domains,
+                       GError **error);

Sets NetworkManager logging level and/or domains.

Parameters

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

`client` :	a NMClient -
`partial` :	an NMConnection to add; the connection may be -partially filled (or even `NULL`) and will be completed by NetworkManager -using the given `device` and `specific_object` before being added. [allow-none] -
`device` :	the NMDevice -	client	a NMClient
`specific_object` :	the object path of a connection-type-specific -object this activation should use. This parameter is currently ignored for -wired and mobile broadband connections, and the value of `NULL` should be used -(ie, no specific object). For WiFi or WiMAX connections, pass the object -path of a NMAccessPoint or NMWimaxNsp owned by `device`, which you can -get using `nm_object_get_path()`, and which will be used to complete the -details of the newly added connection. [allow-none] -	level	logging level to set (`NULL` or an empty string for no change).	[allow-none]
`callback` :	the function to call when the call is done. [scope async][allow-none] -	domains	logging domains to set. The string should be a list of log +domains separated by ",". (`NULL` or an empty string for no change).	[allow-none]
`user_data` :	user data to pass to the callback function. [closure] -	error	return location for a GError, or `NULL`.	[allow-none]

Returns

TRUE on success, FALSE otherwise

Since 0.9.8

nm_client_deactivate_connection ()

void                nm_client_deactivate_connection     (NMClient *client,
-                                                         NMActiveConnection *active);

-Deactivates an active NMActiveConnection. -

nm_client_get_connectivity ()

NMConnectivityState
+nm_client_get_connectivity (NMClient *client);

Gets the current network connectivity state. Contrast +nm_client_check_connectivity() and +nm_client_check_connectivity_async(), which re-check the +connectivity state first before returning any information.

Parameters

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

`client` :	a NMClient -
`active` :	the NMActiveConnection to deactivate
client	an NMClient

Returns

the current connectivity state

Since 0.9.8.4

nm_client_networking_get_enabled ()

gboolean            nm_client_networking_get_enabled    (NMClient *client);

-Whether networking is enabled or disabled. -

nm_client_check_connectivity ()

NMConnectivityState
+nm_client_check_connectivity (NMClient *client,
+                              GCancellable *cancellable,
+                              GError **error);

Updates the network connectivity state and returns the (new) +current state. Contrast nm_client_get_connectivity(), which returns +the most recent known state without re-checking.

This is a blocking call; use nm_client_check_connectivity_async() +if you do not want to block.

Parameters

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

`client` :	a NMClient -
Returns :	-`TRUE` if networking is enabled, `FALSE` if networking is disabled	client	an NMClient

nm_client_networking_set_enabled ()

void                nm_client_networking_set_enabled    (NMClient *client,
-                                                         gboolean enabled);

-Enables or disables networking. When networking is disabled, all controlled -interfaces are disconnected and deactivated. When networking is enabled, -all controlled interfaces are available for activation. -

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

`client` :	a NMClient -	cancellable	a GCancellable
`enabled` :	-`TRUE` to set networking enabled, `FALSE` to set networking disabled	error	return location for a GError

Returns

the (new) current connectivity state

Since 0.9.8.4

nm_client_wireless_get_enabled ()

gboolean            nm_client_wireless_get_enabled      (NMClient *client);

-Determines whether the wireless is enabled. -

nm_client_check_connectivity_async ()

void
+nm_client_check_connectivity_async (NMClient *client,
+                                    GCancellable *cancellable,
+                                    GAsyncReadyCallback callback,
+                                    gpointer user_data);

Asynchronously updates the network connectivity state and invokes +callback + when complete. Contrast nm_client_get_connectivity(), +which (immediately) returns the most recent known state without +re-checking, and nm_client_check_connectivity(), which blocks.

Parameters

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

`client` :	a NMClient -	client	an NMClient
Returns :	-`TRUE` if wireless is enabled	cancellable	a GCancellable

nm_client_wireless_set_enabled ()

void                nm_client_wireless_set_enabled      (NMClient *client,
-                                                         gboolean enabled);

-Enables or disables wireless devices. -

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

`client` :	a NMClient -	callback	callback to call with the result
`enabled` :	-`TRUE` to enable wireless	user_data	data for `callback` +.

Since 0.9.8.4

nm_client_wireless_hardware_get_enabled ()

gboolean            nm_client_wireless_hardware_get_enabled
-                                                        (NMClient *client);

-Determines whether the wireless hardware is enabled. -

nm_client_check_connectivity_finish ()

NMConnectivityState
+nm_client_check_connectivity_finish (NMClient *client,
+                                     GAsyncResult *result,
+                                     GError **error);

Retrieves the result of an nm_client_check_connectivity_async() +call.

Parameters

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

`client` :	a NMClient -
Returns :	-`TRUE` if the wireless hardware is enabled	client	an NMClient

nm_client_wwan_get_enabled ()

gboolean            nm_client_wwan_get_enabled          (NMClient *client);

-Determines whether WWAN is enabled. -

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

`client` :	a NMClient -	result	the GAsyncResult
Returns :	-`TRUE` if WWAN is enabled	error	return location for a GError

Returns

the (new) current connectivity state

Since 0.9.8.4

nm_client_wwan_set_enabled ()

void                nm_client_wwan_set_enabled          (NMClient *client,
-                                                         gboolean enabled);

-Enables or disables WWAN devices. -

nm_client_get_primary_connection ()

NMActiveConnection *
+nm_client_get_primary_connection (NMClient *client);

Gets the NMActiveConnection corresponding to the primary active +network device.

In particular, when there is no VPN active, or the VPN does not +have the default route, this returns the active connection that has +the default route. If there is a VPN active with the default route, +then this function returns the active connection that contains the +route to the VPN endpoint.

If there is no default route, or the default route is over a +non-NetworkManager-recognized device, this will return NULL.

Parameters

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

`client` :	a NMClient -
`enabled` :	-`TRUE` to enable WWAN
client	an NMClient

Returns

the appropriate NMActiveConnection, if +any.

[transfer none]

Since 0.9.8.4

nm_client_wwan_hardware_get_enabled ()

gboolean            nm_client_wwan_hardware_get_enabled (NMClient *client);

-Determines whether the WWAN hardware is enabled. -

nm_client_get_activating_connection ()

NMActiveConnection *
+nm_client_get_activating_connection (NMClient *client);

Gets the NMActiveConnection corresponding to a +currently-activating connection that is expected to become the new +“primary-connection” upon successful activation.

Parameters

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

`client` :	a NMClient -
Returns :	-`TRUE` if the WWAN hardware is enabled
client	an NMClient

Returns

the appropriate NMActiveConnection, if +any.

[transfer none]

Since 0.9.8.4

+ + +

Types and Values

nm_client_wimax_get_enabled ()

gboolean            nm_client_wimax_get_enabled         (NMClient *client);

NM_CLIENT_VERSION

#define NM_CLIENT_VERSION "version"
+

-Determines whether WiMAX is enabled.

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

`client` :	a NMClient -
Returns :	-`TRUE` if WiMAX is enabled

nm_client_wimax_set_enabled ()

void                nm_client_wimax_set_enabled         (NMClient *client,
-                                                         gboolean enabled);

NM_CLIENT_STATE

#define NM_CLIENT_STATE "state"
+

-Enables or disables WiMAX devices.

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

`client` :	a NMClient -
`enabled` :	-`TRUE` to enable WiMAX

nm_client_wimax_hardware_get_enabled ()

gboolean            nm_client_wimax_hardware_get_enabled
-                                                        (NMClient *client);

NM_CLIENT_MANAGER_RUNNING

#define NM_CLIENT_MANAGER_RUNNING "manager-running"
+

-Determines whether the WiMAX hardware is enabled.

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

`client` :	a NMClient -
Returns :	-`TRUE` if the WiMAX hardware is enabled

nm_client_get_version ()

const char *        nm_client_get_version               (NMClient *client);

NM_CLIENT_NETWORKING_ENABLED

#define NM_CLIENT_NETWORKING_ENABLED "networking-enabled"
+

-Gets NetworkManager version.

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

`client` :	a NMClient -
Returns :	string with the version

nm_client_get_state ()

NMState             nm_client_get_state                 (NMClient *client);

NM_CLIENT_WIRELESS_ENABLED

#define NM_CLIENT_WIRELESS_ENABLED "wireless-enabled"
+

-Gets the current daemon state.

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

`client` :	a NMClient -
Returns :	the current `NMState` -

nm_client_get_manager_running ()

gboolean            nm_client_get_manager_running       (NMClient *client);

NM_CLIENT_WIRELESS_HARDWARE_ENABLED

#define NM_CLIENT_WIRELESS_HARDWARE_ENABLED "wireless-hardware-enabled"
+

-Determines whether the daemon is running.

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

`client` :	a NMClient -
Returns :	-`TRUE` if the daemon is running

nm_client_get_active_connections ()

const GPtrArray *   nm_client_get_active_connections    (NMClient *client);

NM_CLIENT_WWAN_ENABLED

#define NM_CLIENT_WWAN_ENABLED "wwan-enabled"
+

-Gets the active connections.

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

`client` :	a NMClient -
Returns :	a GPtrArray -containing all the active NMActiveConnections. -The returned array is owned by the client and should not be modified. [transfer none][element-type NMClient.ActiveConnection] -

nm_client_sleep ()

void                nm_client_sleep                     (NMClient *client,
-                                                         gboolean sleep_);

NM_CLIENT_WWAN_HARDWARE_ENABLED

#define NM_CLIENT_WWAN_HARDWARE_ENABLED "wwan-hardware-enabled"
+

-Deprecated; use nm_client_networking_set_enabled() instead.

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

`client` :	a NMClient -
`sleep_` :	-`TRUE` to put the daemon to sleep

nm_client_get_permission_result ()

NMClientPermissionResult nm_client_get_permission_result
-                                                        (NMClient *client,
-                                                         NMClientPermission permission);

NM_CLIENT_WIMAX_ENABLED

#define NM_CLIENT_WIMAX_ENABLED "wimax-enabled"
+

-Requests the result of a specific permission, which indicates whether the -client can or cannot perform the action the permission represents

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

`client` :	a NMClient -
`permission` :	the permission for which to return the result, one of NMClientPermission -
Returns :	the permission's result, one of NMClientPermissionResult -

nm_client_get_logging ()

gboolean            nm_client_get_logging               (NMClient *client,
-                                                         char **level,
-                                                         char **domains,
-                                                         GError **error);

NM_CLIENT_WIMAX_HARDWARE_ENABLED

#define NM_CLIENT_WIMAX_HARDWARE_ENABLED "wimax-hardware-enabled"
+

-Gets NetworkManager current logging level and domains.

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

`client` :	a NMClient -
`level` :	return location for logging level string. [allow-none] -
`domains` :	return location for log domains string. The string is -a list of domains separated by ",". [allow-none] -
`error` :	return location for a GError, or `NULL`. [allow-none] -
Returns :	-`TRUE` on success, `FALSE` otherwise

Since 0.9.8

nm_client_set_logging ()

gboolean            nm_client_set_logging               (NMClient *client,
-                                                         const char *level,
-                                                         const char *domains,
-                                                         GError **error);

NM_CLIENT_ACTIVE_CONNECTIONS

#define NM_CLIENT_ACTIVE_CONNECTIONS "active-connections"
+

-Sets NetworkManager logging level and/or domains.

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

`client` :	a NMClient -
`level` :	logging level to set (`NULL` or an empty string for no change). [allow-none] -
`domains` :	logging domains to set. The string should be a list of log -domains separated by ",". (`NULL` or an empty string for no change). [allow-none] -
`error` :	return location for a GError, or `NULL`. [allow-none] -
Returns :	-`TRUE` on success, `FALSE` otherwise

Since 0.9.8

nm_client_get_connectivity ()

NMConnectivityState nm_client_get_connectivity          (NMClient *client);

NM_CLIENT_CONNECTIVITY

#define NM_CLIENT_CONNECTIVITY "connectivity"
+

-Gets the current network connectivity state. Contrast -nm_client_check_connectivity() and -nm_client_check_connectivity_async(), which re-check the -connectivity state first before returning any information.

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

`client` :	an NMClient -
Returns :	the current connectivity state

Since 0.9.8.4

nm_client_check_connectivity ()

NMConnectivityState nm_client_check_connectivity        (NMClient *client,
-                                                         GCancellable *cancellable,
-                                                         GError **error);

NM_CLIENT_PRIMARY_CONNECTION

#define NM_CLIENT_PRIMARY_CONNECTION "primary-connection"
+

-Updates the network connectivity state and returns the (new) -current state. Contrast nm_client_get_connectivity(), which returns -the most recent known state without re-checking.

NM_CLIENT_ACTIVATING_CONNECTION

#define NM_CLIENT_ACTIVATING_CONNECTION "activating-connection"
+

-This is a blocking call; use nm_client_check_connectivity_async() -if you do not want to block.

+ +

enum NMClientPermission

NMClientPermission values indicate various permissions that NetworkManager +clients can obtain to perform certain tasks on behalf of the current user.

Members

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

`client` :	an NMClient +	NM_CLIENT_PERMISSION_NONE	+ unknown or no permission
`cancellable` :	a GCancellable +	NM_CLIENT_PERMISSION_ENABLE_DISABLE_NETWORK	+ controls whether networking + can be globally enabled or disabled
`error` :	return location for a GError +	NM_CLIENT_PERMISSION_ENABLE_DISABLE_WIFI	+ controls whether WiFi can be + globally enabled or disabled
Returns :	the (new) current connectivity state	NM_CLIENT_PERMISSION_ENABLE_DISABLE_WWAN	+ controls whether WWAN (3G) can be + globally enabled or disabled +
NM_CLIENT_PERMISSION_ENABLE_DISABLE_WIMAX	+ controls whether WiMAX can be + globally enabled or disabled +

Since 0.9.8.4

nm_client_check_connectivity_async ()

void                nm_client_check_connectivity_async  (NMClient *client,
-                                                         GCancellable *cancellable,
-                                                         GAsyncReadyCallback callback,
-                                                         gpointer user_data);

-Asynchronously updates the network connectivity state and invokes -callback when complete. Contrast nm_client_get_connectivity(), -which (immediately) returns the most recent known state without -re-checking, and nm_client_check_connectivity(), which blocks. -

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

`client` :	an NMClient +	NM_CLIENT_PERMISSION_SLEEP_WAKE	+ controls whether the client can ask + NetworkManager to sleep and wake
`cancellable` :	a GCancellable +	NM_CLIENT_PERMISSION_NETWORK_CONTROL	+ controls whether networking connections + can be started, stopped, and changed
`callback` :	callback to call with the result	NM_CLIENT_PERMISSION_WIFI_SHARE_PROTECTED	+ controls whether a password + protected WiFi hotspot can be created +
`user_data` :	data for `callback`.	NM_CLIENT_PERMISSION_WIFI_SHARE_OPEN	+ controls whether an open WiFi hotspot + can be created +

Since 0.9.8.4

nm_client_check_connectivity_finish ()

NMConnectivityState nm_client_check_connectivity_finish (NMClient *client,
-                                                         GAsyncResult *result,
-                                                         GError **error);

-Retrieves the result of an nm_client_check_connectivity_async() -call. -

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

`client` :	an NMClient +	NM_CLIENT_PERMISSION_SETTINGS_MODIFY_SYSTEM	+ controls whether connections + that are available to all users can be modified
`result` :	the GAsyncResult +	NM_CLIENT_PERMISSION_SETTINGS_MODIFY_OWN	+ controls whether connections + owned by the current user can be modified
`error` :	return location for a GError +	NM_CLIENT_PERMISSION_SETTINGS_MODIFY_HOSTNAME	+ controls whether the + persistent hostname can be changed
Returns :	the (new) current connectivity state	NM_CLIENT_PERMISSION_LAST	+ a reserved boundary value +

Since 0.9.8.4

nm_client_get_primary_connection ()

NMActiveConnection * nm_client_get_primary_connection   (NMClient *client);

-Gets the NMActiveConnection corresponding to the primary active -network device. -

-In particular, when there is no VPN active, or the VPN does not -have the default route, this returns the active connection that has -the default route. If there is a VPN active with the default route, -then this function returns the active connection that contains the -route to the VPN endpoint. -

-If there is no default route, or the default route is over a -non-NetworkManager-recognized device, this will return NULL. -

enum NMClientPermissionResult

NMClientPermissionResult values indicate what authorizations and permissions +the user requires to obtain a given NMClientPermission

Members

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

`client` :	an NMClient +	NM_CLIENT_PERMISSION_RESULT_UNKNOWN	+ unknown or no authorization
Returns :	the appropriate NMActiveConnection, if -any. [transfer none] +	NM_CLIENT_PERMISSION_RESULT_YES	+ the permission is available

Since 0.9.8.4

nm_client_get_activating_connection ()

NMActiveConnection * nm_client_get_activating_connection
-                                                        (NMClient *client);

-Gets the NMActiveConnection corresponding to a -currently-activating connection that is expected to become the new -"primary-connection" upon successful activation. -

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

`client` :	an NMClient +	NM_CLIENT_PERMISSION_RESULT_AUTH	+ authorization is necessary before the + permission is available
Returns :	the appropriate NMActiveConnection, if -any. [transfer none] +	NM_CLIENT_PERMISSION_RESULT_NO	+ permission to perform the operation is + denied by system policy

Since 0.9.8.4

Property Details

The `"activating-connection"` property

  "activating-connection"    NMActiveConnection*   : Read

-The NMActiveConnection of the activating connection that is -likely to become the new "primary-connection". -

The `“activating-connection”` property

  “activating-connection”    NMActiveConnection *

Activating connection.

Flags: Read

Since 0.9.8.4

The `"active-connections"` property

  "active-connections"       NMObjectArray*        : Read

The `“active-connections”` property

  “active-connections”       NMObjectArray *

Active connections.

Flags: Read

The `"connectivity"` property

  "connectivity"             guint                 : Read

-The network connectivity state. -

The `“connectivity”` property

  “connectivity”             guint

Connectivity state.

Flags: Read

Allowed values: <= 4

Default value: 0

Since 0.9.8.4

The `"manager-running"` property

  "manager-running"          gboolean              : Read

The `“manager-running”` property

  “manager-running”          gboolean

Whether NetworkManager is running.

Flags: Read

Default value: FALSE

The `"networking-enabled"` property

  "networking-enabled"       gboolean              : Read / Write

The `“networking-enabled”` property

  “networking-enabled”       gboolean

Is networking enabled.

Flags: Read / Write

Default value: TRUE

The `"primary-connection"` property

  "primary-connection"       NMActiveConnection*   : Read

-The NMActiveConnection of the device with the default route; -see nm_client_get_primary_connection() for more details. -

The `“primary-connection”` property

  “primary-connection”       NMActiveConnection *

Primary connection.

Flags: Read

Since 0.9.8.4

The `"state"` property

  "state"                    guint                 : Read

-The current daemon state. -

The `“state”` property

  “state”                    guint

NetworkManager state.

Flags: Read

Allowed values: <= 70

Default value: 0

The `"version"` property

  "version"                  gchar*                : Read

-The NetworkManager version. -

The `“version”` property

  “version”                  gchar *

NetworkManager version.

Flags: Read

Default value: NULL

The `"wimax-enabled"` property

  "wimax-enabled"            gboolean              : Read / Write

The `“wimax-enabled”` property

  “wimax-enabled”            gboolean

Is WiMAX enabled.

Flags: Read / Write

Default value: FALSE

The `"wimax-hardware-enabled"` property

  "wimax-hardware-enabled"   gboolean              : Read

The `“wimax-hardware-enabled”` property

  “wimax-hardware-enabled”   gboolean

Is WiMAX hardware enabled.

Flags: Read

Default value: FALSE

The `"wireless-enabled"` property

  "wireless-enabled"         gboolean              : Read / Write

The `“wireless-enabled”` property

  “wireless-enabled”         gboolean

Is wireless enabled.

Flags: Read / Write

Default value: FALSE

The `"wireless-hardware-enabled"` property

  "wireless-hardware-enabled" gboolean              : Read

The `“wireless-hardware-enabled”` property

  “wireless-hardware-enabled” gboolean

Is wireless hardware enabled.

Flags: Read

Default value: TRUE

The `"wwan-enabled"` property

  "wwan-enabled"             gboolean              : Read / Write

The `“wwan-enabled”` property

  “wwan-enabled”             gboolean

Is WWAN enabled.

Flags: Read / Write

Default value: FALSE

The `"wwan-hardware-enabled"` property

  "wwan-hardware-enabled"    gboolean              : Read

The `“wwan-hardware-enabled”` property

  “wwan-hardware-enabled”    gboolean

Is WWAN hardware enabled.

Flags: Read

Default value: FALSE

Signal Details

The `"device-added"` signal

void                user_function                      (NMClient *client,
-                                                        GObject  *device,
-                                                        gpointer  user_data)      : Run First

-Notifies that a NMDevice is added. -

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

`client` :	the client that received the signal
`device` :	the new device. [type NMClient.Device] -
`user_data` :	user data set when the signal handler was connected.

The `“device-added”` signal

void
+user_function (NMClient *client,
+               GObject  *device,
+               gpointer  user_data)

Flags: Run First

The `"device-removed"` signal

void                user_function                      (NMClient *client,
-                                                        GObject  *device,
-                                                        gpointer  user_data)      : Run First

-Notifies that a NMDevice is removed. -

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

`client` :	the client that received the signal
`device` :	the removed device. [type NMClient.Device] -
`user_data` :	user data set when the signal handler was connected.

The `“device-removed”` signal

void
+user_function (NMClient *client,
+               GObject  *device,
+               gpointer  user_data)

Flags: Run First

The `"permission-changed"` signal

void                user_function                      (NMClient *client,
-                                                        guint     permission,
-                                                        guint     result,
-                                                        gpointer  user_data)       : Run First

-Notifies that a permission has changed -

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

`client` :	the client that received the signal
`permission` :	a permission from NMClientPermission -
`result` :	the permission's result, one of NMClientPermissionResult -
`user_data` :	user data set when the signal handler was connected.

The `“permission-changed”` signal

void
+user_function (NMClient *client,
+               guint     permission,
+               guint     result,
+               gpointer  user_data)

Flags: Run First

+ Generated by GTK-Doc V1.20 \ No newline at end of file diff --git a/docs/libnm-glib/html/NMDHCP4Config.html b/docs/libnm-glib/html/NMDHCP4Config.html index aff13165..5809f4b7 100644 --- a/docs/libnm-glib/html/NMDHCP4Config.html +++ b/docs/libnm-glib/html/NMDHCP4Config.html @@ -2,36 +2,28 @@ -NMDHCP4Config +libnm-glib Reference Manual: NMDHCP4Config - + - - - - - - - - - -

			libnm-glib Reference Manual
-Top - \| - Description - \| - Object Hierarchy - \| - Implemented Interfaces - \| - Properties -

+ + + + + + +

@@ -39,38 +31,76 @@

NMDHCP4Config

- +

Synopsis

                    NMDHCP4Config;
-                    NMDHCP4ConfigClass;
-#define             NM_DHCP4_CONFIG_OPTIONS
-GObject *           nm_dhcp4_config_new                 (DBusGConnection *connection,
-                                                         const char *object_path);
-GHashTable *        nm_dhcp4_config_get_options         (NMDHCP4Config *config);
-const char *        nm_dhcp4_config_get_one_option      (NMDHCP4Config *config,
-                                                         const char *option);
-

Functions

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

+GObject * +	+nm_dhcp4_config_new () +
+GHashTable * +	+nm_dhcp4_config_get_options () +
const char * +	+nm_dhcp4_config_get_one_option () +

Object Hierarchy

-  GObject
-   +----NMObject
-         +----NMDHCP4Config
-

Properties

+++++ + + + + + +

+GHashTable *

options

Read

Implemented Interfaces

-NMDHCP4Config implements - GInitable and GAsyncInitable.

Types and Values

++++ + + + + +

#define

NM_DHCP4_CONFIG_OPTIONS

Properties

-  "options"                  GHashTable*           : Read
+Object Hierarchy
+    GObject
+    ╰── NMObject
+        ╰── NMDHCP4Config

@@ -79,145 +109,128 @@ NMDHCP4Config implements

Details

NMDHCP4Config

typedef struct _NMDHCP4Config NMDHCP4Config;

NMDHCP4ConfigClass

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

NM_DHCP4_CONFIG_OPTIONS

#define NM_DHCP4_CONFIG_OPTIONS "options"
-

Functions

nm_dhcp4_config_new ()

GObject *           nm_dhcp4_config_new                 (DBusGConnection *connection,
-                                                         const char *object_path);

-Creates a new NMDHCP4Config. -

nm_dhcp4_config_new ()

GObject *
+nm_dhcp4_config_new (DBusGConnection *connection,
+                     const char *object_path);

Creates a new NMDHCP4Config.

Parameters

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

`connection` :	the DBusGConnection -	connection	the DBusGConnection
`object_path` :	the DBus object path of the device
Returns :	a new configuration. [transfer full] -	object_path	the DBus object path of the device

Returns

a new configuration.

[transfer full]

nm_dhcp4_config_get_options ()

GHashTable *        nm_dhcp4_config_get_options         (NMDHCP4Config *config);

-Gets all the options contained in the configuration. -

nm_dhcp4_config_get_options ()

GHashTable *
+nm_dhcp4_config_get_options (NMDHCP4Config *config);

Gets all the options contained in the configuration.

Parameters

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

`config` :	a NMDHCP4Config -
Returns :	the GHashTable containing strings for keys and values. -This is the internal copy used by the configuration, and must not be modified. [transfer none][element-type utf8 GObject.Value] -
config	a NMDHCP4Config

Returns

the GHashTable containing strings for keys and values. +This is the internal copy used by the configuration, and must not be modified.

[transfer none][element-type utf8 GObject.Value]

nm_dhcp4_config_get_one_option ()

const char *        nm_dhcp4_config_get_one_option      (NMDHCP4Config *config,
-                                                         const char *option);

-Gets one option by option name. -

nm_dhcp4_config_get_one_option ()

const char *
+nm_dhcp4_config_get_one_option (NMDHCP4Config *config,
+                                const char *option);

Gets one option by option name.

Parameters

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

`config` :	a NMDHCP4Config -
`option` :	the option to retrieve	config	a NMDHCP4Config
Returns :	the configuration option's value. This is the internal string used by the -configuration, and must not be modified.	option	the option to retrieve

Returns

the configuration option's value. This is the internal string used by the +configuration, and must not be modified.

Property Details

Types and Values

The `"options"` property

  "options"                  GHashTable*           : Read

-The GHashTable containing options of the configuration. -

NM_DHCP4_CONFIG_OPTIONS

#define NM_DHCP4_CONFIG_OPTIONS "options"
+

-Type: GLib.HashTable(utf8,GObject.Value)

Property Details

The `“options”` property

  “options”                  GHashTable *

Options.

Flags: Read

+ Generated by GTK-Doc V1.20 \ No newline at end of file diff --git a/docs/libnm-glib/html/NMDHCP6Config.html b/docs/libnm-glib/html/NMDHCP6Config.html index cc5b4931..6d0c04f6 100644 --- a/docs/libnm-glib/html/NMDHCP6Config.html +++ b/docs/libnm-glib/html/NMDHCP6Config.html @@ -2,36 +2,28 @@ -NMDHCP6Config +libnm-glib Reference Manual: NMDHCP6Config - + - - - - - - - - - -

			libnm-glib Reference Manual
-Top - \| - Description - \| - Object Hierarchy - \| - Implemented Interfaces - \| - Properties -

+ + + + + + +

@@ -39,38 +31,76 @@

NMDHCP6Config

- +

Synopsis

                    NMDHCP6Config;
-                    NMDHCP6ConfigClass;
-#define             NM_DHCP6_CONFIG_OPTIONS
-GObject *           nm_dhcp6_config_new                 (DBusGConnection *connection,
-                                                         const char *object_path);
-GHashTable *        nm_dhcp6_config_get_options         (NMDHCP6Config *config);
-const char *        nm_dhcp6_config_get_one_option      (NMDHCP6Config *config,
-                                                         const char *option);
-

Functions

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

+GObject * +	+nm_dhcp6_config_new () +
+GHashTable * +	+nm_dhcp6_config_get_options () +
const char * +	+nm_dhcp6_config_get_one_option () +

Object Hierarchy

-  GObject
-   +----NMObject
-         +----NMDHCP6Config
-

Properties

+++++ + + + + + +

+GHashTable *

options

Read

Implemented Interfaces

-NMDHCP6Config implements - GInitable and GAsyncInitable.

Types and Values

++++ + + + + +

#define

NM_DHCP6_CONFIG_OPTIONS

Properties

-  "options"                  GHashTable*           : Read
+Object Hierarchy
+    GObject
+    ╰── NMObject
+        ╰── NMDHCP6Config

@@ -79,145 +109,128 @@ NMDHCP6Config implements

Details

NMDHCP6Config

typedef struct _NMDHCP6Config NMDHCP6Config;

NMDHCP6ConfigClass

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

NM_DHCP6_CONFIG_OPTIONS

#define NM_DHCP6_CONFIG_OPTIONS "options"
-

Functions

nm_dhcp6_config_new ()

GObject *           nm_dhcp6_config_new                 (DBusGConnection *connection,
-                                                         const char *object_path);

-Creates a new NMDHCP6Config. -

nm_dhcp6_config_new ()

GObject *
+nm_dhcp6_config_new (DBusGConnection *connection,
+                     const char *object_path);

Creates a new NMDHCP6Config.

Parameters

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

`connection` :	the DBusGConnection -	connection	the DBusGConnection
`object_path` :	the DBus object path of the device
Returns :	a new configuration. [transfer full] -	object_path	the DBus object path of the device

Returns

a new configuration.

[transfer full]

nm_dhcp6_config_get_options ()

GHashTable *        nm_dhcp6_config_get_options         (NMDHCP6Config *config);

-Gets all the options contained in the configuration. -

nm_dhcp6_config_get_options ()

GHashTable *
+nm_dhcp6_config_get_options (NMDHCP6Config *config);

Gets all the options contained in the configuration.

Parameters

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

`config` :	a NMDHCP6Config -
Returns :	the GHashTable containing strings for keys and values. -This is the internal copy used by the configuration, and must not be modified. [transfer none][element-type utf8 GObject.Value] -
config	a NMDHCP6Config

Returns

the GHashTable containing strings for keys and values. +This is the internal copy used by the configuration, and must not be modified.

[transfer none][element-type utf8 GObject.Value]

nm_dhcp6_config_get_one_option ()

const char *        nm_dhcp6_config_get_one_option      (NMDHCP6Config *config,
-                                                         const char *option);

-Gets one option by option name. -

nm_dhcp6_config_get_one_option ()

const char *
+nm_dhcp6_config_get_one_option (NMDHCP6Config *config,
+                                const char *option);

Gets one option by option name.

Parameters

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

`config` :	a NMDHCP6Config -
`option` :	the option to retrieve	config	a NMDHCP6Config
Returns :	the configuration option's value. This is the internal string used by the -configuration, and must not be modified.	option	the option to retrieve

Returns

the configuration option's value. This is the internal string used by the +configuration, and must not be modified.

Property Details

Types and Values

The `"options"` property

  "options"                  GHashTable*           : Read

-The GHashTable containing options of the configuration. -

NM_DHCP6_CONFIG_OPTIONS

#define NM_DHCP6_CONFIG_OPTIONS "options"
+

-Type: GLib.HashTable(utf8,GObject.Value)

Property Details

The `“options”` property

  “options”                  GHashTable *

Options.

Flags: Read

+ Generated by GTK-Doc V1.20 \ No newline at end of file diff --git a/docs/libnm-glib/html/NMDevice.html b/docs/libnm-glib/html/NMDevice.html index 621a183b..35d1dd2a 100644 --- a/docs/libnm-glib/html/NMDevice.html +++ b/docs/libnm-glib/html/NMDevice.html @@ -2,38 +2,29 @@ -NMDevice +libnm-glib Reference Manual: NMDevice - + - - - - - - - - - -

			libnm-glib Reference Manual
-Top - \| - Description - \| - Object Hierarchy - \| - Implemented Interfaces - \| - Properties - \| - Signals -

+ + + + + + +

@@ -41,1370 +32,1710 @@

NMDevice

- +

Synopsis

#define             NM_DEVICE_DEVICE_TYPE
-#define             NM_DEVICE_UDI
-#define             NM_DEVICE_INTERFACE
-#define             NM_DEVICE_IP_INTERFACE
-#define             NM_DEVICE_DRIVER
-#define             NM_DEVICE_DRIVER_VERSION
-#define             NM_DEVICE_FIRMWARE_VERSION
-#define             NM_DEVICE_CAPABILITIES
-#define             NM_DEVICE_MANAGED
-#define             NM_DEVICE_AUTOCONNECT
-#define             NM_DEVICE_FIRMWARE_MISSING
-#define             NM_DEVICE_IP4_CONFIG
-#define             NM_DEVICE_DHCP4_CONFIG
-#define             NM_DEVICE_IP6_CONFIG
-#define             NM_DEVICE_DHCP6_CONFIG
-#define             NM_DEVICE_STATE
-#define             NM_DEVICE_STATE_REASON
-#define             NM_DEVICE_ACTIVE_CONNECTION
-#define             NM_DEVICE_AVAILABLE_CONNECTIONS
-#define             NM_DEVICE_VENDOR
-#define             NM_DEVICE_PRODUCT
-                    NMDevice;
-                    NMDeviceClass;
-GObject *           nm_device_new                       (DBusGConnection *connection,
-                                                         const char *path);
-const char *        nm_device_get_iface                 (NMDevice *device);
-const char *        nm_device_get_ip_iface              (NMDevice *device);
-NMDeviceType        nm_device_get_device_type           (NMDevice *device);
-const char *        nm_device_get_udi                   (NMDevice *device);
-const char *        nm_device_get_driver                (NMDevice *device);
-const char *        nm_device_get_driver_version        (NMDevice *device);
-const char *        nm_device_get_firmware_version      (NMDevice *device);
-NMDeviceCapabilities nm_device_get_capabilities         (NMDevice *device);
-gboolean            nm_device_get_managed               (NMDevice *device);
-gboolean            nm_device_get_autoconnect           (NMDevice *device);
-void                nm_device_set_autoconnect           (NMDevice *device,
-                                                         gboolean autoconnect);
-gboolean            nm_device_get_firmware_missing      (NMDevice *device);
-NMIP4Config *       nm_device_get_ip4_config            (NMDevice *device);
-NMDHCP4Config *     nm_device_get_dhcp4_config          (NMDevice *device);
-NMIP6Config *       nm_device_get_ip6_config            (NMDevice *device);
-NMDHCP6Config *     nm_device_get_dhcp6_config          (NMDevice *device);
-NMDeviceState       nm_device_get_state                 (NMDevice *device);
-NMDeviceState       nm_device_get_state_reason          (NMDevice *device,
-                                                         NMDeviceStateReason *reason);
-NMActiveConnection * nm_device_get_active_connection    (NMDevice *device);
-const GPtrArray *   nm_device_get_available_connections (NMDevice *device);
-const char *        nm_device_get_product               (NMDevice *device);
-const char *        nm_device_get_vendor                (NMDevice *device);
-void                (*NMDeviceDeactivateFn)             (NMDevice *device,
-                                                         GError *error,
-                                                         gpointer user_data);
-void                nm_device_disconnect                (NMDevice *device,
-                                                         NMDeviceDeactivateFn callback,
-                                                         gpointer user_data);
-GSList *            nm_device_filter_connections        (NMDevice *device,
-                                                         const GSList *connections);
-gboolean            nm_device_connection_valid          (NMDevice *device,
-                                                         NMConnection *connection);
-gboolean            nm_device_connection_compatible     (NMDevice *device,
-                                                         NMConnection *connection,
-                                                         GError **error);
-

Object Hierarchy

-  GObject
-   +----NMObject
-         +----NMDevice
-               +----NMDeviceEthernet
-               +----NMDeviceWifi
-               +----NMDeviceModem
-               +----NMDeviceBt
-               +----NMDeviceWimax
-               +----NMDeviceOlpcMesh
-               +----NMDeviceAdsl
-               +----NMDeviceInfiniband
-               +----NMDeviceBond
-               +----NMDeviceBridge
-               +----NMDeviceVlan
-

Implemented Interfaces

-NMDevice implements - GInitable and GAsyncInitable.

Functions

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

+GObject * +	+nm_device_new () +
const char * +	+nm_device_get_iface () +
const char * +	+nm_device_get_ip_iface () +
+NMDeviceType +	+nm_device_get_device_type () +
const char * +	+nm_device_get_udi () +
const char * +	+nm_device_get_driver () +
const char * +	+nm_device_get_driver_version () +
const char * +	+nm_device_get_firmware_version () +
+NMDeviceCapabilities +	+nm_device_get_capabilities () +
+gboolean +	+nm_device_get_managed () +
+gboolean +	+nm_device_get_autoconnect () +
+void +	+nm_device_set_autoconnect () +
+gboolean +	+nm_device_get_firmware_missing () +
+NMIP4Config * +	+nm_device_get_ip4_config () +
+NMDHCP4Config * +	+nm_device_get_dhcp4_config () +
+NMIP6Config * +	+nm_device_get_ip6_config () +
+NMDHCP6Config * +	+nm_device_get_dhcp6_config () +
+NMDeviceState +	+nm_device_get_state () +
+NMDeviceState +	+nm_device_get_state_reason () +
+NMActiveConnection * +	+nm_device_get_active_connection () +
const GPtrArray * +	+nm_device_get_available_connections () +
const char * +	+nm_device_get_product () +
const char * +	+nm_device_get_vendor () +
+void +	+(*NMDeviceDeactivateFn) () +
+void +	+nm_device_disconnect () +
+GSList * +	+nm_device_filter_connections () +
+gboolean +	+nm_device_connection_valid () +
+gboolean +	+nm_device_connection_compatible () +

Properties

-  "active-connection"        NMActiveConnection*   : Read
-  "autoconnect"              gboolean              : Read / Write
-  "available-connections"    NMObjectArray*        : Read
-  "capabilities"             guint                 : Read
-  "device-type"              guint                 : Read
-  "dhcp4-config"             NMDHCP4Config*        : Read
-  "dhcp6-config"             NMDHCP6Config*        : Read
-  "driver"                   gchar*                : Read
-  "driver-version"           gchar*                : Read
-  "firmware-missing"         gboolean              : Read
-  "firmware-version"         gchar*                : Read
-  "interface"                gchar*                : Read
-  "ip-interface"             gchar*                : Read
-  "ip4-config"               NMIP4Config*          : Read
-  "ip6-config"               NMIP6Config*          : Read
-  "managed"                  gboolean              : Read
-  "product"                  gchar*                : Read
-  "state"                    guint                 : Read
-  "state-reason"             GValueArray_guint+guint_*  : Read
-  "udi"                      gchar*                : Read
-  "vendor"                   gchar*                : Read
-

Signals

-  "state-changed"                                  : Run First
-

Description

Details

NM_DEVICE_DEVICE_TYPE

#define NM_DEVICE_DEVICE_TYPE "device-type"
-

NM_DEVICE_UDI

#define NM_DEVICE_UDI "udi"
-

NM_DEVICE_INTERFACE

#define NM_DEVICE_INTERFACE "interface"
-

NM_DEVICE_IP_INTERFACE

#define NM_DEVICE_IP_INTERFACE "ip-interface"
-

NM_DEVICE_DRIVER

#define NM_DEVICE_DRIVER "driver"
-

NM_DEVICE_DRIVER_VERSION

#define NM_DEVICE_DRIVER_VERSION "driver-version"
-

NM_DEVICE_FIRMWARE_VERSION

#define NM_DEVICE_FIRMWARE_VERSION "firmware-version"
-

NM_DEVICE_CAPABILITIES

#define NM_DEVICE_CAPABILITIES "capabilities"
-

NM_DEVICE_MANAGED

#define NM_DEVICE_MANAGED "managed"
-

NM_DEVICE_AUTOCONNECT

#define NM_DEVICE_AUTOCONNECT "autoconnect"
-

NM_DEVICE_FIRMWARE_MISSING

#define NM_DEVICE_FIRMWARE_MISSING "firmware-missing"
-

NM_DEVICE_IP4_CONFIG

#define NM_DEVICE_IP4_CONFIG "ip4-config"
-

NM_DEVICE_DHCP4_CONFIG

#define NM_DEVICE_DHCP4_CONFIG "dhcp4-config"
-

NM_DEVICE_IP6_CONFIG

#define NM_DEVICE_IP6_CONFIG "ip6-config"
-

NM_DEVICE_DHCP6_CONFIG

#define NM_DEVICE_DHCP6_CONFIG "dhcp6-config"
-

NM_DEVICE_STATE

#define NM_DEVICE_STATE "state"
-

NM_DEVICE_STATE_REASON

#define NM_DEVICE_STATE_REASON "state-reason"
-

NM_DEVICE_ACTIVE_CONNECTION

#define NM_DEVICE_ACTIVE_CONNECTION "active-connection"
-

NM_DEVICE_AVAILABLE_CONNECTIONS

#define NM_DEVICE_AVAILABLE_CONNECTIONS "available-connections"
-

NM_DEVICE_VENDOR

#define NM_DEVICE_VENDOR "vendor"
-

NM_DEVICE_PRODUCT

#define NM_DEVICE_PRODUCT "product"
-

NMDevice

typedef struct _NMDevice NMDevice;

NMDeviceClass

typedef struct {
-	NMObjectClass parent;
-
-	/* Signals */
-	void (*state_changed) (NMDevice *device,
-	                       NMDeviceState new_state,
-	                       NMDeviceState old_state,
-	                       NMDeviceStateReason reason);
-
-	gboolean (*connection_compatible) (NMDevice *device,
-	                                   NMConnection *connection,
-	                                   GError **error);
-
-	/* Padding for future expansion */
-	void (*_reserved1) (void);
-	void (*_reserved2) (void);
-	void (*_reserved3) (void);
-	void (*_reserved4) (void);
-	void (*_reserved5) (void);
-	void (*_reserved6) (void);
-} NMDeviceClass;
-

nm_device_new ()

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

-Creates a new NMDevice. -

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

`connection` :	the DBusGConnection -	+NMActiveConnection *	active-connection	Read
gboolean	autoconnect	Read / Write
+NMObjectArray *	available-connections	Read
guint	capabilities	Read
guint	device-type	Read
+NMDHCP4Config *	dhcp4-config	Read
+NMDHCP6Config *	dhcp6-config	Read
+gchar *	driver	Read
+gchar *	driver-version	Read
gboolean	firmware-missing	Read
+gchar *	firmware-version	Read
+gchar *	interface	Read
+gchar *	ip-interface	Read
+NMIP4Config *	ip4-config	Read
+NMIP6Config *	ip6-config	Read
gboolean	managed	Read
+gchar *	product	Read
guint	state	Read
GValueArray_guint+guint_*	state-reason	Read
`path` :	the DBus object path of the device	+gchar *	udi	Read
Returns :	a new device. [transfer full] -	+gchar *	vendor	Read

nm_device_get_iface ()

const char *        nm_device_get_iface                 (NMDevice *device);

-Gets the interface name of the NMDevice. -

Signals

+++++ + + + + + +

void

state-changed

Types and Values

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

`device` :	a NMDevice -	#define	NM_DEVICE_DEVICE_TYPE
#define	NM_DEVICE_UDI
#define	NM_DEVICE_INTERFACE
#define	NM_DEVICE_IP_INTERFACE
#define	NM_DEVICE_DRIVER
#define	NM_DEVICE_DRIVER_VERSION
#define	NM_DEVICE_FIRMWARE_VERSION
#define	NM_DEVICE_CAPABILITIES
#define	NM_DEVICE_MANAGED
#define	NM_DEVICE_AUTOCONNECT
#define	NM_DEVICE_FIRMWARE_MISSING
#define	NM_DEVICE_IP4_CONFIG
#define	NM_DEVICE_DHCP4_CONFIG
#define	NM_DEVICE_IP6_CONFIG
#define	NM_DEVICE_DHCP6_CONFIG
#define	NM_DEVICE_STATE
#define	NM_DEVICE_STATE_REASON
#define	NM_DEVICE_ACTIVE_CONNECTION
#define	NM_DEVICE_AVAILABLE_CONNECTIONS
#define	NM_DEVICE_VENDOR
Returns :	the interface of the device. This is the internal string used by the -device, and must not be modified.	#define	NM_DEVICE_PRODUCT

nm_device_get_ip_iface ()

const char *        nm_device_get_ip_iface              (NMDevice *device);

Object Hierarchy

    GObject
+    ╰── NMObject
+        ╰── NMDevice
+            ├── NMDeviceEthernet
+            ├── NMDeviceWifi
+            ├── NMDeviceModem
+            ├── NMDeviceBt
+            ├── NMDeviceWimax
+            ├── NMDeviceOlpcMesh
+            ├── NMDeviceAdsl
+            ├── NMDeviceInfiniband
+            ├── NMDeviceBond
+            ├── NMDeviceBridge
+            ╰── NMDeviceVlan
+

Description

-Gets the IP interface name of the NMDevice over which IP traffic flows -when the device is in the ACTIVATED state.

+ +

Functions

nm_device_new ()

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

Creates a new NMDevice.

Parameters

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

`device` :	a NMDevice -	connection	the DBusGConnection
Returns :	the IP traffic interface of the device. This is the internal string -used by the device, and must not be modified.	path	the DBus object path of the device

Returns

a new device.

[transfer full]

nm_device_get_device_type ()

NMDeviceType        nm_device_get_device_type           (NMDevice *device);

-Returns the numeric type of the NMDevice, ie ethernet, wifi, etc. -

nm_device_get_iface ()

const char *
+nm_device_get_iface (NMDevice *device);

Gets the interface name of the NMDevice.

Parameters

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

`device` :	a NMDevice -
Returns :	the device type
device	a NMDevice

Returns

the interface of the device. This is the internal string used by the +device, and must not be modified.

nm_device_get_udi ()

const char *        nm_device_get_udi                   (NMDevice *device);

-Gets the Unique Device Identifier of the NMDevice. -

nm_device_get_ip_iface ()

const char *
+nm_device_get_ip_iface (NMDevice *device);

Gets the IP interface name of the NMDevice over which IP traffic flows +when the device is in the ACTIVATED state.

Parameters

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

`device` :	a NMDevice -
Returns :	the Unique Device Identifier of the device. This identifier may be -used to gather more information about the device from various operating -system services like udev or sysfs.
device	a NMDevice

Returns

the IP traffic interface of the device. This is the internal string +used by the device, and must not be modified.

nm_device_get_driver ()

const char *        nm_device_get_driver                (NMDevice *device);

-Gets the driver of the NMDevice. -

nm_device_get_device_type ()

NMDeviceType
+nm_device_get_device_type (NMDevice *device);

Returns the numeric type of the NMDevice, ie ethernet, wifi, etc.

Parameters

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

`device` :	a NMDevice -
Returns :	the driver of the device. This is the internal string used by the -device, and must not be modified.
device	a NMDevice

Returns

the device type

nm_device_get_driver_version ()

const char *        nm_device_get_driver_version        (NMDevice *device);

-Gets the driver version of the NMDevice. -

nm_device_get_udi ()

const char *
+nm_device_get_udi (NMDevice *device);

Gets the Unique Device Identifier of the NMDevice.

Parameters

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

`device` :	a NMDevice -
Returns :	the version of the device driver. This is the internal string used by the -device, and must not be modified.
device	a NMDevice

Returns

the Unique Device Identifier of the device. This identifier may be +used to gather more information about the device from various operating +system services like udev or sysfs.

nm_device_get_firmware_version ()

const char *        nm_device_get_firmware_version      (NMDevice *device);

-Gets the firmware version of the NMDevice. -

nm_device_get_driver ()

const char *
+nm_device_get_driver (NMDevice *device);

Gets the driver of the NMDevice.

Parameters

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

`device` :	a NMDevice -
Returns :	the firmware version of the device. This is the internal string used by the -device, and must not be modified.
device	a NMDevice

Returns

the driver of the device. This is the internal string used by the +device, and must not be modified.

nm_device_get_capabilities ()

NMDeviceCapabilities nm_device_get_capabilities         (NMDevice *device);

-Gets the device' capabilities. -

nm_device_get_driver_version ()

const char *
+nm_device_get_driver_version (NMDevice *device);

Gets the driver version of the NMDevice.

Parameters

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

`device` :	a NMDevice -
Returns :	the capabilities
device	a NMDevice

Returns

the version of the device driver. This is the internal string used by the +device, and must not be modified.

nm_device_get_managed ()

gboolean            nm_device_get_managed               (NMDevice *device);

-Whether the NMDevice is managed by NetworkManager. -

nm_device_get_firmware_version ()

const char *
+nm_device_get_firmware_version (NMDevice *device);

Gets the firmware version of the NMDevice.

Parameters

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

`device` :	a NMDevice -
Returns :	-`TRUE` if the device is managed by NetworkManager
device	a NMDevice

Returns

the firmware version of the device. This is the internal string used by the +device, and must not be modified.

nm_device_get_autoconnect ()

gboolean            nm_device_get_autoconnect           (NMDevice *device);

-Whether the NMDevice can be autoconnected. -

nm_device_get_capabilities ()

NMDeviceCapabilities
+nm_device_get_capabilities (NMDevice *device);

Gets the device' capabilities.

Parameters

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

`device` :	a NMDevice -
Returns :	-`TRUE` if the device is allowed to be autoconnected
device	a NMDevice

Returns

the capabilities

nm_device_set_autoconnect ()

void                nm_device_set_autoconnect           (NMDevice *device,
-                                                         gboolean autoconnect);

-Enables or disables automatic activation of the NMDevice. -

nm_device_get_managed ()

gboolean
+nm_device_get_managed (NMDevice *device);

Whether the NMDevice is managed by NetworkManager.

Parameters

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

`device` :	a NMDevice -
`autoconnect` :	-`TRUE` to enable autoconnecting
device	a NMDevice

Returns

TRUE if the device is managed by NetworkManager

nm_device_get_firmware_missing ()

gboolean            nm_device_get_firmware_missing      (NMDevice *device);

-Indicates that firmware required for the device's operation is likely -to be missing. -

nm_device_get_autoconnect ()

gboolean
+nm_device_get_autoconnect (NMDevice *device);

Whether the NMDevice can be autoconnected.

Parameters

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

`device` :	a NMDevice -
Returns :	-`TRUE` if firmware required for the device's operation is likely -to be missing.
device	a NMDevice

Returns

TRUE if the device is allowed to be autoconnected

nm_device_get_ip4_config ()

NMIP4Config *       nm_device_get_ip4_config            (NMDevice *device);

-Gets the current NMIP4Config associated with the NMDevice. -

nm_device_set_autoconnect ()

void
+nm_device_set_autoconnect (NMDevice *device,
+                           gboolean autoconnect);

Enables or disables automatic activation of the NMDevice.

Parameters

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

`device` :	a NMDevice -	device	a NMDevice
Returns :	the NMIP4Config or `NULL` if the device is not activated. [transfer none] -	autoconnect	`TRUE` to enable autoconnecting

nm_device_get_dhcp4_config ()

NMDHCP4Config *     nm_device_get_dhcp4_config          (NMDevice *device);

-Gets the current NMDHCP4Config associated with the NMDevice. -

nm_device_get_firmware_missing ()

gboolean
+nm_device_get_firmware_missing (NMDevice *device);

Indicates that firmware required for the device's operation is likely +to be missing.

Parameters

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

`device` :	a NMDevice -
Returns :	the NMDHCP4Config or `NULL` if the device is not activated or not -using DHCP. [transfer none] -
device	a NMDevice

Returns

TRUE if firmware required for the device's operation is likely +to be missing.

nm_device_get_ip6_config ()

NMIP6Config *       nm_device_get_ip6_config            (NMDevice *device);

-Gets the current NMIP6Config associated with the NMDevice. -

nm_device_get_ip4_config ()

NMIP4Config *
+nm_device_get_ip4_config (NMDevice *device);

Gets the current NMIP4Config associated with the NMDevice.

Parameters

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

`device` :	a NMDevice -
Returns :	the NMIP6Config or `NULL` if the device is not activated. [transfer none] -
device	a NMDevice

Returns

the NMIP4Config or NULL if the device is not activated.

[transfer none]

nm_device_get_dhcp6_config ()

NMDHCP6Config *     nm_device_get_dhcp6_config          (NMDevice *device);

-Gets the current NMDHCP6Config associated with the NMDevice. -

nm_device_get_dhcp4_config ()

NMDHCP4Config *
+nm_device_get_dhcp4_config (NMDevice *device);

Gets the current NMDHCP4Config associated with the NMDevice.

Parameters

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

`device` :	a NMDevice -
Returns :	the NMDHCP6Config or `NULL` if the device is not activated or not -using DHCP. [transfer none] -
device	a NMDevice

Returns

the NMDHCP4Config or NULL if the device is not activated or not +using DHCP.

[transfer none]

nm_device_get_state ()

NMDeviceState       nm_device_get_state                 (NMDevice *device);

-Gets the current NMDevice state. -

nm_device_get_ip6_config ()

NMIP6Config *
+nm_device_get_ip6_config (NMDevice *device);

Gets the current NMIP6Config associated with the NMDevice.

Parameters

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

`device` :	a NMDevice -
Returns :	the current device state
device	a NMDevice

Returns

the NMIP6Config or NULL if the device is not activated.

[transfer none]

nm_device_get_state_reason ()

NMDeviceState       nm_device_get_state_reason          (NMDevice *device,
-                                                         NMDeviceStateReason *reason);

-Gets the current NMDevice state (return value) and the reason for entering -the state (reason argument). -

nm_device_get_dhcp6_config ()

NMDHCP6Config *
+nm_device_get_dhcp6_config (NMDevice *device);

Gets the current NMDHCP6Config associated with the NMDevice.

Parameters

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

`device` :	a NMDevice -
`reason` :	location to store reason (NMDeviceStateReason), or `NULL`. [out][allow-none] -
Returns :	the current device state
device	a NMDevice

Returns

the NMDHCP6Config or NULL if the device is not activated or not +using DHCP.

[transfer none]

nm_device_get_active_connection ()

NMActiveConnection * nm_device_get_active_connection    (NMDevice *device);

-Gets the NMActiveConnection object which owns this device during activation. -

nm_device_get_state ()

NMDeviceState
+nm_device_get_state (NMDevice *device);

Gets the current NMDevice state.

Parameters

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

`device` :	a NMDevice -
Returns :	the NMActiveConnection or `NULL` if the device is -not part of an active connection. [transfer none] -
device	a NMDevice

Returns

the current device state

nm_device_get_available_connections ()

const GPtrArray *   nm_device_get_available_connections (NMDevice *device);

-Gets the NMRemoteConnections currently known to the daemon that could -be activated on device. -

nm_device_get_state_reason ()

NMDeviceState
+nm_device_get_state_reason (NMDevice *device,
+                            NMDeviceStateReason *reason);

Gets the current NMDevice state (return value) and the reason for entering +the state (reason + argument).

Parameters

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

`device` :	a NMDevice -	device	a NMDevice
Returns :	the GPtrArray -containing NMRemoteConnections. This is the internal copy used by -the connection, and must not be modified. [element-type NMClient.RemoteConnection] -	reason	location to store reason (NMDeviceStateReason), or `NULL`.	[out][allow-none]

Returns

the current device state

+ +

nm_device_get_active_connection ()

NMActiveConnection *
+nm_device_get_active_connection (NMDevice *device);

Gets the NMActiveConnection object which owns this device during activation.

Parameters

+++++ + + + + + +

device

a NMDevice

Returns

the NMActiveConnection or NULL if the device is +not part of an active connection.

[transfer none]

nm_device_get_available_connections ()

const GPtrArray *
+nm_device_get_available_connections (NMDevice *device);

Gets the NMRemoteConnections currently known to the daemon that could +be activated on device +.

Parameters

+++++ + + + + + +

device

a NMDevice

Returns

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

[element-type NMClient.RemoteConnection]

Since 0.9.8

nm_device_get_product ()

const char *        nm_device_get_product               (NMDevice *device);

-Gets the product string of the NMDevice. -

nm_device_get_product ()

const char *
+nm_device_get_product (NMDevice *device);

Gets the product string of the NMDevice.

Parameters

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

`device` :	a NMDevice -
Returns :	the product name of the device. This is the internal string used by the -device, and must not be modified.
device	a NMDevice

Returns

the product name of the device. This is the internal string used by the +device, and must not be modified.

nm_device_get_vendor ()

const char *        nm_device_get_vendor                (NMDevice *device);

-Gets the vendor string of the NMDevice. -

nm_device_get_vendor ()

const char *
+nm_device_get_vendor (NMDevice *device);

Gets the vendor string of the NMDevice.

Parameters

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

`device` :	a NMDevice -
Returns :	the vendor name of the device. This is the internal string used by the -device, and must not be modified.
device	a NMDevice

Returns

the vendor name of the device. This is the internal string used by the +device, and must not be modified.

NMDeviceDeactivateFn ()

void                (*NMDeviceDeactivateFn)             (NMDevice *device,
-                                                         GError *error,
-                                                         gpointer user_data);

NMDeviceDeactivateFn ()

void
+(*NMDeviceDeactivateFn) (NMDevice *device,
+                         GError *error,
+                         gpointer user_data);

nm_device_disconnect ()

void                nm_device_disconnect                (NMDevice *device,
-                                                         NMDeviceDeactivateFn callback,
-                                                         gpointer user_data);

-Disconnects the device if currently connected, and prevents the device from +

nm_device_disconnect ()

void
+nm_device_disconnect (NMDevice *device,
+                      NMDeviceDeactivateFn callback,
+                      gpointer user_data);

Disconnects the device if currently connected, and prevents the device from automatically connecting to networks until the next manual network connection -request. -

+request.

Parameters

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

`device` :	a NMDevice -	device	a NMDevice
`callback` :	callback to be called when disconnect -operation completes. [scope async][allow-none] -	callback	callback to be called when disconnect +operation completes.	[scope async][allow-none]
`user_data` :	caller-specific data passed to `callback`. [closure] -	user_data	caller-specific data passed to `callback` +.	[closure]

nm_device_filter_connections ()

GSList *            nm_device_filter_connections        (NMDevice *device,
-                                                         const GSList *connections);

-Filters a given list of connections for a given NMDevice object and return +

nm_device_filter_connections ()

GSList *
+nm_device_filter_connections (NMDevice *device,
+                              const GSList *connections);

Filters a given list of connections for a given NMDevice object and return connections which may be activated with the device. For example if device + is a WiFi device that supports only WEP encryption, the returned list will -contain any WiFi connections in connections that allow connection to +contain any WiFi connections in connections + that allow connection to unencrypted or WEP-enabled SSIDs. The returned list will not contain Ethernet, Bluetooth, WiFi WPA connections, or any other connection that is incompatible with the device. To get the full list of connections see -nm_remote_settings_list_connections(). -

+nm_remote_settings_list_connections().

Parameters

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

`device` :	an NMDevice to filter connections for
`connections` :	a list of NMConnection objects to filter. [element-type NetworkManager.Connection] -	device	an NMDevice to filter connections for
Returns :	a -list of NMConnection objects that could be activated with the given `device`. -The elements of the list are owned by their creator and should not be freed -by the caller, but the returned list itself is owned by the caller and should -be freed with `g_slist_free()` when it is no longer required. [transfer container][element-type NetworkManager.Connection] -	connections	a list of NMConnection objects to filter.	[element-type NetworkManager.Connection]

Returns

a +list of NMConnection objects that could be activated with the given device +. +The elements of the list are owned by their creator and should not be freed +by the caller, but the returned list itself is owned by the caller and should +be freed with g_slist_free() when it is no longer required.

[transfer container][element-type NetworkManager.Connection]

nm_device_connection_valid ()

gboolean            nm_device_connection_valid          (NMDevice *device,
-                                                         NMConnection *connection);

-Validates a given connection for a given NMDevice object and returns +

nm_device_connection_valid ()

gboolean
+nm_device_connection_valid (NMDevice *device,
+                            NMConnection *connection);

Validates a given connection for a given NMDevice object and returns whether the connection may be activated with the device. For example if -device is a WiFi device that supports only WEP encryption, the connection +device + is a WiFi device that supports only WEP encryption, the connection will only be valid if it is a WiFi connection which describes a WEP or open network, and will not be valid if it describes a WPA network, or if it is an Ethernet, Bluetooth, WWAN, etc connection that is incompatible with the -device. -

+device.

Parameters

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

`device` :	an NMDevice to validate `connection` against
`connection` :	an NMConnection to validate against `device` -	device	an NMDevice to validate `connection` +against
Returns :	-`TRUE` if the connection may be activated with this device, `FALSE` -if is incompatible with the device's capabilities and characteristics.	connection	an NMConnection to validate against `device` +

Returns

TRUE if the connection may be activated with this device, FALSE +if is incompatible with the device's capabilities and characteristics.

nm_device_connection_compatible ()

gboolean            nm_device_connection_compatible     (NMDevice *device,
-                                                         NMConnection *connection,
-                                                         GError **error);

-Validates a given connection for a given NMDevice object and returns +

nm_device_connection_compatible ()

gboolean
+nm_device_connection_compatible (NMDevice *device,
+                                 NMConnection *connection,
+                                 GError **error);

-This function does the same as nm_device_connection_valid(), i.e. checking +device.

This function does the same as nm_device_connection_valid(), i.e. checking compatibility of the given device and connection. But, in addition, it sets -GError when FALSE is returned. -

+GError when FALSE is returned.

Parameters

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

`device` :	an NMDevice to validate `connection` against	device	an NMDevice to validate `connection` +against
`connection` :	an NMConnection to validate against `device` -
`error` :	return location for a GError, or `NULL` -	connection	an NMConnection to validate against `device` +
Returns :	-`TRUE` if the connection may be activated with this device, `FALSE` -if is incompatible with the device's capabilities and characteristics.	error	return location for a GError, or `NULL`

Returns

TRUE if the connection may be activated with this device, FALSE +if is incompatible with the device's capabilities and characteristics.

Property Details

Types and Values

The `"active-connection"` property

  "active-connection"        NMActiveConnection*   : Read

NM_DEVICE_DEVICE_TYPE

#define NM_DEVICE_DEVICE_TYPE "device-type"
+

-The NMActiveConnection object that "owns" this device during activation.

The `"autoconnect"` property

  "autoconnect"              gboolean              : Read / Write

NM_DEVICE_UDI

#define NM_DEVICE_UDI "udi"
+

-Whether the device can auto-activate a connection.

Default value: TRUE

The `"available-connections"` property

  "available-connections"    NMObjectArray*        : Read

NM_DEVICE_INTERFACE

#define NM_DEVICE_INTERFACE "interface"
+

-The available connections (NMRemoteConnection) of the device

Since 0.9.8

The `"capabilities"` property

  "capabilities"             guint                 : Read

NM_DEVICE_IP_INTERFACE

#define NM_DEVICE_IP_INTERFACE "ip-interface"
+

-The capabilities of the device.

Default value: 0

The `"device-type"` property

  "device-type"              guint                 : Read

NM_DEVICE_DRIVER

#define NM_DEVICE_DRIVER "driver"
+

-The numeric type of the device.

Default value: 0

The `"dhcp4-config"` property

  "dhcp4-config"             NMDHCP4Config*        : Read

NM_DEVICE_DRIVER_VERSION

#define NM_DEVICE_DRIVER_VERSION "driver-version"
+

-The NMDHCP4Config of the device.

The `"dhcp6-config"` property

  "dhcp6-config"             NMDHCP6Config*        : Read

NM_DEVICE_FIRMWARE_VERSION

#define NM_DEVICE_FIRMWARE_VERSION "firmware-version"
+

-The NMDHCP6Config of the device.

The `"driver"` property

  "driver"                   gchar*                : Read

NM_DEVICE_CAPABILITIES

#define NM_DEVICE_CAPABILITIES "capabilities"
+

-The driver of the device.

Default value: NULL

The `"driver-version"` property

  "driver-version"           gchar*                : Read

NM_DEVICE_MANAGED

#define NM_DEVICE_MANAGED "managed"
+

-The version of the device driver.

Default value: NULL

The `"firmware-missing"` property

  "firmware-missing"         gboolean              : Read

NM_DEVICE_AUTOCONNECT

#define NM_DEVICE_AUTOCONNECT "autoconnect"
+

-When TRUE indicates the device is likely missing firmware required -for its operation.

Default value: FALSE

The `"firmware-version"` property

  "firmware-version"         gchar*                : Read

NM_DEVICE_FIRMWARE_MISSING

#define NM_DEVICE_FIRMWARE_MISSING "firmware-missing"
+

-The firmware version of the device.

Default value: NULL

The `"interface"` property

  "interface"                gchar*                : Read

NM_DEVICE_IP4_CONFIG

#define NM_DEVICE_IP4_CONFIG "ip4-config"
+

-The interface of the device.

Default value: NULL

The `"ip-interface"` property

  "ip-interface"             gchar*                : Read

NM_DEVICE_DHCP4_CONFIG

#define NM_DEVICE_DHCP4_CONFIG "dhcp4-config"
+

-The IP interface of the device which should be used for all IP-related -operations like addressing and routing.

Default value: NULL

The `"ip4-config"` property

  "ip4-config"               NMIP4Config*          : Read

NM_DEVICE_IP6_CONFIG

#define NM_DEVICE_IP6_CONFIG "ip6-config"
+

-The NMIP4Config of the device.

The `"ip6-config"` property

  "ip6-config"               NMIP6Config*          : Read

NM_DEVICE_DHCP6_CONFIG

#define NM_DEVICE_DHCP6_CONFIG "dhcp6-config"
+

-The NMIP6Config of the device.

The `"managed"` property

  "managed"                  gboolean              : Read

NM_DEVICE_STATE

#define NM_DEVICE_STATE "state"
+

-Whether the device is managed by NetworkManager.

Default value: FALSE

The `"product"` property

  "product"                  gchar*                : Read

NM_DEVICE_STATE_REASON

#define NM_DEVICE_STATE_REASON "state-reason"
+

-The product string of the device.

Default value: NULL

The `"state"` property

  "state"                    guint                 : Read

NM_DEVICE_ACTIVE_CONNECTION

#define NM_DEVICE_ACTIVE_CONNECTION "active-connection"
+

-The state of the device.

Default value: 0

The `"state-reason"` property

  "state-reason"             GValueArray_guint+guint_*  : Read

NM_DEVICE_AVAILABLE_CONNECTIONS

#define NM_DEVICE_AVAILABLE_CONNECTIONS "available-connections"
+

-The state and reason of the device.

The `"udi"` property

  "udi"                      gchar*                : Read

NM_DEVICE_VENDOR

#define NM_DEVICE_VENDOR "vendor"
+

-An operating-system specific device hardware identifier; this is not -unique to a specific hardware device across reboots or hotplugs. It -is an opaque string which for some device types (Bluetooth, Modem) -contains an identifier provided by the underlying hardware service daemon -such as Bluez or ModemManager, and clients can use this property to -request more information about the device from those services.

Default value: NULL

The `"vendor"` property

  "vendor"                   gchar*                : Read

NM_DEVICE_PRODUCT

#define NM_DEVICE_PRODUCT "product"
+

-The vendor string of the device.

Property Details

The `“active-connection”` property

  “active-connection”        NMActiveConnection *

Active Connection.

Flags: Read

The `“autoconnect”` property

  “autoconnect”              gboolean

Autoconnect.

Flags: Read / Write

Default value: TRUE

The `“available-connections”` property

  “available-connections”    NMObjectArray *

Available Connections.

Flags: Read

Since 0.9.8

The `“capabilities”` property

  “capabilities”             guint

Capabilities.

Flags: Read

Default value: 0

The `“device-type”` property

  “device-type”              guint

Numeric device type (ie ethernet, wifi, etc).

Flags: Read

Default value: 0

The `“dhcp4-config”` property

  “dhcp4-config”             NMDHCP4Config *

DHCP4 Config.

Flags: Read

The `“dhcp6-config”` property

  “dhcp6-config”             NMDHCP6Config *

DHCP6 Config.

Flags: Read

The `“driver”` property

  “driver”                   gchar *

Driver.

Flags: Read

Default value: NULL

The `“driver-version”` property

  “driver-version”           gchar *

Driver Version.

Flags: Read

Default value: NULL

The `“firmware-missing”` property

  “firmware-missing”         gboolean

Firmware missing.

Flags: Read

Default value: FALSE

The `“firmware-version”` property

  “firmware-version”         gchar *

Firmware Version.

Flags: Read

Default value: NULL

The `“interface”` property

  “interface”                gchar *

Interface name.

Flags: Read

Default value: NULL

The `“ip-interface”` property

  “ip-interface”             gchar *

IP Interface name.

Flags: Read

Default value: NULL

The `“ip4-config”` property

  “ip4-config”               NMIP4Config *

IP4 Config.

Flags: Read

The `“ip6-config”` property

  “ip6-config”               NMIP6Config *

IP6 Config.

Flags: Read

The `“managed”` property

  “managed”                  gboolean

Managed.

Flags: Read

Default value: FALSE

The `“product”` property

  “product”                  gchar *

Product string.

Flags: Read

Default value: NULL

The `“state”` property

  “state”                    guint

State.

Flags: Read

Default value: 0

The `“state-reason”` property

  “state-reason”             GValueArray_guint+guint_*

StateReason.

Flags: Read

The `“udi”` property

  “udi”                      gchar *

Unique Device Identifier.

Flags: Read

Default value: NULL

The `“vendor”` property

  “vendor”                   gchar *

Vendor string.

Flags: Read

Default value: NULL

Signal Details

The `"state-changed"` signal

void                user_function                      (NMDevice *device,
-                                                        guint     new_state,
-                                                        guint     old_state,
-                                                        guint     reason,
-                                                        gpointer  user_data)      : Run First

-Notifies the state change of a NMDevice. -

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

`device` :	the device object that received the signal
`new_state` :	the new state of the device
`old_state` :	the previous state of the device
`reason` :	the reason describing the state change
`user_data` :	user data set when the signal handler was connected.

The `“state-changed”` signal

void
+user_function (NMDevice *device,
+               guint     new_state,
+               guint     old_state,
+               guint     reason,
+               gpointer  user_data)

Flags: Run First

+ Generated by GTK-Doc V1.20 \ No newline at end of file diff --git a/docs/libnm-glib/html/NMDeviceAdsl.html b/docs/libnm-glib/html/NMDeviceAdsl.html index 8f20351f..fef737a4 100644 --- a/docs/libnm-glib/html/NMDeviceAdsl.html +++ b/docs/libnm-glib/html/NMDeviceAdsl.html @@ -2,36 +2,28 @@ -NMDeviceAdsl +libnm-glib Reference Manual: NMDeviceAdsl - + - - - - - - - - - -

			libnm-glib Reference Manual
-Top - \| - Description - \| - Object Hierarchy - \| - Implemented Interfaces - \| - Properties -

+ + + + + + +

@@ -39,40 +31,87 @@

NMDeviceAdsl

- +

Synopsis

enum                NMDeviceAdslError;
-#define             NM_DEVICE_ADSL_ERROR
-GQuark              nm_device_adsl_error_quark          (void);
-#define             NM_DEVICE_ADSL_CARRIER
-                    NMDeviceAdsl;
-                    NMDeviceAdslClass;
-GObject *           nm_device_adsl_new                  (DBusGConnection *connection,
-                                                         const char *path);
-gboolean            nm_device_adsl_get_carrier          (NMDeviceAdsl *device);
-

Functions

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

+GQuark +	+nm_device_adsl_error_quark () +
+GObject * +	+nm_device_adsl_new () +
+gboolean +	+nm_device_adsl_get_carrier () +

Object Hierarchy

-  GObject
-   +----NMObject
-         +----NMDevice
-               +----NMDeviceAdsl
-

Properties

+++++ + + + + + +

gboolean

carrier

Read

Implemented Interfaces

-NMDeviceAdsl implements - GInitable and GAsyncInitable.

Types and Values

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

enum	NMDeviceAdslError
#define	NM_DEVICE_ADSL_ERROR
#define	NM_DEVICE_ADSL_CARRIER

Properties

-  "carrier"                  gboolean              : Read
+Object Hierarchy
+    GObject
+    ╰── NMObject
+        ╰── NMDevice
+            ╰── NMDeviceAdsl

@@ -81,170 +120,149 @@ NMDeviceAdsl implements

Details

Functions

enum NMDeviceAdslError

typedef enum {
-	NM_DEVICE_ADSL_ERROR_UNKNOWN = 0,             /*< nick=UnknownError >*/
-	NM_DEVICE_ADSL_ERROR_NOT_ADSL_CONNECTION,     /*< nick=NotAdslConnection >*/
-	NM_DEVICE_ADSL_ERROR_INVALID_ADSL_CONNECTION, /*< nick=InvalidAdslConnection >*/
-} NMDeviceAdslError;
-

nm_device_adsl_error_quark ()

GQuark
+nm_device_adsl_error_quark (void);

Registers an error quark for NMDeviceAdsl if necessary.

Returns

the error quark used for NMDeviceAdsl errors.

+ +

nm_device_adsl_new ()

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

Creates a new NMDeviceAdsl.

Parameters

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

`NM_DEVICE_ADSL_ERROR_UNKNOWN`	unknown or unclassified error -
`NM_DEVICE_ADSL_ERROR_NOT_ADSL_CONNECTION`	the connection was not of ADSL type -	connection	the DBusGConnection
`NM_DEVICE_ADSL_ERROR_INVALID_ADSL_CONNECTION`	the ADSL connection was invalid -	path	the DBus object path of the device

NM_DEVICE_ADSL_ERROR

#define NM_DEVICE_ADSL_ERROR nm_device_adsl_error_quark ()
-

Returns

a new device.

[transfer full]

nm_device_adsl_error_quark ()

GQuark              nm_device_adsl_error_quark          (void);

-Registers an error quark for NMDeviceAdsl if necessary. -

nm_device_adsl_get_carrier ()

gboolean
+nm_device_adsl_get_carrier (NMDeviceAdsl *device);

Whether the device has carrier.

Parameters

--+++ - - + + +

Returns :

the error quark used for NMDeviceAdsl errors.

device

a NMDeviceAdsl

NM_DEVICE_ADSL_CARRIER

#define NM_DEVICE_ADSL_CARRIER "carrier"
-

Returns

TRUE if the device has carrier

NMDeviceAdsl

typedef struct _NMDeviceAdsl NMDeviceAdsl;

NMDeviceAdslClass

typedef struct {
-	NMDeviceClass parent;
-
-	/* Padding for future expansion */
-	void (*_reserved1) (void);
-	void (*_reserved2) (void);
-	void (*_reserved3) (void);
-	void (*_reserved4) (void);
-	void (*_reserved5) (void);
-	void (*_reserved6) (void);
-} NMDeviceAdslClass;
-

Types and Values

nm_device_adsl_new ()

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

-Creates a new NMDeviceAdsl. -

enum NMDeviceAdslError

Members

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

`connection` :	the DBusGConnection +	NM_DEVICE_ADSL_ERROR_UNKNOWN	+ unknown or unclassified error
`path` :	the DBus object path of the device	NM_DEVICE_ADSL_ERROR_NOT_ADSL_CONNECTION	+ the connection was not of ADSL type +
Returns :	a new device. [transfer full] +	NM_DEVICE_ADSL_ERROR_INVALID_ADSL_CONNECTION	+ the ADSL connection was invalid

nm_device_adsl_get_carrier ()

gboolean            nm_device_adsl_get_carrier          (NMDeviceAdsl *device);

NM_DEVICE_ADSL_ERROR

#define NM_DEVICE_ADSL_ERROR nm_device_adsl_error_quark ()
+

NM_DEVICE_ADSL_CARRIER

#define NM_DEVICE_ADSL_CARRIER "carrier"
+

-Whether the device has carrier.

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

`device` :	a NMDeviceAdsl -
Returns :	-`TRUE` if the device has carrier

Property Details

The `"carrier"` property

  "carrier"                  gboolean              : Read

-Whether the device has carrier. -

The `“carrier”` property

  “carrier”                  gboolean

Carrier.

Flags: Read

Default value: FALSE

+ Generated by GTK-Doc V1.20

\ No newline at end of file diff --git a/docs/libnm-glib/html/NMDeviceBond.html b/docs/libnm-glib/html/NMDeviceBond.html index 00223fb2..d86a8f04 100644 --- a/docs/libnm-glib/html/NMDeviceBond.html +++ b/docs/libnm-glib/html/NMDeviceBond.html @@ -2,36 +2,28 @@ -NMDeviceBond +libnm-glib Reference Manual: NMDeviceBond - + - - - - - - - - - -

			libnm-glib Reference Manual
-Top - \| - Description - \| - Object Hierarchy - \| - Implemented Interfaces - \| - Properties -

+ + + + + + +

@@ -39,46 +31,123 @@

NMDeviceBond

- +

Synopsis

enum                NMDeviceBondError;
-#define             NM_DEVICE_BOND_ERROR
-GQuark              nm_device_bond_error_quark          (void);
-#define             NM_DEVICE_BOND_HW_ADDRESS
-#define             NM_DEVICE_BOND_CARRIER
-#define             NM_DEVICE_BOND_SLAVES
-                    NMDeviceBond;
-                    NMDeviceBondClass;
-GObject *           nm_device_bond_new                  (DBusGConnection *connection,
-                                                         const char *path);
-const char *        nm_device_bond_get_hw_address       (NMDeviceBond *device);
-gboolean            nm_device_bond_get_carrier          (NMDeviceBond *device);
-const GPtrArray *   nm_device_bond_get_slaves           (NMDeviceBond *device);
-

Functions

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

+GQuark +	+nm_device_bond_error_quark () +
+GObject * +	+nm_device_bond_new () +
const char * +	+nm_device_bond_get_hw_address () +
+gboolean +	+nm_device_bond_get_carrier () +
const GPtrArray * +	+nm_device_bond_get_slaves () +

Object Hierarchy

-  GObject
-   +----NMObject
-         +----NMDevice
-               +----NMDeviceBond
-

Properties

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

gboolean	carrier	Read
+gchar *	hw-address	Read
+NMObjectArray *	slaves	Read

Implemented Interfaces

-NMDeviceBond implements - GInitable and GAsyncInitable.

Types and Values

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

enum	NMDeviceBondError
#define	NM_DEVICE_BOND_ERROR
#define	NM_DEVICE_BOND_HW_ADDRESS
#define	NM_DEVICE_BOND_CARRIER
#define	NM_DEVICE_BOND_SLAVES

Properties

-  "carrier"                  gboolean              : Read
-  "hw-address"               gchar*                : Read
-  "slaves"                   NMObjectArray*        : Read
+Object Hierarchy
+    GObject
+    ╰── NMObject
+        ╰── NMDevice
+            ╰── NMDeviceBond

@@ -87,265 +156,248 @@ NMDeviceBond implements

Details

Functions

enum NMDeviceBondError

typedef enum {
-	NM_DEVICE_BOND_ERROR_UNKNOWN = 0,             /*< nick=UnknownError >*/
-	NM_DEVICE_BOND_ERROR_NOT_BOND_CONNECTION,     /*< nick=NotBondConnection >*/
-	NM_DEVICE_BOND_ERROR_INVALID_BOND_CONNECTION, /*< nick=InvalidBondConnection >*/
-	NM_DEVICE_BOND_ERROR_INTERFACE_MISMATCH,      /*< nick=InterfaceMismatch >*/
-} NMDeviceBondError;
-

nm_device_bond_error_quark ()

GQuark
+nm_device_bond_error_quark (void);

Registers an error quark for NMDeviceBond if necessary.

Returns

the error quark used for NMDeviceBond errors.

+ +

nm_device_bond_new ()

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

Creates a new NMDeviceBond.

Parameters

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

`NM_DEVICE_BOND_ERROR_UNKNOWN`	unknown or unclassified error -
`NM_DEVICE_BOND_ERROR_NOT_BOND_CONNECTION`	the connection was not of bond type -
`NM_DEVICE_BOND_ERROR_INVALID_BOND_CONNECTION`	the bond connection was invalid -	connection	the DBusGConnection
`NM_DEVICE_BOND_ERROR_INTERFACE_MISMATCH`	the interfaces of the connection and the device mismatched -	path	the DBus object path of the device

NM_DEVICE_BOND_ERROR

#define NM_DEVICE_BOND_ERROR nm_device_bond_error_quark ()
-

Returns

a new device.

[transfer full]

nm_device_bond_error_quark ()

GQuark              nm_device_bond_error_quark          (void);

-Registers an error quark for NMDeviceBond if necessary. -

nm_device_bond_get_hw_address ()

const char *
+nm_device_bond_get_hw_address (NMDeviceBond *device);

Gets the hardware (MAC) address of the NMDeviceBond

Parameters

--+++ - - + + +

Returns :

the error quark used for NMDeviceBond errors.

device

a NMDeviceBond

NM_DEVICE_BOND_HW_ADDRESS

#define NM_DEVICE_BOND_HW_ADDRESS  "hw-address"
-

Returns

the hardware address. This is the internal string used by the +device, and must not be modified.

NM_DEVICE_BOND_CARRIER

#define NM_DEVICE_BOND_CARRIER     "carrier"
-

NM_DEVICE_BOND_SLAVES

#define NM_DEVICE_BOND_SLAVES      "slaves"
-

nm_device_bond_get_carrier ()

gboolean
+nm_device_bond_get_carrier (NMDeviceBond *device);

Whether the device has carrier.

Parameters

+++++ + + + + + +

device

a NMDeviceBond

Returns

TRUE if the device has carrier

NMDeviceBond

typedef struct _NMDeviceBond NMDeviceBond;

NMDeviceBondClass

typedef struct {
-	NMDeviceClass parent;
-
-	/* Padding for future expansion */
-	void (*_reserved1) (void);
-	void (*_reserved2) (void);
-	void (*_reserved3) (void);
-	void (*_reserved4) (void);
-	void (*_reserved5) (void);
-	void (*_reserved6) (void);
-} NMDeviceBondClass;
-

nm_device_bond_get_slaves ()

const GPtrArray *
+nm_device_bond_get_slaves (NMDeviceBond *device);

Gets the devices currently slaved to device +.

Parameters

+++++ + + + + + +

device

a NMDeviceBond

Returns

the GPtrArray containing +NMDevices that are slaves of device +. This is the internal +copy used by the device, and must not be modified.

[element-type NMClient.Device]

Since 0.9.6.4

Types and Values

nm_device_bond_new ()

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

-Creates a new NMDeviceBond. -

enum NMDeviceBondError

Members

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

`connection` :	the DBusGConnection +	NM_DEVICE_BOND_ERROR_UNKNOWN	+ unknown or unclassified error +
NM_DEVICE_BOND_ERROR_NOT_BOND_CONNECTION	+ the connection was not of bond type
`path` :	the DBus object path of the device	NM_DEVICE_BOND_ERROR_INVALID_BOND_CONNECTION	+ the bond connection was invalid +
Returns :	a new device. [transfer full] +	NM_DEVICE_BOND_ERROR_INTERFACE_MISMATCH	+ the interfaces of the connection and the device mismatched

nm_device_bond_get_hw_address ()

const char *        nm_device_bond_get_hw_address       (NMDeviceBond *device);

NM_DEVICE_BOND_ERROR

#define NM_DEVICE_BOND_ERROR nm_device_bond_error_quark ()
+

-Gets the hardware (MAC) address of the NMDeviceBond

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

`device` :	a NMDeviceBond -
Returns :	the hardware address. This is the internal string used by the -device, and must not be modified.

nm_device_bond_get_carrier ()

gboolean            nm_device_bond_get_carrier          (NMDeviceBond *device);

NM_DEVICE_BOND_HW_ADDRESS

#define NM_DEVICE_BOND_HW_ADDRESS  "hw-address"
+

-Whether the device has carrier.

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

`device` :	a NMDeviceBond -
Returns :	-`TRUE` if the device has carrier

nm_device_bond_get_slaves ()

const GPtrArray *   nm_device_bond_get_slaves           (NMDeviceBond *device);

NM_DEVICE_BOND_CARRIER

#define NM_DEVICE_BOND_CARRIER     "carrier"
+

NM_DEVICE_BOND_SLAVES

#define NM_DEVICE_BOND_SLAVES      "slaves"
+

-Gets the devices currently slaved to device.

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

`device` :	a NMDeviceBond -
Returns :	the GPtrArray containing -NMDevices that are slaves of `device`. This is the internal -copy used by the device, and must not be modified. [element-type NMClient.Device] -

Since 0.9.6.4

Property Details

The `"carrier"` property

  "carrier"                  gboolean              : Read

-Whether the device has carrier. -

The `“carrier”` property

  “carrier”                  gboolean

Carrier.

Flags: Read

Default value: FALSE

The `"hw-address"` property

  "hw-address"               gchar*                : Read

-The hardware (MAC) address of the device. -

The `“hw-address”` property

  “hw-address”               gchar *

Currently set hardware MAC address.

Flags: Read

Default value: NULL

The `"slaves"` property

  "slaves"                   NMObjectArray*        : Read

-The devices (NMDevice) slaved to the bond device. -

The `“slaves”` property

  “slaves”                   NMObjectArray *

Slaves.

Flags: Read

Since 0.9.8

+ Generated by GTK-Doc V1.20

\ No newline at end of file diff --git a/docs/libnm-glib/html/NMDeviceBridge.html b/docs/libnm-glib/html/NMDeviceBridge.html index a7f2df30..6ef3f5e4 100644 --- a/docs/libnm-glib/html/NMDeviceBridge.html +++ b/docs/libnm-glib/html/NMDeviceBridge.html @@ -2,36 +2,28 @@ -NMDeviceBridge +libnm-glib Reference Manual: NMDeviceBridge - + - - - - - - - - - -

			libnm-glib Reference Manual
-Top - \| - Description - \| - Object Hierarchy - \| - Implemented Interfaces - \| - Properties -

+ + + + + + +

@@ -39,46 +31,123 @@

NMDeviceBridge

- +

Synopsis

enum                NMDeviceBridgeError;
-#define             NM_DEVICE_BRIDGE_ERROR
-GQuark              nm_device_bridge_error_quark        (void);
-#define             NM_DEVICE_BRIDGE_HW_ADDRESS
-#define             NM_DEVICE_BRIDGE_CARRIER
-#define             NM_DEVICE_BRIDGE_SLAVES
-                    NMDeviceBridge;
-                    NMDeviceBridgeClass;
-GObject *           nm_device_bridge_new                (DBusGConnection *connection,
-                                                         const char *path);
-const char *        nm_device_bridge_get_hw_address     (NMDeviceBridge *device);
-gboolean            nm_device_bridge_get_carrier        (NMDeviceBridge *device);
-const GPtrArray *   nm_device_bridge_get_slaves         (NMDeviceBridge *device);
-

Functions

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

+GQuark +	+nm_device_bridge_error_quark () +
+GObject * +	+nm_device_bridge_new () +
const char * +	+nm_device_bridge_get_hw_address () +
+gboolean +	+nm_device_bridge_get_carrier () +
const GPtrArray * +	+nm_device_bridge_get_slaves () +

Object Hierarchy

-  GObject
-   +----NMObject
-         +----NMDevice
-               +----NMDeviceBridge
-

Properties

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

gboolean	carrier	Read
+gchar *	hw-address	Read
+NMObjectArray *	slaves	Read

Implemented Interfaces

-NMDeviceBridge implements - GInitable and GAsyncInitable.

Types and Values

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

enum	NMDeviceBridgeError
#define	NM_DEVICE_BRIDGE_ERROR
#define	NM_DEVICE_BRIDGE_HW_ADDRESS
#define	NM_DEVICE_BRIDGE_CARRIER
#define	NM_DEVICE_BRIDGE_SLAVES

Properties

-  "carrier"                  gboolean              : Read
-  "hw-address"               gchar*                : Read
-  "slaves"                   NMObjectArray*        : Read
+Object Hierarchy
+    GObject
+    ╰── NMObject
+        ╰── NMDevice
+            ╰── NMDeviceBridge

@@ -87,272 +156,255 @@ NMDeviceBridge implements

Details

Functions

enum NMDeviceBridgeError

typedef enum {
-	NM_DEVICE_BRIDGE_ERROR_UNKNOWN = 0,               /*< nick=UnknownError >*/
-	NM_DEVICE_BRIDGE_ERROR_NOT_BRIDGE_CONNECTION,     /*< nick=NotBridgeConnection >*/
-	NM_DEVICE_BRIDGE_ERROR_INVALID_BRIDGE_CONNECTION, /*< nick=InvalidBridgeConnection >*/
-	NM_DEVICE_BRIDGE_ERROR_INTERFACE_MISMATCH,        /*< nick=InterfaceMismatch >*/
-} NMDeviceBridgeError;
-

nm_device_bridge_error_quark ()

GQuark
+nm_device_bridge_error_quark (void);

Registers an error quark for NMDeviceBridge if necessary.

Returns

the error quark used for NMDeviceBridge errors.

Since 0.9.8

+ +

nm_device_bridge_new ()

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

Creates a new NMDeviceBridge.

Parameters

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

`NM_DEVICE_BRIDGE_ERROR_UNKNOWN`	unknown or unclassified error -
`NM_DEVICE_BRIDGE_ERROR_NOT_BRIDGE_CONNECTION`	the connection was not of bridge type -	connection	the DBusGConnection
`NM_DEVICE_BRIDGE_ERROR_INVALID_BRIDGE_CONNECTION`	the bridge connection was invalid -
`NM_DEVICE_BRIDGE_ERROR_INTERFACE_MISMATCH`	the interfaces of the connection and the device mismatched -	path	the DBus object path of the device

Since 0.9.8

NM_DEVICE_BRIDGE_ERROR

#define NM_DEVICE_BRIDGE_ERROR nm_device_bridge_error_quark ()
-

Returns

a new device.

[transfer full]

Since 0.9.8

nm_device_bridge_error_quark ()

GQuark              nm_device_bridge_error_quark        (void);

-Registers an error quark for NMDeviceBridge if necessary. -

nm_device_bridge_get_hw_address ()

const char *
+nm_device_bridge_get_hw_address (NMDeviceBridge *device);

Gets the hardware (MAC) address of the NMDeviceBridge

Parameters

--+++ - - + + +

Returns :

the error quark used for NMDeviceBridge errors.

device

a NMDeviceBridge

Returns

the hardware address. This is the internal string used by the +device, and must not be modified.

Since 0.9.8

NM_DEVICE_BRIDGE_HW_ADDRESS

#define NM_DEVICE_BRIDGE_HW_ADDRESS  "hw-address"
-

nm_device_bridge_get_carrier ()

gboolean
+nm_device_bridge_get_carrier (NMDeviceBridge *device);

Whether the device has carrier.

Parameters

+++++ + + + + + +

device

a NMDeviceBridge

NM_DEVICE_BRIDGE_CARRIER

#define NM_DEVICE_BRIDGE_CARRIER     "carrier"
-

Returns

TRUE if the device has carrier

NM_DEVICE_BRIDGE_SLAVES

#define NM_DEVICE_BRIDGE_SLAVES      "slaves"
-

Since 0.9.8

NMDeviceBridge

typedef struct _NMDeviceBridge NMDeviceBridge;

nm_device_bridge_get_slaves ()

const GPtrArray *
+nm_device_bridge_get_slaves (NMDeviceBridge *device);

Gets the devices currently slaved to device +.

Parameters

+++++ + + + + + +

device

a NMDeviceBridge

NMDeviceBridgeClass

typedef struct {
-	NMDeviceClass parent;
-
-	/* Padding for future expansion */
-	void (*_reserved1) (void);
-	void (*_reserved2) (void);
-	void (*_reserved3) (void);
-	void (*_reserved4) (void);
-	void (*_reserved5) (void);
-	void (*_reserved6) (void);
-} NMDeviceBridgeClass;
-

Returns

the GPtrArray containing +NMDevices that are slaves of device +. This is the internal +copy used by the device, and must not be modified.

[element-type NMClient.Device]

Since 0.9.8

Types and Values

nm_device_bridge_new ()

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

-Creates a new NMDeviceBridge. -

enum NMDeviceBridgeError

Members

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

`connection` :	the DBusGConnection +	NM_DEVICE_BRIDGE_ERROR_UNKNOWN	+ unknown or unclassified error +
NM_DEVICE_BRIDGE_ERROR_NOT_BRIDGE_CONNECTION	+ the connection was not of bridge type
`path` :	the DBus object path of the device	NM_DEVICE_BRIDGE_ERROR_INVALID_BRIDGE_CONNECTION	+ the bridge connection was invalid +
Returns :	a new device. [transfer full] +	NM_DEVICE_BRIDGE_ERROR_INTERFACE_MISMATCH	+ the interfaces of the connection and the device mismatched

Since 0.9.8

nm_device_bridge_get_hw_address ()

const char *        nm_device_bridge_get_hw_address     (NMDeviceBridge *device);

NM_DEVICE_BRIDGE_ERROR

#define NM_DEVICE_BRIDGE_ERROR nm_device_bridge_error_quark ()
+

-Gets the hardware (MAC) address of the NMDeviceBridge

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

`device` :	a NMDeviceBridge -
Returns :	the hardware address. This is the internal string used by the -device, and must not be modified.

Since 0.9.8

nm_device_bridge_get_carrier ()

gboolean            nm_device_bridge_get_carrier        (NMDeviceBridge *device);

NM_DEVICE_BRIDGE_HW_ADDRESS

#define NM_DEVICE_BRIDGE_HW_ADDRESS  "hw-address"
+

-Whether the device has carrier.

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

`device` :	a NMDeviceBridge -
Returns :	-`TRUE` if the device has carrier

Since 0.9.8

nm_device_bridge_get_slaves ()

const GPtrArray *   nm_device_bridge_get_slaves         (NMDeviceBridge *device);

NM_DEVICE_BRIDGE_CARRIER

#define NM_DEVICE_BRIDGE_CARRIER     "carrier"
+

NM_DEVICE_BRIDGE_SLAVES

#define NM_DEVICE_BRIDGE_SLAVES      "slaves"
+

-Gets the devices currently slaved to device.

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

`device` :	a NMDeviceBridge -
Returns :	the GPtrArray containing -NMDevices that are slaves of `device`. This is the internal -copy used by the device, and must not be modified. [element-type NMClient.Device] -

Since 0.9.8

Property Details

The `"carrier"` property

  "carrier"                  gboolean              : Read

-Whether the device has carrier. -

The `“carrier”` property

  “carrier”                  gboolean

Carrier.

Flags: Read

Default value: FALSE

Since 0.9.8

The `"hw-address"` property

  "hw-address"               gchar*                : Read

-The hardware (MAC) address of the device. -

The `“hw-address”` property

  “hw-address”               gchar *

Currently set hardware MAC address.

Flags: Read

Default value: NULL

Since 0.9.8

The `"slaves"` property

  "slaves"                   NMObjectArray*        : Read

-The devices (NMDevice) slaved to the bridge device. -

The `“slaves”` property

  “slaves”                   NMObjectArray *

Slaves.

Flags: Read

Since 0.9.8

+ Generated by GTK-Doc V1.20

\ No newline at end of file diff --git a/docs/libnm-glib/html/NMDeviceBt.html b/docs/libnm-glib/html/NMDeviceBt.html index e3a59fc7..e951a85a 100644 --- a/docs/libnm-glib/html/NMDeviceBt.html +++ b/docs/libnm-glib/html/NMDeviceBt.html @@ -2,36 +2,28 @@ -NMDeviceBt +libnm-glib Reference Manual: NMDeviceBt - + - - - - - - - - - -

			libnm-glib Reference Manual
-Top - \| - Description - \| - Object Hierarchy - \| - Implemented Interfaces - \| - Properties -

+ + + + + + +

@@ -39,321 +31,382 @@

NMDeviceBt

- +

Synopsis

enum                NMDeviceBtError;
-#define             NM_DEVICE_BT_ERROR
-GQuark              nm_device_bt_error_quark            (void);
-#define             NM_DEVICE_BT_HW_ADDRESS
-#define             NM_DEVICE_BT_NAME
-#define             NM_DEVICE_BT_CAPABILITIES
-                    NMDeviceBt;
-                    NMDeviceBtClass;
-GObject *           nm_device_bt_new                    (DBusGConnection *connection,
-                                                         const char *path);
-const char *        nm_device_bt_get_hw_address         (NMDeviceBt *device);
-const char *        nm_device_bt_get_name               (NMDeviceBt *device);
-NMBluetoothCapabilities nm_device_bt_get_capabilities   (NMDeviceBt *device);
-

Object Hierarchy

-  GObject
-   +----NMObject
-         +----NMDevice
-               +----NMDeviceBt
-

Implemented Interfaces

-NMDeviceBt implements - GInitable and GAsyncInitable.

Properties

-  "bt-capabilities"          guint                 : Read
-  "hw-address"               gchar*                : Read
-  "name"                     gchar*                : Read
-

Description

Details

enum NMDeviceBtError

typedef enum {
-	NM_DEVICE_BT_ERROR_UNKNOWN = 0,           /*< nick=UnknownError >*/
-	NM_DEVICE_BT_ERROR_NOT_BT_CONNECTION,     /*< nick=NotBtConnection >*/
-	NM_DEVICE_BT_ERROR_INVALID_BT_CONNECTION, /*< nick=InvalidBtConnection >*/
-	NM_DEVICE_BT_ERROR_INVALID_DEVICE_MAC,    /*< nick=InvalidDeviceMac >*/
-	NM_DEVICE_BT_ERROR_MAC_MISMATCH,          /*< nick=MacMismatch >*/
-	NM_DEVICE_BT_ERROR_MISSING_DEVICE_CAPS,   /*< nick=MissingDeviceCaps >*/
-} NMDeviceBtError;
-

Functions

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

`NM_DEVICE_BT_ERROR_UNKNOWN`	unknown or unclassified error +	+GQuark
`NM_DEVICE_BT_ERROR_NOT_BT_CONNECTION`	the connection was not of bluetooth type +	+nm_device_bt_error_quark ()
`NM_DEVICE_BT_ERROR_INVALID_BT_CONNECTION`	the bluetooth connection was invalid +	+GObject * +	+nm_device_bt_new ()
`NM_DEVICE_BT_ERROR_INVALID_DEVICE_MAC`	the device's MAC was invalid +	const char * +	+nm_device_bt_get_hw_address ()
`NM_DEVICE_BT_ERROR_MAC_MISMATCH`	the MACs of the connection and the device mismatched +	const char * +	+nm_device_bt_get_name ()
`NM_DEVICE_BT_ERROR_MISSING_DEVICE_CAPS`	the device missed required capabilities +	+NMBluetoothCapabilities +	+nm_device_bt_get_capabilities ()

NM_DEVICE_BT_ERROR

#define NM_DEVICE_BT_ERROR nm_device_bt_error_quark ()
-

Properties

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

guint	bt-capabilities	Read
+gchar *	hw-address	Read
+gchar *	name	Read

nm_device_bt_error_quark ()

GQuark              nm_device_bt_error_quark            (void);

-Registers an error quark for NMDeviceBt if necessary. -

Types and Values

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

Returns :	the error quark used for NMDeviceBt errors.
enum	NMDeviceBtError
#define	NM_DEVICE_BT_ERROR
#define	NM_DEVICE_BT_HW_ADDRESS
#define	NM_DEVICE_BT_NAME
#define	NM_DEVICE_BT_CAPABILITIES

NM_DEVICE_BT_HW_ADDRESS

#define NM_DEVICE_BT_HW_ADDRESS   "hw-address"
+
+Object Hierarchy
+    GObject
+    ╰── NMObject
+        ╰── NMDevice
+            ╰── NMDeviceBt
 
-
-
 
-
-
-NM_DEVICE_BT_NAME
-#define NM_DEVICE_BT_NAME         "name"
-
+
+Description
 
 
 
-
+
+Functions
 
-NM_DEVICE_BT_CAPABILITIES
-#define NM_DEVICE_BT_CAPABILITIES "bt-capabilities"
-
-
-
+nm_device_bt_error_quark ()
+GQuark
+nm_device_bt_error_quark (void);
+Registers an error quark for NMDeviceBt if necessary.
+
+Returns
+ the error quark used for NMDeviceBt errors.
+
 
-
-
-NMDeviceBt
-typedef struct _NMDeviceBt NMDeviceBt;
-
-
 
 
 
-NMDeviceBtClass
-typedef struct {
-	NMDeviceClass parent;
-
-	/* Padding for future expansion */
-	void (*_reserved1) (void);
-	void (*_reserved2) (void);
-	void (*_reserved3) (void);
-	void (*_reserved4) (void);
-	void (*_reserved5) (void);
-	void (*_reserved6) (void);
-} NMDeviceBtClass;
-
-
-
-
-
-
-nm_device_bt_new ()
-GObject *           nm_device_bt_new                    (DBusGConnection *connection,
-                                                         const char *path);
-
-Creates a new NMDeviceBt.
-
-
+nm_device_bt_new ()
+GObject *
+nm_device_bt_new (DBusGConnection *connection,
+                  const char *path);
+Creates a new NMDeviceBt.
+
+Parameters
+
--+++
-
-
+
+
+
-
-
-
-
-
-
+
+
+
 





 
 
 connection : the DBusGConnection
- connection the DBusGConnection  
 
 path : the DBus object path of the device
Returns : a new device. [transfer full]
- path the DBus object path of the device  
 
 
 
 
+
+Returns
+ a new device. 
+[transfer full]
+
+
 
 
-nm_device_bt_get_hw_address ()
-const char *        nm_device_bt_get_hw_address         (NMDeviceBt *device);
-
-Gets the hardware (MAC) address of the NMDeviceBt
-
-
+nm_device_bt_get_hw_address ()
+const char *
+nm_device_bt_get_hw_address (NMDeviceBt *device);
+Gets the hardware (MAC) address of the NMDeviceBt
+
+Parameters
+
--+++
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
 





 device : a NMDeviceBt
-
Returns : the hardware address. This is the internal string used by the
-device, and must not be modified.
device a NMDeviceBt  
 
 
+
+Returns
+ the hardware address. This is the internal string used by the
+device, and must not be modified.
+
+
+
 
 
-nm_device_bt_get_name ()
-const char *        nm_device_bt_get_name               (NMDeviceBt *device);
-
-Gets the name of the NMDeviceBt.
-
-
+nm_device_bt_get_name ()
+const char *
+nm_device_bt_get_name (NMDeviceBt *device);
+Gets the name of the NMDeviceBt.
+
+Parameters
+
--+++
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
 





 device : a NMDeviceBt
-
Returns : the name of the device
device a NMDeviceBt  
 
 
+
+Returns
+ the name of the device
+
+
+
 
 
-nm_device_bt_get_capabilities ()
-NMBluetoothCapabilities nm_device_bt_get_capabilities   (NMDeviceBt *device);
-
-Returns the Bluetooth device's usable capabilities.
-
-
+nm_device_bt_get_capabilities ()
+NMBluetoothCapabilities
+nm_device_bt_get_capabilities (NMDeviceBt *device);
+Returns the Bluetooth device's usable capabilities.
+
+Parameters
+
--++++
+
+
+
+
+
+
 





device a NMDeviceBt  
+
+
+Returns
+ a combination of NMBluetoothCapabilities
+
+
+

Types and Values

enum NMDeviceBtError

Members

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

`device` :	a NMDeviceBt +	NM_DEVICE_BT_ERROR_UNKNOWN	+ unknown or unclassified error +
NM_DEVICE_BT_ERROR_NOT_BT_CONNECTION	+ the connection was not of bluetooth type +
NM_DEVICE_BT_ERROR_INVALID_BT_CONNECTION	+ the bluetooth connection was invalid +
NM_DEVICE_BT_ERROR_INVALID_DEVICE_MAC	+ the device's MAC was invalid +
NM_DEVICE_BT_ERROR_MAC_MISMATCH	+ the MACs of the connection and the device mismatched
Returns :	a combination of NMBluetoothCapabilities +	NM_DEVICE_BT_ERROR_MISSING_DEVICE_CAPS	+ the device missed required capabilities

Property Details

The `"bt-capabilities"` property

  "bt-capabilities"          guint                 : Read

NM_DEVICE_BT_ERROR

#define NM_DEVICE_BT_ERROR nm_device_bt_error_quark ()
+

-The device's bluetooth capabilities, a combination of NMBluetoothCapabilities.

Default value: 0

The `"hw-address"` property

  "hw-address"               gchar*                : Read

NM_DEVICE_BT_HW_ADDRESS

#define NM_DEVICE_BT_HW_ADDRESS   "hw-address"
+

-The hardware (MAC) address of the device.

Default value: NULL

The `"name"` property

  "name"                     gchar*                : Read

NM_DEVICE_BT_NAME

#define NM_DEVICE_BT_NAME         "name"
+

NM_DEVICE_BT_CAPABILITIES

#define NM_DEVICE_BT_CAPABILITIES "bt-capabilities"
+

-The name of the bluetooth device.

Property Details

The `“bt-capabilities”` property

  “bt-capabilities”          guint

Bluetooth capabilities.

Flags: Read

Default value: 0

The `“hw-address”` property

  “hw-address”               gchar *

Hardware MAC address.

Flags: Read

Default value: NULL

The `“name”` property

  “name”                     gchar *

Device name.

Flags: Read

Default value: NULL

+ Generated by GTK-Doc V1.20

\ No newline at end of file diff --git a/docs/libnm-glib/html/NMDeviceEthernet.html b/docs/libnm-glib/html/NMDeviceEthernet.html index 4dec91a2..98767b2e 100644 --- a/docs/libnm-glib/html/NMDeviceEthernet.html +++ b/docs/libnm-glib/html/NMDeviceEthernet.html @@ -2,36 +2,28 @@ -NMDeviceEthernet +libnm-glib Reference Manual: NMDeviceEthernet - + - - - - - - - - - -

			libnm-glib Reference Manual
-Top - \| - Description - \| - Object Hierarchy - \| - Implemented Interfaces - \| - Properties -

+ + + + + + +

@@ -39,363 +31,437 @@

NMDeviceEthernet

- +

Synopsis

enum                NMDeviceEthernetError;
-#define             NM_DEVICE_ETHERNET_ERROR
-GQuark              nm_device_ethernet_error_quark      (void);
-#define             NM_DEVICE_ETHERNET_HW_ADDRESS
-#define             NM_DEVICE_ETHERNET_PERMANENT_HW_ADDRESS
-#define             NM_DEVICE_ETHERNET_SPEED
-#define             NM_DEVICE_ETHERNET_CARRIER
-                    NMDeviceEthernet;
-                    NMDeviceEthernetClass;
-GObject *           nm_device_ethernet_new              (DBusGConnection *connection,
-                                                         const char *path);
-const char *        nm_device_ethernet_get_hw_address   (NMDeviceEthernet *device);
-const char *        nm_device_ethernet_get_permanent_hw_address
-                                                        (NMDeviceEthernet *device);
-guint32             nm_device_ethernet_get_speed        (NMDeviceEthernet *device);
-gboolean            nm_device_ethernet_get_carrier      (NMDeviceEthernet *device);
-

Object Hierarchy

-  GObject
-   +----NMObject
-         +----NMDevice
-               +----NMDeviceEthernet
-

Implemented Interfaces

-NMDeviceEthernet implements - GInitable and GAsyncInitable.

Properties

-  "carrier"                  gboolean              : Read
-  "hw-address"               gchar*                : Read
-  "perm-hw-address"          gchar*                : Read
-  "speed"                    guint                 : Read
-

Description

Details

enum NMDeviceEthernetError

typedef enum {
-	NM_DEVICE_ETHERNET_ERROR_UNKNOWN = 0,                 /*< nick=UnknownError >*/
-	NM_DEVICE_ETHERNET_ERROR_NOT_ETHERNET_CONNECTION,     /*< nick=NotEthernetConnection >*/
-	NM_DEVICE_ETHERNET_ERROR_INVALID_ETHERNET_CONNECTION, /*< nick=InvalidEthernetConnection >*/
-	NM_DEVICE_ETHERNET_ERROR_INVALID_DEVICE_MAC,          /*< nick=InvalidDeviceMac >*/
-	NM_DEVICE_ETHERNET_ERROR_MAC_MISMATCH,                /*< nick=MacMismatch >*/
-} NMDeviceEthernetError;
-

Functions

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

`NM_DEVICE_ETHERNET_ERROR_UNKNOWN`	unknown or unclassified error +	+GQuark +	+nm_device_ethernet_error_quark ()
`NM_DEVICE_ETHERNET_ERROR_NOT_ETHERNET_CONNECTION`	the connection was not of ethernet or PPPoE type +	+GObject * +	+nm_device_ethernet_new () +
const char * +	+nm_device_ethernet_get_hw_address ()
`NM_DEVICE_ETHERNET_ERROR_INVALID_ETHERNET_CONNECTION`	the ethernet connection was invalid +	const char * +	+nm_device_ethernet_get_permanent_hw_address ()
`NM_DEVICE_ETHERNET_ERROR_INVALID_DEVICE_MAC`	the device's MAC was invalid +	+guint32 +	+nm_device_ethernet_get_speed ()
`NM_DEVICE_ETHERNET_ERROR_MAC_MISMATCH`	the MACs of the connection and the device mismatched +	+gboolean +	+nm_device_ethernet_get_carrier ()

NM_DEVICE_ETHERNET_ERROR

#define NM_DEVICE_ETHERNET_ERROR nm_device_ethernet_error_quark ()
-

nm_device_ethernet_error_quark ()

GQuark              nm_device_ethernet_error_quark      (void);

-Registers an error quark for NMDeviceEthernet if necessary. -

Properties

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

Returns :	the error quark used for NMDeviceEthernet errors.
gboolean	carrier	Read
+gchar *	hw-address	Read
+gchar *	perm-hw-address	Read
guint	speed	Read

NM_DEVICE_ETHERNET_HW_ADDRESS

#define NM_DEVICE_ETHERNET_HW_ADDRESS  "hw-address"
-

NM_DEVICE_ETHERNET_PERMANENT_HW_ADDRESS

#define NM_DEVICE_ETHERNET_PERMANENT_HW_ADDRESS "perm-hw-address"
-

Types and Values

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

enum	NMDeviceEthernetError
#define	NM_DEVICE_ETHERNET_ERROR
#define	NM_DEVICE_ETHERNET_HW_ADDRESS
#define	NM_DEVICE_ETHERNET_PERMANENT_HW_ADDRESS
#define	NM_DEVICE_ETHERNET_SPEED
#define	NM_DEVICE_ETHERNET_CARRIER

NM_DEVICE_ETHERNET_SPEED

#define NM_DEVICE_ETHERNET_SPEED       "speed"
+
+Object Hierarchy
+    GObject
+    ╰── NMObject
+        ╰── NMDevice
+            ╰── NMDeviceEthernet
 
-
-
 
-
-
-NM_DEVICE_ETHERNET_CARRIER
-#define NM_DEVICE_ETHERNET_CARRIER     "carrier"
-
+
+Description
 
 
 
-
+
+Functions
 
-NMDeviceEthernet
-typedef struct _NMDeviceEthernet NMDeviceEthernet;
-
-
+nm_device_ethernet_error_quark ()
+GQuark
+nm_device_ethernet_error_quark (void);
+Registers an error quark for NMDeviceEthernet if necessary.
+
+Returns
+ the error quark used for NMDeviceEthernet errors.
+
 
-
-
-NMDeviceEthernetClass
-typedef struct {
-	NMDeviceClass parent;
-
-	/* Padding for future expansion */
-	void (*_reserved1) (void);
-	void (*_reserved2) (void);
-	void (*_reserved3) (void);
-	void (*_reserved4) (void);
-	void (*_reserved5) (void);
-	void (*_reserved6) (void);
-} NMDeviceEthernetClass;
-
-
-
 
 
 
-nm_device_ethernet_new ()
-GObject *           nm_device_ethernet_new              (DBusGConnection *connection,
-                                                         const char *path);
-
-Creates a new NMDeviceEthernet.
-
-
+nm_device_ethernet_new ()
+GObject *
+nm_device_ethernet_new (DBusGConnection *connection,
+                        const char *path);
+Creates a new NMDeviceEthernet.
+
+Parameters
+
--+++
-
-
-
-
-
-
+
+
+
-
-
+
+
+
 





 
 
 connection : the DBusGConnection
-
path : the DBus object path of the device connection the DBusGConnection  
 
 Returns : a new device. [transfer full]
- path the DBus object path of the device  
 
 
 
 
+
+Returns
+ a new device. 
+[transfer full]
+
+
 
 
-nm_device_ethernet_get_hw_address ()
-const char *        nm_device_ethernet_get_hw_address   (NMDeviceEthernet *device);
-
-Gets the active hardware (MAC) address of the NMDeviceEthernet
-
-
+nm_device_ethernet_get_hw_address ()
+const char *
+nm_device_ethernet_get_hw_address (NMDeviceEthernet *device);
+Gets the active hardware (MAC) address of the NMDeviceEthernet
+
+Parameters
+
--+++
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
 





 device : a NMDeviceEthernet
-
Returns : the active hardware address. This is the internal string used by the
-device, and must not be modified.
device a NMDeviceEthernet  
 
 
+
+Returns
+ the active hardware address. This is the internal string used by the
+device, and must not be modified.
+
+
+
 
 
-nm_device_ethernet_get_permanent_hw_address ()
-const char *        nm_device_ethernet_get_permanent_hw_address
-                                                        (NMDeviceEthernet *device);
-
-Gets the permanent hardware (MAC) address of the NMDeviceEthernet
-
-
+nm_device_ethernet_get_permanent_hw_address ()
+const char *
+nm_device_ethernet_get_permanent_hw_address
+                               (NMDeviceEthernet *device);
+Gets the permanent hardware (MAC) address of the NMDeviceEthernet
+
+Parameters
+
--+++
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
 





 device : a NMDeviceEthernet
-
Returns : the permanent hardware address. This is the internal string used by the
-device, and must not be modified.
device a NMDeviceEthernet  
 
 
+
+Returns
+ the permanent hardware address. This is the internal string used by the
+device, and must not be modified.
+
+
+
 
 
-nm_device_ethernet_get_speed ()
-guint32             nm_device_ethernet_get_speed        (NMDeviceEthernet *device);
-
-Gets the speed of the NMDeviceEthernet.
-
-
+nm_device_ethernet_get_speed ()
+guint32
+nm_device_ethernet_get_speed (NMDeviceEthernet *device);
+Gets the speed of the NMDeviceEthernet.
+
+Parameters
+
--+++
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
 





 device : a NMDeviceEthernet
-
Returns : the speed of the device
device a NMDeviceEthernet  
 
 
+
+Returns
+ the speed of the device
+
+
+

nm_device_ethernet_get_carrier ()

gboolean            nm_device_ethernet_get_carrier      (NMDeviceEthernet *device);

-Whether the device has carrier. -

nm_device_ethernet_get_carrier ()

gboolean
+nm_device_ethernet_get_carrier (NMDeviceEthernet *device);

Whether the device has carrier.

Parameters

+++++ + + + + + +

device

a NMDeviceEthernet

Returns

TRUE if the device has carrier

Types and Values

enum NMDeviceEthernetError

Members

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

`device` :	a NMDeviceEthernet +	NM_DEVICE_ETHERNET_ERROR_UNKNOWN	+ unknown or unclassified error
Returns :	-`TRUE` if the device has carrier	NM_DEVICE_ETHERNET_ERROR_NOT_ETHERNET_CONNECTION	+ the connection was not of ethernet or PPPoE type +
NM_DEVICE_ETHERNET_ERROR_INVALID_ETHERNET_CONNECTION	+ the ethernet connection was invalid +
NM_DEVICE_ETHERNET_ERROR_INVALID_DEVICE_MAC	+ the device's MAC was invalid +
NM_DEVICE_ETHERNET_ERROR_MAC_MISMATCH	+ the MACs of the connection and the device mismatched +

Property Details

The `"carrier"` property

  "carrier"                  gboolean              : Read

NM_DEVICE_ETHERNET_ERROR

#define NM_DEVICE_ETHERNET_ERROR nm_device_ethernet_error_quark ()
+

-Whether the device has carrier.

Default value: FALSE

The `"hw-address"` property

  "hw-address"               gchar*                : Read

NM_DEVICE_ETHERNET_HW_ADDRESS

#define NM_DEVICE_ETHERNET_HW_ADDRESS  "hw-address"
+

-The active hardware (MAC) address of the device.

Default value: NULL

The `"perm-hw-address"` property

  "perm-hw-address"          gchar*                : Read

NM_DEVICE_ETHERNET_PERMANENT_HW_ADDRESS

#define NM_DEVICE_ETHERNET_PERMANENT_HW_ADDRESS "perm-hw-address"
+

-The permanent hardware (MAC) address of the device.

Default value: NULL

The `"speed"` property

  "speed"                    guint                 : Read

NM_DEVICE_ETHERNET_SPEED

#define NM_DEVICE_ETHERNET_SPEED       "speed"
+

NM_DEVICE_ETHERNET_CARRIER

#define NM_DEVICE_ETHERNET_CARRIER     "carrier"
+

-The speed of the device.

Property Details

The `“carrier”` property

  “carrier”                  gboolean

Carrier.

Flags: Read

Default value: FALSE

The `“hw-address”` property

  “hw-address”               gchar *

Currently set hardware MAC address.

Flags: Read

Default value: NULL

The `“perm-hw-address”` property

  “perm-hw-address”          gchar *

Permanent hardware MAC address.

Flags: Read

Default value: NULL

The `“speed”` property

  “speed”                    guint

Speed.

Flags: Read

Default value: 0

+ Generated by GTK-Doc V1.20

\ No newline at end of file diff --git a/docs/libnm-glib/html/NMDeviceInfiniband.html b/docs/libnm-glib/html/NMDeviceInfiniband.html index 89b30130..03743893 100644 --- a/docs/libnm-glib/html/NMDeviceInfiniband.html +++ b/docs/libnm-glib/html/NMDeviceInfiniband.html @@ -2,36 +2,28 @@ -NMDeviceInfiniband +libnm-glib Reference Manual: NMDeviceInfiniband - + - - - - - - - - - -

			libnm-glib Reference Manual
-Top - \| - Description - \| - Object Hierarchy - \| - Implemented Interfaces - \| - Properties -

+ + + + + + +

@@ -39,270 +31,315 @@

NMDeviceInfiniband

- +

Synopsis

enum                NMDeviceInfinibandError;
-#define             NM_DEVICE_INFINIBAND_ERROR
-GQuark              nm_device_infiniband_error_quark    (void);
-#define             NM_DEVICE_INFINIBAND_HW_ADDRESS
-#define             NM_DEVICE_INFINIBAND_CARRIER
-                    NMDeviceInfiniband;
-                    NMDeviceInfinibandClass;
-GObject *           nm_device_infiniband_new            (DBusGConnection *connection,
-                                                         const char *path);
-const char *        nm_device_infiniband_get_hw_address (NMDeviceInfiniband *device);
-gboolean            nm_device_infiniband_get_carrier    (NMDeviceInfiniband *device);
-

Object Hierarchy

-  GObject
-   +----NMObject
-         +----NMDevice
-               +----NMDeviceInfiniband
-

Implemented Interfaces

-NMDeviceInfiniband implements - GInitable and GAsyncInitable.

Properties

-  "carrier"                  gboolean              : Read
-  "hw-address"               gchar*                : Read
-

Description

Details

enum NMDeviceInfinibandError

typedef enum {
-	NM_DEVICE_INFINIBAND_ERROR_UNKNOWN = 0,                   /*< nick=UnknownError >*/
-	NM_DEVICE_INFINIBAND_ERROR_NOT_INFINIBAND_CONNECTION,     /*< nick=NotInfinibandConnection >*/
-	NM_DEVICE_INFINIBAND_ERROR_INVALID_INFINIBAND_CONNECTION, /*< nick=InvalidInfinibandConnection >*/
-	NM_DEVICE_INFINIBAND_ERROR_INVALID_DEVICE_MAC,            /*< nick=InvalidDeviceMac >*/
-	NM_DEVICE_INFINIBAND_ERROR_MAC_MISMATCH,                  /*< nick=MacMismatch >*/
-} NMDeviceInfinibandError;
-

Functions

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

`NM_DEVICE_INFINIBAND_ERROR_UNKNOWN`	unknown or unclassified error +	+GQuark
`NM_DEVICE_INFINIBAND_ERROR_NOT_INFINIBAND_CONNECTION`	the connection was not of InfiniBand type +	+nm_device_infiniband_error_quark ()
`NM_DEVICE_INFINIBAND_ERROR_INVALID_INFINIBAND_CONNECTION`	the InfiniBand connection was invalid +	+GObject * +	+nm_device_infiniband_new ()
`NM_DEVICE_INFINIBAND_ERROR_INVALID_DEVICE_MAC`	the device's MAC was invalid +	const char * +	+nm_device_infiniband_get_hw_address ()
`NM_DEVICE_INFINIBAND_ERROR_MAC_MISMATCH`	the MACs of the connection and the device mismatched +	+gboolean +	+nm_device_infiniband_get_carrier ()

NM_DEVICE_INFINIBAND_ERROR

#define NM_DEVICE_INFINIBAND_ERROR nm_device_infiniband_error_quark ()
-

Properties

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

gboolean	carrier	Read
+gchar *	hw-address	Read

nm_device_infiniband_error_quark ()

GQuark              nm_device_infiniband_error_quark    (void);

-Registers an error quark for NMDeviceInfiniband if necessary. -

Types and Values

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

Returns :	the error quark used for NMDeviceInfiniband errors.
enum	NMDeviceInfinibandError
#define	NM_DEVICE_INFINIBAND_ERROR
#define	NM_DEVICE_INFINIBAND_HW_ADDRESS
#define	NM_DEVICE_INFINIBAND_CARRIER

NM_DEVICE_INFINIBAND_HW_ADDRESS

#define NM_DEVICE_INFINIBAND_HW_ADDRESS  "hw-address"
+
+Object Hierarchy
+    GObject
+    ╰── NMObject
+        ╰── NMDevice
+            ╰── NMDeviceInfiniband
 
-
-
 
-
-
-NM_DEVICE_INFINIBAND_CARRIER
-#define NM_DEVICE_INFINIBAND_CARRIER     "carrier"
-
+
+Description
 
 
 
-
+
+Functions
 
-NMDeviceInfiniband
-typedef struct _NMDeviceInfiniband NMDeviceInfiniband;
-
-
+nm_device_infiniband_error_quark ()
+GQuark
+nm_device_infiniband_error_quark (void);
+Registers an error quark for NMDeviceInfiniband if necessary.
+
+Returns
+ the error quark used for NMDeviceInfiniband errors.
+
 
-
-
-NMDeviceInfinibandClass
-typedef struct {
-	NMDeviceClass parent;
-
-	/* Padding for future expansion */
-	void (*_reserved1) (void);
-	void (*_reserved2) (void);
-	void (*_reserved3) (void);
-	void (*_reserved4) (void);
-	void (*_reserved5) (void);
-	void (*_reserved6) (void);
-} NMDeviceInfinibandClass;
-
-
-
 
 
 
-nm_device_infiniband_new ()
-GObject *           nm_device_infiniband_new            (DBusGConnection *connection,
-                                                         const char *path);
-
-Creates a new NMDeviceInfiniband.
-
-
+nm_device_infiniband_new ()
+GObject *
+nm_device_infiniband_new (DBusGConnection *connection,
+                          const char *path);
+Creates a new NMDeviceInfiniband.
+
+Parameters
+
--+++
-
-
-
-
-
-
+
+
+
-
-
+
+
+
 





 
 
 connection : the DBusGConnection
-
path : the DBus object path of the device connection the DBusGConnection  
 
 Returns : a new device. [transfer full]
- path the DBus object path of the device  
 
 
 
 
+
+Returns
+ a new device. 
+[transfer full]
+
+
 
 
-nm_device_infiniband_get_hw_address ()
-const char *        nm_device_infiniband_get_hw_address (NMDeviceInfiniband *device);
-
-Gets the hardware (MAC) address of the NMDeviceInfiniband
-
-
+nm_device_infiniband_get_hw_address ()
+const char *
+nm_device_infiniband_get_hw_address (NMDeviceInfiniband *device);
+Gets the hardware (MAC) address of the NMDeviceInfiniband
+
+Parameters
+
--+++
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
 





 device : a NMDeviceInfiniband
-
Returns : the hardware address. This is the internal string used by the
-device, and must not be modified.
device a NMDeviceInfiniband  
 
 
+
+Returns
+ the hardware address. This is the internal string used by the
+device, and must not be modified.
+
+
+
 
 
-nm_device_infiniband_get_carrier ()
-gboolean            nm_device_infiniband_get_carrier    (NMDeviceInfiniband *device);
-
-Whether the device has carrier.
-
-
+nm_device_infiniband_get_carrier ()
+gboolean
+nm_device_infiniband_get_carrier (NMDeviceInfiniband *device);
+Whether the device has carrier.
+
+Parameters
+
--++++
+
+
+
+
+
+
 





device a NMDeviceInfiniband  
+
+
+Returns
+ TRUE if the device has carrier
+
+
+
+

Types and Values

enum NMDeviceInfinibandError

Members

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

`device` :	a NMDeviceInfiniband +	NM_DEVICE_INFINIBAND_ERROR_UNKNOWN	+ unknown or unclassified error +
NM_DEVICE_INFINIBAND_ERROR_NOT_INFINIBAND_CONNECTION	+ the connection was not of InfiniBand type +
NM_DEVICE_INFINIBAND_ERROR_INVALID_INFINIBAND_CONNECTION	+ the InfiniBand connection was invalid +
NM_DEVICE_INFINIBAND_ERROR_INVALID_DEVICE_MAC	+ the device's MAC was invalid
Returns :	-`TRUE` if the device has carrier	NM_DEVICE_INFINIBAND_ERROR_MAC_MISMATCH	+ the MACs of the connection and the device mismatched +

Property Details

The `"carrier"` property

  "carrier"                  gboolean              : Read

NM_DEVICE_INFINIBAND_ERROR

#define NM_DEVICE_INFINIBAND_ERROR nm_device_infiniband_error_quark ()
+

-Whether the device has carrier.

Default value: FALSE

The `"hw-address"` property

  "hw-address"               gchar*                : Read

NM_DEVICE_INFINIBAND_HW_ADDRESS

#define NM_DEVICE_INFINIBAND_HW_ADDRESS  "hw-address"
+

NM_DEVICE_INFINIBAND_CARRIER

#define NM_DEVICE_INFINIBAND_CARRIER     "carrier"
+

-The hardware (MAC) address of the device.

Property Details

The `“carrier”` property

  “carrier”                  gboolean

Carrier.

Flags: Read

Default value: FALSE

The `“hw-address”` property

  “hw-address”               gchar *

Currently set hardware MAC address.

Flags: Read

Default value: NULL

+ Generated by GTK-Doc V1.20

\ No newline at end of file diff --git a/docs/libnm-glib/html/NMDeviceModem.html b/docs/libnm-glib/html/NMDeviceModem.html index d5fb1cdf..bf7038a8 100644 --- a/docs/libnm-glib/html/NMDeviceModem.html +++ b/docs/libnm-glib/html/NMDeviceModem.html @@ -2,36 +2,28 @@ -NMDeviceModem +libnm-glib Reference Manual: NMDeviceModem - + - - - - - - - - - -

			libnm-glib Reference Manual
-Top - \| - Description - \| - Object Hierarchy - \| - Implemented Interfaces - \| - Properties -

+ + + + + + +

@@ -39,43 +31,98 @@

NMDeviceModem

- +

Synopsis

enum                NMDeviceModemError;
-#define             NM_DEVICE_MODEM_ERROR
-GQuark              nm_device_modem_error_quark         (void);
-#define             NM_DEVICE_MODEM_MODEM_CAPABILITIES
-#define             NM_DEVICE_MODEM_CURRENT_CAPABILITIES
-                    NMDeviceModem;
-                    NMDeviceModemClass;
-NMDeviceModemCapabilities nm_device_modem_get_modem_capabilities
-                                                        (NMDeviceModem *self);
-NMDeviceModemCapabilities nm_device_modem_get_current_capabilities
-                                                        (NMDeviceModem *self);
-

Functions

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

+GQuark +	+nm_device_modem_error_quark () +
+NMDeviceModemCapabilities +	+nm_device_modem_get_modem_capabilities () +
+NMDeviceModemCapabilities +	+nm_device_modem_get_current_capabilities () +

Object Hierarchy

-  GObject
-   +----NMObject
-         +----NMDevice
-               +----NMDeviceModem
-

Properties

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

guint	current-capabilities	Read
guint	modem-capabilities	Read

Implemented Interfaces

-NMDeviceModem implements - GInitable and GAsyncInitable.

Types and Values

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

enum	NMDeviceModemError
#define	NM_DEVICE_MODEM_ERROR
#define	NM_DEVICE_MODEM_MODEM_CAPABILITIES
#define	NM_DEVICE_MODEM_CURRENT_CAPABILITIES

Properties

-  "current-capabilities"     guint                 : Read
-  "modem-capabilities"       guint                 : Read
+Object Hierarchy
+    GObject
+    ╰── NMObject
+        ╰── NMDevice
+            ╰── NMDeviceModem

@@ -84,45 +131,125 @@ NMDeviceModem implements

Details

Functions

nm_device_modem_error_quark ()

GQuark
+nm_device_modem_error_quark (void);

Registers an error quark for NMDeviceModem if necessary.

Returns

the error quark used for NMDeviceModem errors.

nm_device_modem_get_modem_capabilities ()

NMDeviceModemCapabilities
+nm_device_modem_get_modem_capabilities
+                               (NMDeviceModem *self);

Returns a bitfield of the generic access technology families the modem +supports. Not all capabilities are available concurrently however; some +may require a firmware reload or reinitialization.

Parameters

+++++ + + + + + +

self

a NMDeviceModem

Returns

the generic access technology families the modem supports

nm_device_modem_get_current_capabilities ()

NMDeviceModemCapabilities
+nm_device_modem_get_current_capabilities
+                               (NMDeviceModem *self);

Returns a bitfield of the generic access technology families the modem +supports without a firmware reload or reinitialization. This value +represents the network types the modem can immediately connect to.

Parameters

+++++ + + + + + +

self

a NMDeviceModem

Returns

the generic access technology families the modem supports without +a firmware reload or other reinitialization

Types and Values

enum NMDeviceModemError

typedef enum {
-	NM_DEVICE_MODEM_ERROR_UNKNOWN = 0,              /*< nick=UnknownError >*/
-	NM_DEVICE_MODEM_ERROR_NOT_MODEM_CONNECTION,     /*< nick=NotModemConnection >*/
-	NM_DEVICE_MODEM_ERROR_INVALID_MODEM_CONNECTION, /*< nick=InvalidModemConnection >*/
-	NM_DEVICE_MODEM_ERROR_MISSING_DEVICE_CAPS,      /*< nick=MissingDeviceCaps >*/
-} NMDeviceModemError;
-

Members

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

`NM_DEVICE_MODEM_ERROR_UNKNOWN`	unknown or unclassified error +	NM_DEVICE_MODEM_ERROR_UNKNOWN	+ unknown or unclassified error
`NM_DEVICE_MODEM_ERROR_NOT_MODEM_CONNECTION`	the connection was not of modem type +	NM_DEVICE_MODEM_ERROR_NOT_MODEM_CONNECTION	+ the connection was not of modem type
`NM_DEVICE_MODEM_ERROR_INVALID_MODEM_CONNECTION`	the modem connection was invalid +	NM_DEVICE_MODEM_ERROR_INVALID_MODEM_CONNECTION	+ the modem connection was invalid
`NM_DEVICE_MODEM_ERROR_MISSING_DEVICE_CAPS`	the device missed required capabilities +	NM_DEVICE_MODEM_ERROR_MISSING_DEVICE_CAPS	+ the device missed required capabilities

NM_DEVICE_MODEM_ERROR

@@ -133,24 +260,6 @@ NMDeviceModem implements

nm_device_modem_error_quark ()

GQuark              nm_device_modem_error_quark         (void);

-Registers an error quark for NMDeviceModem if necessary. -

---- - - - - -

Returns :

the error quark used for NMDeviceModem errors.

NM_DEVICE_MODEM_MODEM_CAPABILITIES

#define NM_DEVICE_MODEM_MODEM_CAPABILITIES   "modem-capabilities"

@@ -165,116 +274,28 @@ Registers an error quark for -

NMDeviceModem

typedef struct _NMDeviceModem NMDeviceModem;

NMDeviceModemClass

typedef struct {
-	NMDeviceClass parent;
-
-	/* Padding for future expansion */
-	void (*_reserved1) (void);
-	void (*_reserved2) (void);
-	void (*_reserved3) (void);
-	void (*_reserved4) (void);
-	void (*_reserved5) (void);
-	void (*_reserved6) (void);
-} NMDeviceModemClass;
-

nm_device_modem_get_modem_capabilities ()

NMDeviceModemCapabilities nm_device_modem_get_modem_capabilities
-                                                        (NMDeviceModem *self);

-Returns a bitfield of the generic access technology families the modem -supports. Not all capabilities are available concurrently however; some -may require a firmware reload or reinitialization. -

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

`self` :	a NMDeviceModem -
Returns :	the generic access technology families the modem supports

nm_device_modem_get_current_capabilities ()

NMDeviceModemCapabilities nm_device_modem_get_current_capabilities
-                                                        (NMDeviceModem *self);

-Returns a bitfield of the generic access technology families the modem -supports without a firmware reload or reinitialization. This value -represents the network types the modem can immediately connect to. -

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

`self` :	a NMDeviceModem -
Returns :	the generic access technology families the modem supports without -a firmware reload or other reinitialization

Property Details

The `"current-capabilities"` property

  "current-capabilities"     guint                 : Read

-The generic family of access technologies the modem currently supports -without a firmware reload or reinitialization. -

The `“current-capabilities”` property

  “current-capabilities”     guint

Current capabilities.

Flags: Read

Default value: 0

The `"modem-capabilities"` property

  "modem-capabilities"       guint                 : Read

-The generic family of access technologies the modem supports. Not all -capabilities are available at the same time however; some modems require -a firmware reload or other reinitialization to switch between eg -CDMA/EVDO and GSM/UMTS. -

The `“modem-capabilities”` property

  “modem-capabilities”       guint

Modem capabilities.

Flags: Read

Default value: 0

+ Generated by GTK-Doc V1.20

\ No newline at end of file diff --git a/docs/libnm-glib/html/NMDeviceOlpcMesh.html b/docs/libnm-glib/html/NMDeviceOlpcMesh.html index ca10adb6..8fc759f1 100644 --- a/docs/libnm-glib/html/NMDeviceOlpcMesh.html +++ b/docs/libnm-glib/html/NMDeviceOlpcMesh.html @@ -2,36 +2,28 @@ -NMDeviceOlpcMesh +libnm-glib Reference Manual: NMDeviceOlpcMesh - + - - - - - - - - - -

			libnm-glib Reference Manual
-Top - \| - Description - \| - Object Hierarchy - \| - Implemented Interfaces - \| - Properties -

+ + + + + + +

@@ -39,47 +31,124 @@

NMDeviceOlpcMesh

- +

Synopsis

enum                NMDeviceOlpcMeshError;
-#define             NM_DEVICE_OLPC_MESH_ERROR
-GQuark              nm_device_olpc_mesh_error_quark     (void);
-#define             NM_DEVICE_OLPC_MESH_HW_ADDRESS
-#define             NM_DEVICE_OLPC_MESH_COMPANION
-#define             NM_DEVICE_OLPC_MESH_ACTIVE_CHANNEL
-                    NMDeviceOlpcMesh;
-                    NMDeviceOlpcMeshClass;
-GObject *           nm_device_olpc_mesh_new             (DBusGConnection *connection,
-                                                         const char *path);
-const char *        nm_device_olpc_mesh_get_hw_address  (NMDeviceOlpcMesh *device);
-NMDeviceWifi *      nm_device_olpc_mesh_get_companion   (NMDeviceOlpcMesh *device);
-guint32             nm_device_olpc_mesh_get_active_channel
-                                                        (NMDeviceOlpcMesh *device);
-

Functions

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

+GQuark +	+nm_device_olpc_mesh_error_quark () +
+GObject * +	+nm_device_olpc_mesh_new () +
const char * +	+nm_device_olpc_mesh_get_hw_address () +
+NMDeviceWifi * +	+nm_device_olpc_mesh_get_companion () +
+guint32 +	+nm_device_olpc_mesh_get_active_channel () +

Object Hierarchy

-  GObject
-   +----NMObject
-         +----NMDevice
-               +----NMDeviceOlpcMesh
-

Properties

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

guint	active-channel	Read
+NMDeviceWifi *	companion	Read
+gchar *	hw-address	Read

Implemented Interfaces

-NMDeviceOlpcMesh implements - GInitable and GAsyncInitable.

Types and Values

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

enum	NMDeviceOlpcMeshError
#define	NM_DEVICE_OLPC_MESH_ERROR
#define	NM_DEVICE_OLPC_MESH_HW_ADDRESS
#define	NM_DEVICE_OLPC_MESH_COMPANION
#define	NM_DEVICE_OLPC_MESH_ACTIVE_CHANNEL

Properties

-  "active-channel"           guint                 : Read
-  "companion"                NMDeviceWifi*         : Read
-  "hw-address"               gchar*                : Read
+Object Hierarchy
+    GObject
+    ╰── NMObject
+        ╰── NMDevice
+            ╰── NMDeviceOlpcMesh

@@ -88,255 +157,236 @@ NMDeviceOlpcMesh implements

Details

Functions

enum NMDeviceOlpcMeshError

typedef enum {
-	NM_DEVICE_OLPC_MESH_ERROR_UNKNOWN = 0,                  /*< nick=UnknownError >*/
-	NM_DEVICE_OLPC_MESH_ERROR_NOT_OLPC_MESH_CONNECTION,     /*< nick=NotOlpcMeshConnection >*/
-	NM_DEVICE_OLPC_MESH_ERROR_INVALID_OLPC_MESH_CONNECTION, /*< nick=InvalidOlpcMeshConnection >*/
-} NMDeviceOlpcMeshError;
-

nm_device_olpc_mesh_error_quark ()

GQuark
+nm_device_olpc_mesh_error_quark (void);

Registers an error quark for NMDeviceOlpcMesh if necessary.

Returns

the error quark used for NMDeviceOlpcMesh errors.

+ +

nm_device_olpc_mesh_new ()

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

Creates a new NMDeviceOlpcMesh.

Parameters

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

`NM_DEVICE_OLPC_MESH_ERROR_UNKNOWN`	unknown or unclassified error -
`NM_DEVICE_OLPC_MESH_ERROR_NOT_OLPC_MESH_CONNECTION`	the connection was not of Olpc Mesh type -	connection	the DBusGConnection
`NM_DEVICE_OLPC_MESH_ERROR_INVALID_OLPC_MESH_CONNECTION`	the Olpc Mesh connection was invalid -	path	the DBus object path of the device

NM_DEVICE_OLPC_MESH_ERROR

#define NM_DEVICE_OLPC_MESH_ERROR nm_device_olpc_mesh_error_quark ()
-

Returns

a new OlpcMesh device.

[transfer full]

nm_device_olpc_mesh_error_quark ()

GQuark              nm_device_olpc_mesh_error_quark     (void);

-Registers an error quark for NMDeviceOlpcMesh if necessary. -

nm_device_olpc_mesh_get_hw_address ()

const char *
+nm_device_olpc_mesh_get_hw_address (NMDeviceOlpcMesh *device);

Gets the hardware (MAC) address of the NMDeviceOlpcMesh

Parameters

--+++ - - + + +

Returns :

the error quark used for NMDeviceOlpcMesh errors.

device

a NMDeviceOlpcMesh

NM_DEVICE_OLPC_MESH_HW_ADDRESS

#define NM_DEVICE_OLPC_MESH_HW_ADDRESS     "hw-address"
-

Returns

the hardware address. This is the internal string used by the +device, and must not be modified.

NM_DEVICE_OLPC_MESH_COMPANION

#define NM_DEVICE_OLPC_MESH_COMPANION      "companion"
-

NM_DEVICE_OLPC_MESH_ACTIVE_CHANNEL

#define NM_DEVICE_OLPC_MESH_ACTIVE_CHANNEL "active-channel"
-

nm_device_olpc_mesh_get_companion ()

NMDeviceWifi *
+nm_device_olpc_mesh_get_companion (NMDeviceOlpcMesh *device);

Gets the companion device of the NMDeviceOlpcMesh.

Parameters

+++++ + + + + + +

device

a NMDeviceOlpcMesh

Returns

the companion of the device of NULL.

[transfer none]

NMDeviceOlpcMesh

typedef struct _NMDeviceOlpcMesh NMDeviceOlpcMesh;

NMDeviceOlpcMeshClass

typedef struct {
-	NMDeviceClass parent;
-
-	/* Padding for future expansion */
-	void (*_reserved1) (void);
-	void (*_reserved2) (void);
-	void (*_reserved3) (void);
-	void (*_reserved4) (void);
-	void (*_reserved5) (void);
-	void (*_reserved6) (void);
-} NMDeviceOlpcMeshClass;
-

nm_device_olpc_mesh_get_active_channel ()

guint32
+nm_device_olpc_mesh_get_active_channel
+                               (NMDeviceOlpcMesh *device);

Returns the active channel of the NMDeviceOlpcMesh device.

Parameters

+++++ + + + + + +

device

a NMDeviceOlpcMesh

Returns

active channel of the device

Types and Values

nm_device_olpc_mesh_new ()

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

-Creates a new NMDeviceOlpcMesh. -

enum NMDeviceOlpcMeshError

Members

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

`connection` :	the DBusGConnection +	NM_DEVICE_OLPC_MESH_ERROR_UNKNOWN	+ unknown or unclassified error
`path` :	the DBus object path of the device	NM_DEVICE_OLPC_MESH_ERROR_NOT_OLPC_MESH_CONNECTION	+ the connection was not of Olpc Mesh type +
Returns :	a new OlpcMesh device. [transfer full] +	NM_DEVICE_OLPC_MESH_ERROR_INVALID_OLPC_MESH_CONNECTION	+ the Olpc Mesh connection was invalid

nm_device_olpc_mesh_get_hw_address ()

const char *        nm_device_olpc_mesh_get_hw_address  (NMDeviceOlpcMesh *device);

NM_DEVICE_OLPC_MESH_ERROR

#define NM_DEVICE_OLPC_MESH_ERROR nm_device_olpc_mesh_error_quark ()
+

-Gets the hardware (MAC) address of the NMDeviceOlpcMesh

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

`device` :	a NMDeviceOlpcMesh -
Returns :	the hardware address. This is the internal string used by the -device, and must not be modified.

nm_device_olpc_mesh_get_companion ()

NMDeviceWifi *      nm_device_olpc_mesh_get_companion   (NMDeviceOlpcMesh *device);

NM_DEVICE_OLPC_MESH_HW_ADDRESS

#define NM_DEVICE_OLPC_MESH_HW_ADDRESS     "hw-address"
+

-Gets the companion device of the NMDeviceOlpcMesh.

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

`device` :	a NMDeviceOlpcMesh -
Returns :	the companion of the device of `NULL`. [transfer none] -

nm_device_olpc_mesh_get_active_channel ()

guint32             nm_device_olpc_mesh_get_active_channel
-                                                        (NMDeviceOlpcMesh *device);

NM_DEVICE_OLPC_MESH_COMPANION

#define NM_DEVICE_OLPC_MESH_COMPANION      "companion"
+

NM_DEVICE_OLPC_MESH_ACTIVE_CHANNEL

#define NM_DEVICE_OLPC_MESH_ACTIVE_CHANNEL "active-channel"
+

-Returns the active channel of the NMDeviceOlpcMesh device.

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

`device` :	a NMDeviceOlpcMesh -
Returns :	active channel of the device

Property Details

The `"active-channel"` property

  "active-channel"           guint                 : Read

-The device's active channel. -

The `“active-channel”` property

  “active-channel”           guint

Active channel.

Flags: Read

Default value: 0

The `"companion"` property

  "companion"                NMDeviceWifi*         : Read

-The companion device. -

The `“companion”` property

  “companion”                NMDeviceWifi *

Companion device.

Flags: Read

The `"hw-address"` property

  "hw-address"               gchar*                : Read

-The hardware (MAC) address of the device. -

The `“hw-address”` property

  “hw-address”               gchar *

Hardware MAC address.

Flags: Read

Default value: NULL

+ Generated by GTK-Doc V1.20

\ No newline at end of file diff --git a/docs/libnm-glib/html/NMDeviceVlan.html b/docs/libnm-glib/html/NMDeviceVlan.html index 7ca398c1..b7952355 100644 --- a/docs/libnm-glib/html/NMDeviceVlan.html +++ b/docs/libnm-glib/html/NMDeviceVlan.html @@ -2,36 +2,28 @@ -NMDeviceVlan +libnm-glib Reference Manual: NMDeviceVlan - + - - - - - - - - - -

			libnm-glib Reference Manual
-Top - \| - Description - \| - Object Hierarchy - \| - Implemented Interfaces - \| - Properties -

+ + + + + + +

@@ -39,306 +31,368 @@

NMDeviceVlan

- +

Synopsis

enum                NMDeviceVlanError;
-#define             NM_DEVICE_VLAN_ERROR
-GQuark              nm_device_vlan_error_quark          (void);
-#define             NM_DEVICE_VLAN_HW_ADDRESS
-#define             NM_DEVICE_VLAN_CARRIER
-#define             NM_DEVICE_VLAN_VLAN_ID
-                    NMDeviceVlan;
-                    NMDeviceVlanClass;
-GObject *           nm_device_vlan_new                  (DBusGConnection *connection,
-                                                         const char *path);
-const char *        nm_device_vlan_get_hw_address       (NMDeviceVlan *device);
-gboolean            nm_device_vlan_get_carrier          (NMDeviceVlan *device);
-guint               nm_device_vlan_get_vlan_id          (NMDeviceVlan *device);
-

Object Hierarchy

-  GObject
-   +----NMObject
-         +----NMDevice
-               +----NMDeviceVlan
-

Implemented Interfaces

-NMDeviceVlan implements - GInitable and GAsyncInitable.

Properties

-  "carrier"                  gboolean              : Read
-  "hw-address"               gchar*                : Read
-  "vlan-id"                  guint                 : Read
-

Description

Details

enum NMDeviceVlanError

typedef enum {
-	NM_DEVICE_VLAN_ERROR_UNKNOWN = 0,             /*< nick=UnknownError >*/
-	NM_DEVICE_VLAN_ERROR_NOT_VLAN_CONNECTION,     /*< nick=NotVlanConnection >*/
-	NM_DEVICE_VLAN_ERROR_INVALID_VLAN_CONNECTION, /*< nick=InvalidVlanConnection >*/
-	NM_DEVICE_VLAN_ERROR_ID_MISMATCH,             /*< nick=IdMismatch >*/
-	NM_DEVICE_VLAN_ERROR_INTERFACE_MISMATCH,      /*< nick=InterfaceMismatch >*/
-} NMDeviceVlanError;
-

Functions

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

`NM_DEVICE_VLAN_ERROR_UNKNOWN`	unknown or unclassified error +	+GQuark +	+nm_device_vlan_error_quark ()
`NM_DEVICE_VLAN_ERROR_NOT_VLAN_CONNECTION`	the connection was not of VLAN type +	+GObject * +	+nm_device_vlan_new ()
`NM_DEVICE_VLAN_ERROR_INVALID_VLAN_CONNECTION`	the VLAN connection was invalid +	const char * +	+nm_device_vlan_get_hw_address ()
`NM_DEVICE_VLAN_ERROR_ID_MISMATCH`	the VLAN identifiers of the connection and the device mismatched +	+gboolean +	+nm_device_vlan_get_carrier ()
`NM_DEVICE_VLAN_ERROR_INTERFACE_MISMATCH`	the interfaces of the connection and the device mismatched +	+guint +	+nm_device_vlan_get_vlan_id ()

NM_DEVICE_VLAN_ERROR

#define NM_DEVICE_VLAN_ERROR nm_device_vlan_error_quark ()
-

nm_device_vlan_error_quark ()

GQuark              nm_device_vlan_error_quark          (void);

-Registers an error quark for NMDeviceVlan if necessary. -

Properties

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

Returns :	the error quark used for NMDeviceVlan errors.
gboolean	carrier	Read
+gchar *	hw-address	Read
guint	vlan-id	Read

NM_DEVICE_VLAN_HW_ADDRESS

#define NM_DEVICE_VLAN_HW_ADDRESS  "hw-address"
-

Types and Values

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

enum	NMDeviceVlanError
#define	NM_DEVICE_VLAN_ERROR
#define	NM_DEVICE_VLAN_HW_ADDRESS
#define	NM_DEVICE_VLAN_CARRIER
#define	NM_DEVICE_VLAN_VLAN_ID

NM_DEVICE_VLAN_CARRIER

#define NM_DEVICE_VLAN_CARRIER     "carrier"
+
+Object Hierarchy
+    GObject
+    ╰── NMObject
+        ╰── NMDevice
+            ╰── NMDeviceVlan
 
-
-
 
-
-
-NM_DEVICE_VLAN_VLAN_ID
-#define NM_DEVICE_VLAN_VLAN_ID     "vlan-id"
-
+
+Description
 
 
 
-
+
+Functions
 
-NMDeviceVlan
-typedef struct _NMDeviceVlan NMDeviceVlan;
-
-
+nm_device_vlan_error_quark ()
+GQuark
+nm_device_vlan_error_quark (void);
+Registers an error quark for NMDeviceVlan if necessary.
+
+Returns
+ the error quark used for NMDeviceVlan errors.
+
 
-
-
-NMDeviceVlanClass
-typedef struct {
-	NMDeviceClass parent;
-
-	/* Padding for future expansion */
-	void (*_reserved1) (void);
-	void (*_reserved2) (void);
-	void (*_reserved3) (void);
-	void (*_reserved4) (void);
-	void (*_reserved5) (void);
-	void (*_reserved6) (void);
-} NMDeviceVlanClass;
-
-
-
 
 
 
-nm_device_vlan_new ()
-GObject *           nm_device_vlan_new                  (DBusGConnection *connection,
-                                                         const char *path);
-
-Creates a new NMDeviceVlan.
-
-
+nm_device_vlan_new ()
+GObject *
+nm_device_vlan_new (DBusGConnection *connection,
+                    const char *path);
+Creates a new NMDeviceVlan.
+
+Parameters
+
--+++
-
-
-
-
-
-
+
+
+
-
-
+
+
+
 





 
 
 connection : the DBusGConnection
-
path : the DBus object path of the device connection the DBusGConnection  
 
 Returns : a new device. [transfer full]
- path the DBus object path of the device  
 
 
 
 
+
+Returns
+ a new device. 
+[transfer full]
+
+
 
 
-nm_device_vlan_get_hw_address ()
-const char *        nm_device_vlan_get_hw_address       (NMDeviceVlan *device);
-
-Gets the hardware (MAC) address of the NMDeviceVlan
-
-
+nm_device_vlan_get_hw_address ()
+const char *
+nm_device_vlan_get_hw_address (NMDeviceVlan *device);
+Gets the hardware (MAC) address of the NMDeviceVlan
+
+Parameters
+
--+++
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
 





 device : a NMDeviceVlan
-
Returns : the hardware address. This is the internal string used by the
-device, and must not be modified.
device a NMDeviceVlan  
 
 
+
+Returns
+ the hardware address. This is the internal string used by the
+device, and must not be modified.
+
+
+
 
 
-nm_device_vlan_get_carrier ()
-gboolean            nm_device_vlan_get_carrier          (NMDeviceVlan *device);
-
-Whether the device has carrier.
-
-
+nm_device_vlan_get_carrier ()
+gboolean
+nm_device_vlan_get_carrier (NMDeviceVlan *device);
+Whether the device has carrier.
+
+Parameters
+
--+++
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
 





 device : a NMDeviceVlan
-
Returns : 
-TRUE if the device has carrier
device a NMDeviceVlan  
 
 
+
+Returns
+ TRUE if the device has carrier
+
+
+
 
 
-nm_device_vlan_get_vlan_id ()
-guint               nm_device_vlan_get_vlan_id          (NMDeviceVlan *device);
-
+nm_device_vlan_get_vlan_id ()
+guint
+nm_device_vlan_get_vlan_id (NMDeviceVlan *device);
+
+Parameters
+
--++++
+
+
+
+
+
+
 





device a NMDeviceVlan  
+
+
+Returns
+ the device's VLAN ID
+
+
+

Types and Values

enum NMDeviceVlanError

Members

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

`device` :	a NMDeviceVlan +	NM_DEVICE_VLAN_ERROR_UNKNOWN	+ unknown or unclassified error +
NM_DEVICE_VLAN_ERROR_NOT_VLAN_CONNECTION	+ the connection was not of VLAN type +
NM_DEVICE_VLAN_ERROR_INVALID_VLAN_CONNECTION	+ the VLAN connection was invalid +
NM_DEVICE_VLAN_ERROR_ID_MISMATCH	+ the VLAN identifiers of the connection and the device mismatched
Returns :	the device's VLAN ID	NM_DEVICE_VLAN_ERROR_INTERFACE_MISMATCH	+ the interfaces of the connection and the device mismatched +

Property Details

The `"carrier"` property

  "carrier"                  gboolean              : Read

NM_DEVICE_VLAN_ERROR

#define NM_DEVICE_VLAN_ERROR nm_device_vlan_error_quark ()
+

-Whether the device has carrier.

Default value: FALSE

The `"hw-address"` property

  "hw-address"               gchar*                : Read

NM_DEVICE_VLAN_HW_ADDRESS

#define NM_DEVICE_VLAN_HW_ADDRESS  "hw-address"
+

-The hardware (MAC) address of the device.

Default value: NULL

The `"vlan-id"` property

  "vlan-id"                  guint                 : Read

NM_DEVICE_VLAN_CARRIER

#define NM_DEVICE_VLAN_CARRIER     "carrier"
+

NM_DEVICE_VLAN_VLAN_ID

#define NM_DEVICE_VLAN_VLAN_ID     "vlan-id"
+

-The device's VLAN ID.

Property Details

The `“carrier”` property

  “carrier”                  gboolean

Carrier.

Flags: Read

Default value: FALSE

The `“hw-address”` property

  “hw-address”               gchar *

Currently set hardware MAC address.

Flags: Read

Default value: NULL

The `“vlan-id”` property

  “vlan-id”                  guint

VLAN ID.

Flags: Read

Allowed values: <= 4095

Default value: 0

@@ -346,6 +400,6 @@ The device's VLAN ID.

+ Generated by GTK-Doc V1.20

\ No newline at end of file diff --git a/docs/libnm-glib/html/NMDeviceWifi.html b/docs/libnm-glib/html/NMDeviceWifi.html index 1fcd9f27..61d0228b 100644 --- a/docs/libnm-glib/html/NMDeviceWifi.html +++ b/docs/libnm-glib/html/NMDeviceWifi.html @@ -2,38 +2,29 @@ -NMDeviceWifi +libnm-glib Reference Manual: NMDeviceWifi - + - - - - - - - - - -

			libnm-glib Reference Manual
-Top - \| - Description - \| - Object Hierarchy - \| - Implemented Interfaces - \| - Properties - \| - Signals -

+ + + + + + +

@@ -41,659 +32,762 @@

NMDeviceWifi

- +

Synopsis

enum                NMDeviceWifiError;
-#define             NM_DEVICE_WIFI_ERROR
-GQuark              nm_device_wifi_error_quark          (void);
-#define             NM_DEVICE_WIFI_HW_ADDRESS
-#define             NM_DEVICE_WIFI_PERMANENT_HW_ADDRESS
-#define             NM_DEVICE_WIFI_MODE
-#define             NM_DEVICE_WIFI_BITRATE
-#define             NM_DEVICE_WIFI_ACTIVE_ACCESS_POINT
-#define             NM_DEVICE_WIFI_CAPABILITIES
-                    NMDeviceWifi;
-                    NMDeviceWifiClass;
-GObject *           nm_device_wifi_new                  (DBusGConnection *connection,
-                                                         const char *path);
-const char *        nm_device_wifi_get_hw_address       (NMDeviceWifi *device);
-const char *        nm_device_wifi_get_permanent_hw_address
-                                                        (NMDeviceWifi *device);
-NM80211Mode         nm_device_wifi_get_mode             (NMDeviceWifi *device);
-guint32             nm_device_wifi_get_bitrate          (NMDeviceWifi *device);
-NMDeviceWifiCapabilities nm_device_wifi_get_capabilities
-                                                        (NMDeviceWifi *device);
-NMAccessPoint *     nm_device_wifi_get_active_access_point
-                                                        (NMDeviceWifi *device);
-NMAccessPoint *     nm_device_wifi_get_access_point_by_path
-                                                        (NMDeviceWifi *device,
-                                                         const char *path);
-const GPtrArray *   nm_device_wifi_get_access_points    (NMDeviceWifi *device);
-void                (*NMDeviceWifiRequestScanFn)        (NMDeviceWifi *device,
-                                                         GError *error,
-                                                         gpointer user_data);
-void                nm_device_wifi_request_scan_simple  (NMDeviceWifi *device,
-                                                         NMDeviceWifiRequestScanFn callback,
-                                                         gpointer user_data);
-

Object Hierarchy

-  GObject
-   +----NMObject
-         +----NMDevice
-               +----NMDeviceWifi
-

Implemented Interfaces

-NMDeviceWifi implements - GInitable and GAsyncInitable.

Properties

-  "active-access-point"      NMAccessPoint*        : Read
-  "bitrate"                  guint                 : Read
-  "hw-address"               gchar*                : Read
-  "mode"                     guint                 : Read
-  "perm-hw-address"          gchar*                : Read
-  "wireless-capabilities"    guint                 : Read
-

Signals

-  "access-point-added"                             : Run First
-  "access-point-removed"                           : Run First
-

Description

Details

enum NMDeviceWifiError

typedef enum {
-	NM_DEVICE_WIFI_ERROR_UNKNOWN = 0,             /*< nick=UnknownError >*/
-	NM_DEVICE_WIFI_ERROR_NOT_WIFI_CONNECTION,     /*< nick=NotWifiConnection >*/
-	NM_DEVICE_WIFI_ERROR_INVALID_WIFI_CONNECTION, /*< nick=InvalidWifiConnection >*/
-	NM_DEVICE_WIFI_ERROR_INVALID_DEVICE_MAC,      /*< nick=InvalidDeviceMac >*/
-	NM_DEVICE_WIFI_ERROR_MAC_MISMATCH,            /*< nick=MacMismatch >*/
-	NM_DEVICE_WIFI_ERROR_MISSING_DEVICE_WPA_CAPS, /*< nick=MissingDeviceWpaCaps >*/
-	NM_DEVICE_WIFI_ERROR_MISSING_DEVICE_RSN_CAPS, /*< nick=MissingDeviceRsnCaps >*/
-} NMDeviceWifiError;
-

Functions

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

`NM_DEVICE_WIFI_ERROR_UNKNOWN`	unknown or unclassified error +	+GQuark +	+nm_device_wifi_error_quark () +
+GObject * +	+nm_device_wifi_new () +
const char * +	+nm_device_wifi_get_hw_address () +
const char * +	+nm_device_wifi_get_permanent_hw_address () +
+NM80211Mode +	+nm_device_wifi_get_mode () +
+guint32 +	+nm_device_wifi_get_bitrate ()
`NM_DEVICE_WIFI_ERROR_NOT_WIFI_CONNECTION`	the connection was not of Wi-Fi type +	+NMDeviceWifiCapabilities +	+nm_device_wifi_get_capabilities ()
`NM_DEVICE_WIFI_ERROR_INVALID_WIFI_CONNECTION`	the Wi-Fi connection was invalid +	+NMAccessPoint * +	+nm_device_wifi_get_active_access_point ()
`NM_DEVICE_WIFI_ERROR_INVALID_DEVICE_MAC`	the device's MAC was invalid +	+NMAccessPoint * +	+nm_device_wifi_get_access_point_by_path ()
`NM_DEVICE_WIFI_ERROR_MAC_MISMATCH`	the MACs of the connection and the device mismatched +	const GPtrArray * +	+nm_device_wifi_get_access_points ()
`NM_DEVICE_WIFI_ERROR_MISSING_DEVICE_WPA_CAPS`	the device missed WPA capabilities -required by the connection +	+void +	+(*NMDeviceWifiRequestScanFn) ()
`NM_DEVICE_WIFI_ERROR_MISSING_DEVICE_RSN_CAPS`	the device missed RSN capabilities -required by the connection +	+void +	+nm_device_wifi_request_scan_simple ()

NM_DEVICE_WIFI_ERROR

#define NM_DEVICE_WIFI_ERROR nm_device_wifi_error_quark ()
-

Properties

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

+NMAccessPoint *	active-access-point	Read
guint	bitrate	Read
+gchar *	hw-address	Read
guint	mode	Read
+gchar *	perm-hw-address	Read
guint	wireless-capabilities	Read

nm_device_wifi_error_quark ()

GQuark              nm_device_wifi_error_quark          (void);

-Registers an error quark for NMDeviceWifi if necessary. -

Signals

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

Returns :	the error quark used for NMDeviceWifi errors.
void	access-point-added	Run First
void	access-point-removed	Run First

NM_DEVICE_WIFI_HW_ADDRESS

#define NM_DEVICE_WIFI_HW_ADDRESS          "hw-address"
-

Types and Values

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

enum	NMDeviceWifiError
#define	NM_DEVICE_WIFI_ERROR
#define	NM_DEVICE_WIFI_HW_ADDRESS
#define	NM_DEVICE_WIFI_PERMANENT_HW_ADDRESS
#define	NM_DEVICE_WIFI_MODE
#define	NM_DEVICE_WIFI_BITRATE
#define	NM_DEVICE_WIFI_ACTIVE_ACCESS_POINT
#define	NM_DEVICE_WIFI_CAPABILITIES

NM_DEVICE_WIFI_PERMANENT_HW_ADDRESS

#define NM_DEVICE_WIFI_PERMANENT_HW_ADDRESS "perm-hw-address"
+
+Object Hierarchy
+    GObject
+    ╰── NMObject
+        ╰── NMDevice
+            ╰── NMDeviceWifi
 
-
-
 
-
-
-NM_DEVICE_WIFI_MODE
-#define NM_DEVICE_WIFI_MODE                "mode"
-
+
+Description
 
 
 
-
+
+Functions
 
-NM_DEVICE_WIFI_BITRATE
-#define NM_DEVICE_WIFI_BITRATE             "bitrate"
-
-
-
+nm_device_wifi_error_quark ()
+GQuark
+nm_device_wifi_error_quark (void);
+Registers an error quark for NMDeviceWifi if necessary.
+
+Returns
+ the error quark used for NMDeviceWifi errors.
+
+
 
 
 
-NM_DEVICE_WIFI_ACTIVE_ACCESS_POINT
-#define NM_DEVICE_WIFI_ACTIVE_ACCESS_POINT "active-access-point"
-
-
-
+nm_device_wifi_new ()
+GObject *
+nm_device_wifi_new (DBusGConnection *connection,
+                    const char *path);
+Creates a new NMDeviceWifi.
+
+Parameters
+
+++++
+
+
+
+
+
+
+
+
+
+
+
+
+



connection the DBusGConnection  
path the DBus object path of the device  
+
+
+Returns
+ a new WiFi device. 
+[transfer full]
+
 
 
 
-NM_DEVICE_WIFI_CAPABILITIES
-#define NM_DEVICE_WIFI_CAPABILITIES        "wireless-capabilities"
-
-
-
+nm_device_wifi_get_hw_address ()
+const char *
+nm_device_wifi_get_hw_address (NMDeviceWifi *device);
+Gets the actual hardware (MAC) address of the NMDeviceWifi
+
+Parameters
+
+++++
+
+
+
+
+
+



device a NMDeviceWifi  
+
+
+Returns
+ the actual hardware address. This is the internal string used by the
+device, and must not be modified.
+
+
 
 
 
-NMDeviceWifi
-typedef struct _NMDeviceWifi NMDeviceWifi;
-
-
+nm_device_wifi_get_permanent_hw_address ()
+const char *
+nm_device_wifi_get_permanent_hw_address
+                               (NMDeviceWifi *device);
+Gets the permanent hardware (MAC) address of the NMDeviceWifi
+
+Parameters
+
+++++
+
+
+
+
+
+



device a NMDeviceWifi  
+
+
+Returns
+ the permanent hardware address. This is the internal string used by the
+device, and must not be modified.
+
+
 
 
 
-NMDeviceWifiClass
-typedef struct {
-	NMDeviceClass parent;
-
-	/* Signals */
-	void (*access_point_added) (NMDeviceWifi *device, NMAccessPoint *ap);
-	void (*access_point_removed) (NMDeviceWifi *device, NMAccessPoint *ap);
-
-	/* Padding for future expansion */
-	void (*_reserved1) (void);
-	void (*_reserved2) (void);
-	void (*_reserved3) (void);
-	void (*_reserved4) (void);
-	void (*_reserved5) (void);
-	void (*_reserved6) (void);
-} NMDeviceWifiClass;
-
-
-
+nm_device_wifi_get_mode ()
+NM80211Mode
+nm_device_wifi_get_mode (NMDeviceWifi *device);
+Gets the NMDeviceWifi mode.
+
+Parameters
+
+++++
+
+
+
+
+
+



device a NMDeviceWifi  
+
+
+Returns
+ the mode
+
+
 
 
 
-nm_device_wifi_new ()
-GObject *           nm_device_wifi_new                  (DBusGConnection *connection,
-                                                         const char *path);
-
-Creates a new NMDeviceWifi.
-
-
+nm_device_wifi_get_bitrate ()
+guint32
+nm_device_wifi_get_bitrate (NMDeviceWifi *device);
+Gets the bit rate of the NMDeviceWifi.
+
+Parameters
+
--+++
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
 





 connection : the DBusGConnection
-
path : the DBus object path of the device
Returns : a new WiFi device. [transfer full]
-
device a NMDeviceWifi  
 
 
+
+Returns
+ the bit rate
+
+
+
 
 
-nm_device_wifi_get_hw_address ()
-const char *        nm_device_wifi_get_hw_address       (NMDeviceWifi *device);
-
-Gets the actual hardware (MAC) address of the NMDeviceWifi
-
-
+nm_device_wifi_get_capabilities ()
+NMDeviceWifiCapabilities
+nm_device_wifi_get_capabilities (NMDeviceWifi *device);
+Gets the WIFI capabilities of the NMDeviceWifi.
+
+Parameters
+
--+++
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
 





 device : a NMDeviceWifi
-
Returns : the actual hardware address. This is the internal string used by the
-device, and must not be modified.
device a NMDeviceWifi  
 
 
+
+Returns
+ the capabilities
+
+
+
 
 
-nm_device_wifi_get_permanent_hw_address ()
-const char *        nm_device_wifi_get_permanent_hw_address
-                                                        (NMDeviceWifi *device);
-
-Gets the permanent hardware (MAC) address of the NMDeviceWifi
-
-
+nm_device_wifi_get_active_access_point ()
+NMAccessPoint *
+nm_device_wifi_get_active_access_point
+                               (NMDeviceWifi *device);
+Gets the active NMAccessPoint.
+
+Parameters
+
--+++
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
 





 device : a NMDeviceWifi
-
Returns : the permanent hardware address. This is the internal string used by the
-device, and must not be modified.
device a NMDeviceWifi  
 
 
+
+Returns
+ the access point or NULL if none is active. 
+[transfer none]
+
+

nm_device_wifi_get_mode ()

NM80211Mode         nm_device_wifi_get_mode             (NMDeviceWifi *device);

-Gets the NMDeviceWifi mode. -

nm_device_wifi_get_access_point_by_path ()

NMAccessPoint *
+nm_device_wifi_get_access_point_by_path
+                               (NMDeviceWifi *device,
+                                const char *path);

Gets a NMAccessPoint by path.

Parameters

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

`device` :	a NMDeviceWifi -	device	a NMDeviceWifi
Returns :	the mode	path	the object path of the access point

Returns

the access point or NULL if none is found.

[transfer none]

nm_device_wifi_get_bitrate ()

guint32             nm_device_wifi_get_bitrate          (NMDeviceWifi *device);

-Gets the bit rate of the NMDeviceWifi. -

nm_device_wifi_get_access_points ()

const GPtrArray *
+nm_device_wifi_get_access_points (NMDeviceWifi *device);

Gets all the scanned access points of the NMDeviceWifi.

Parameters

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

`device` :	a NMDeviceWifi -
Returns :	the bit rate
device	a NMDeviceWifi

Returns

a GPtrArray containing all the +scanned NMAccessPoints. +The returned array is owned by the client and should not be modified.

[element-type NMClient.AccessPoint]

nm_device_wifi_get_capabilities ()

NMDeviceWifiCapabilities nm_device_wifi_get_capabilities
-                                                        (NMDeviceWifi *device);

NMDeviceWifiRequestScanFn ()

void
+(*NMDeviceWifiRequestScanFn) (NMDeviceWifi *device,
+                              GError *error,
+                              gpointer user_data);

-Gets the WIFI capabilities of the NMDeviceWifi.

+ +

nm_device_wifi_request_scan_simple ()

void
+nm_device_wifi_request_scan_simple (NMDeviceWifi *device,
+                                    NMDeviceWifiRequestScanFn callback,
+                                    gpointer user_data);

Request NM to scan for access points on the NMDeviceWifi. This function only +instructs NM to perform scanning. Use nm_device_wifi_get_access_points() +to get available access points.

Parameters

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

`device` :	a NMDeviceWifi -	device	a NMDeviceWifi
Returns :	the capabilities	callback	the function to call when the call is done.	[scope async][allow-none]
user_data	user data to pass to the callback function.	[closure]

Since 0.9.8

Types and Values

nm_device_wifi_get_active_access_point ()

NMAccessPoint *     nm_device_wifi_get_active_access_point
-                                                        (NMDeviceWifi *device);

-Gets the active NMAccessPoint. -

enum NMDeviceWifiError

Members

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

`device` :	a NMDeviceWifi +	NM_DEVICE_WIFI_ERROR_UNKNOWN	+ unknown or unclassified error
Returns :	the access point or `NULL` if none is active. [transfer none] +	NM_DEVICE_WIFI_ERROR_NOT_WIFI_CONNECTION	+ the connection was not of Wi-Fi type

nm_device_wifi_get_access_point_by_path ()

NMAccessPoint *     nm_device_wifi_get_access_point_by_path
-                                                        (NMDeviceWifi *device,
-                                                         const char *path);

-Gets a NMAccessPoint by path. -

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

`device` :	a NMDeviceWifi +	NM_DEVICE_WIFI_ERROR_INVALID_WIFI_CONNECTION	+ the Wi-Fi connection was invalid
`path` :	the object path of the access point	NM_DEVICE_WIFI_ERROR_INVALID_DEVICE_MAC	+ the device's MAC was invalid +
Returns :	the access point or `NULL` if none is found. [transfer none] +	NM_DEVICE_WIFI_ERROR_MAC_MISMATCH	+ the MACs of the connection and the device mismatched

nm_device_wifi_get_access_points ()

const GPtrArray *   nm_device_wifi_get_access_points    (NMDeviceWifi *device);

-Gets all the scanned access points of the NMDeviceWifi. -

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

`device` :	a NMDeviceWifi +	NM_DEVICE_WIFI_ERROR_MISSING_DEVICE_WPA_CAPS	+ the device missed WPA capabilities +required by the connection
Returns :	a GPtrArray containing all the -scanned NMAccessPoints. -The returned array is owned by the client and should not be modified. [element-type NMClient.AccessPoint] +	NM_DEVICE_WIFI_ERROR_MISSING_DEVICE_RSN_CAPS	+ the device missed RSN capabilities +required by the connection

NMDeviceWifiRequestScanFn ()

void                (*NMDeviceWifiRequestScanFn)        (NMDeviceWifi *device,
-                                                         GError *error,
-                                                         gpointer user_data);

NM_DEVICE_WIFI_ERROR

#define NM_DEVICE_WIFI_ERROR nm_device_wifi_error_quark ()
+

nm_device_wifi_request_scan_simple ()

void                nm_device_wifi_request_scan_simple  (NMDeviceWifi *device,
-                                                         NMDeviceWifiRequestScanFn callback,
-                                                         gpointer user_data);

NM_DEVICE_WIFI_HW_ADDRESS

#define NM_DEVICE_WIFI_HW_ADDRESS          "hw-address"
+

-Request NM to scan for access points on the NMDeviceWifi. This function only -instructs NM to perform scanning. Use nm_device_wifi_get_access_points() -to get available access points.

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

`device` :	a NMDeviceWifi -
`callback` :	the function to call when the call is done. [scope async][allow-none] -
`user_data` :	user data to pass to the callback function. [closure] -

Since 0.9.8

NM_DEVICE_WIFI_PERMANENT_HW_ADDRESS

#define NM_DEVICE_WIFI_PERMANENT_HW_ADDRESS "perm-hw-address"
+

Property Details

The `"active-access-point"` property

  "active-access-point"      NMAccessPoint*        : Read

NM_DEVICE_WIFI_MODE

#define NM_DEVICE_WIFI_MODE                "mode"
+

-The active NMAccessPoint of the device.

The `"bitrate"` property

  "bitrate"                  guint                 : Read

NM_DEVICE_WIFI_BITRATE

#define NM_DEVICE_WIFI_BITRATE             "bitrate"
+

-The bit rate of the device.

Default value: 0

The `"hw-address"` property

  "hw-address"               gchar*                : Read

NM_DEVICE_WIFI_ACTIVE_ACCESS_POINT

#define NM_DEVICE_WIFI_ACTIVE_ACCESS_POINT "active-access-point"
+

-The hardware (MAC) address of the device.

Default value: NULL

The `"mode"` property

  "mode"                     guint                 : Read

NM_DEVICE_WIFI_CAPABILITIES

#define NM_DEVICE_WIFI_CAPABILITIES        "wireless-capabilities"
+

-The mode of the device.

Property Details

The `“active-access-point”` property

  “active-access-point”      NMAccessPoint *

Active Access Point.

Flags: Read

The `“bitrate”` property

  “bitrate”                  guint

Bit Rate.

Flags: Read

Default value: 0

The `“hw-address”` property

  “hw-address”               gchar *

Currently set hardware MAC address.

Flags: Read

Default value: NULL

The `“mode”` property

  “mode”                     guint

Mode.

Flags: Read

Allowed values: <= 3

Default value: 2

The `"perm-hw-address"` property

  "perm-hw-address"          gchar*                : Read

-The hardware (MAC) address of the device. -

The `“perm-hw-address”` property

  “perm-hw-address”          gchar *

Permanent hardware MAC address.

Flags: Read

Default value: NULL

The `"wireless-capabilities"` property

  "wireless-capabilities"    guint                 : Read

-The wireless capabilities of the device. -

The `“wireless-capabilities”` property

  “wireless-capabilities”    guint

Wireless Capabilities.

Flags: Read

Default value: 0

Signal Details

The `"access-point-added"` signal

void                user_function                      (NMDeviceWifi *device,
-                                                        GObject      *ap,
-                                                        gpointer      user_data)      : Run First

-Notifies that a NMAccessPoint is added to the wifi device. -

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

`device` :	the wifi device that received the signal
`ap` :	the new access point
`user_data` :	user data set when the signal handler was connected.

The `“access-point-added”` signal

void
+user_function (NMDeviceWifi *device,
+               GObject      *ap,
+               gpointer      user_data)

Flags: Run First

The `"access-point-removed"` signal

void                user_function                      (NMDeviceWifi *device,
-                                                        GObject      *ap,
-                                                        gpointer      user_data)      : Run First

-Notifies that a NMAccessPoint is removed from the wifi device. -

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

`device` :	the wifi device that received the signal
`ap` :	the removed access point
`user_data` :	user data set when the signal handler was connected.

The `“access-point-removed”` signal

void
+user_function (NMDeviceWifi *device,
+               GObject      *ap,
+               gpointer      user_data)

Flags: Run First

+ Generated by GTK-Doc V1.20

\ No newline at end of file diff --git a/docs/libnm-glib/html/NMDeviceWimax.html b/docs/libnm-glib/html/NMDeviceWimax.html index 5cd1c4de..c496a2c6 100644 --- a/docs/libnm-glib/html/NMDeviceWimax.html +++ b/docs/libnm-glib/html/NMDeviceWimax.html @@ -2,38 +2,29 @@ -NMDeviceWimax +libnm-glib Reference Manual: NMDeviceWimax - + - - - - - - - - - -

			libnm-glib Reference Manual
-Top - \| - Description - \| - Object Hierarchy - \| - Implemented Interfaces - \| - Properties - \| - Signals -

+ + + + + + +

@@ -41,643 +32,745 @@

NMDeviceWimax

- +

Synopsis

enum                NMDeviceWimaxError;
-#define             NM_DEVICE_WIMAX_ERROR
-GQuark              nm_device_wimax_error_quark         (void);
-#define             NM_DEVICE_WIMAX_HW_ADDRESS
-#define             NM_DEVICE_WIMAX_ACTIVE_NSP
-#define             NM_DEVICE_WIMAX_CENTER_FREQUENCY
-#define             NM_DEVICE_WIMAX_RSSI
-#define             NM_DEVICE_WIMAX_CINR
-#define             NM_DEVICE_WIMAX_TX_POWER
-#define             NM_DEVICE_WIMAX_BSID
-                    NMDeviceWimax;
-                    NMDeviceWimaxClass;
-GObject *           nm_device_wimax_new                 (DBusGConnection *connection,
-                                                         const char *path);
-const char *        nm_device_wimax_get_hw_address      (NMDeviceWimax *wimax);
-NMWimaxNsp *        nm_device_wimax_get_active_nsp      (NMDeviceWimax *wimax);
-NMWimaxNsp *        nm_device_wimax_get_nsp_by_path     (NMDeviceWimax *wimax,
-                                                         const char *path);
-const GPtrArray *   nm_device_wimax_get_nsps            (NMDeviceWimax *wimax);
-guint               nm_device_wimax_get_center_frequency
-                                                        (NMDeviceWimax *self);
-gint                nm_device_wimax_get_rssi            (NMDeviceWimax *self);
-gint                nm_device_wimax_get_cinr            (NMDeviceWimax *self);
-gint                nm_device_wimax_get_tx_power        (NMDeviceWimax *self);
-const char *        nm_device_wimax_get_bsid            (NMDeviceWimax *self);
-

Object Hierarchy

-  GObject
-   +----NMObject
-         +----NMDevice
-               +----NMDeviceWimax
-

Implemented Interfaces

-NMDeviceWimax implements - GInitable and GAsyncInitable.

Properties

-  "active-nsp"               NMWimaxNsp*           : Read
-  "bsid"                     gchar*                : Read
-  "center-frequency"         guint                 : Read
-  "cinr"                     gint                  : Read
-  "hw-address"               gchar*                : Read
-  "rssi"                     gint                  : Read
-  "tx-power"                 gint                  : Read
-

Signals

-  "nsp-added"                                      : Run First
-  "nsp-removed"                                    : Run First
-

Description

Details

enum NMDeviceWimaxError

typedef enum {
-	NM_DEVICE_WIMAX_ERROR_UNKNOWN = 0,              /*< nick=UnknownError >*/
-	NM_DEVICE_WIMAX_ERROR_NOT_WIMAX_CONNECTION,     /*< nick=NotWimaxConnection >*/
-	NM_DEVICE_WIMAX_ERROR_INVALID_WIMAX_CONNECTION, /*< nick=InvalidWimaxConnection >*/
-	NM_DEVICE_WIMAX_ERROR_INVALID_DEVICE_MAC,       /*< nick=InvalidDeviceMac >*/
-	NM_DEVICE_WIMAX_ERROR_MAC_MISMATCH,             /*< nick=MacMismatch >*/
-} NMDeviceWimaxError;
-

Functions

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

`NM_DEVICE_WIMAX_ERROR_UNKNOWN`	unknown or unclassified error +	+GQuark +	+nm_device_wimax_error_quark ()
`NM_DEVICE_WIMAX_ERROR_NOT_WIMAX_CONNECTION`	the connection was not of WiMax type +	+GObject * +	+nm_device_wimax_new ()
`NM_DEVICE_WIMAX_ERROR_INVALID_WIMAX_CONNECTION`	the WiMax connection was invalid +	const char * +	+nm_device_wimax_get_hw_address ()
`NM_DEVICE_WIMAX_ERROR_INVALID_DEVICE_MAC`	the device's MAC was invalid +	+NMWimaxNsp * +	+nm_device_wimax_get_active_nsp ()
`NM_DEVICE_WIMAX_ERROR_MAC_MISMATCH`	the MACs of the connection and the device mismatched +	+NMWimaxNsp * +	+nm_device_wimax_get_nsp_by_path ()

NM_DEVICE_WIMAX_ERROR

#define NM_DEVICE_WIMAX_ERROR nm_device_wimax_error_quark ()
-

nm_device_wimax_error_quark ()

GQuark              nm_device_wimax_error_quark         (void);

-Registers an error quark for NMDeviceWimax if necessary. -

---- - - - - -

Returns :

the error quark used for NMDeviceWimax errors.

NM_DEVICE_WIMAX_HW_ADDRESS

#define NM_DEVICE_WIMAX_HW_ADDRESS       "hw-address"
-

NM_DEVICE_WIMAX_ACTIVE_NSP

#define NM_DEVICE_WIMAX_ACTIVE_NSP       "active-nsp"
-

NM_DEVICE_WIMAX_CENTER_FREQUENCY

#define NM_DEVICE_WIMAX_CENTER_FREQUENCY "center-frequency"
-

NM_DEVICE_WIMAX_RSSI

#define NM_DEVICE_WIMAX_RSSI             "rssi"
-

NM_DEVICE_WIMAX_CINR

#define NM_DEVICE_WIMAX_CINR             "cinr"
-

NM_DEVICE_WIMAX_TX_POWER

#define NM_DEVICE_WIMAX_TX_POWER         "tx-power"
-

NM_DEVICE_WIMAX_BSID

#define NM_DEVICE_WIMAX_BSID             "bsid"
-

NMDeviceWimax

typedef struct _NMDeviceWimax NMDeviceWimax;

NMDeviceWimaxClass

typedef struct {
-	NMDeviceClass parent;
-
-	/* Signals */
-	void (*nsp_added)   (NMDeviceWimax *self, NMWimaxNsp *nsp);
-	void (*nsp_removed) (NMDeviceWimax *self, NMWimaxNsp *nsp);
-} NMDeviceWimaxClass;
-

nm_device_wimax_new ()

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

-Creates a new NMDeviceWimax. -

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

`connection` :	the DBusGConnection +	const GPtrArray * +	+nm_device_wimax_get_nsps ()
`path` :	the D-Bus object path of the WiMAX device	+guint +	+nm_device_wimax_get_center_frequency () +
Returns :	a new WiMAX device. [transfer full] +	+gint +	+nm_device_wimax_get_rssi () +
+gint +	+nm_device_wimax_get_cinr () +
+gint +	+nm_device_wimax_get_tx_power () +
const char * +	+nm_device_wimax_get_bsid ()

nm_device_wimax_get_hw_address ()

const char *        nm_device_wimax_get_hw_address      (NMDeviceWimax *wimax);

-Gets the hardware (MAC) address of the NMDeviceWimax -

Properties

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

`wimax` :	a NMDeviceWimax -	+NMWimaxNsp *	active-nsp	Read
+gchar *	bsid	Read
guint	center-frequency	Read
gint	cinr	Read
+gchar *	hw-address	Read
Returns :	the hardware address. This is the internal string used by the -device, and must not be modified.	gint	rssi	Read
gint	tx-power	Read

nm_device_wimax_get_active_nsp ()

NMWimaxNsp *        nm_device_wimax_get_active_nsp      (NMDeviceWimax *wimax);

-Gets the active NMWimaxNsp. -

Signals

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

`wimax` :	a NMDeviceWimax -	void	nsp-added	Run First
Returns :	the access point or `NULL` if none is active. [transfer full] -	void	nsp-removed	Run First

nm_device_wimax_get_nsp_by_path ()

NMWimaxNsp *        nm_device_wimax_get_nsp_by_path     (NMDeviceWimax *wimax,
-                                                         const char *path);

-Gets a NMWimaxNsp by path. -

Types and Values

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

`wimax` :	a NMDeviceWimax -	enum	NMDeviceWimaxError
`path` :	the object path of the NSP	#define	NM_DEVICE_WIMAX_ERROR
Returns :	the access point or `NULL` if none is found. [transfer none] -	#define	NM_DEVICE_WIMAX_HW_ADDRESS
#define	NM_DEVICE_WIMAX_ACTIVE_NSP
#define	NM_DEVICE_WIMAX_CENTER_FREQUENCY
#define	NM_DEVICE_WIMAX_RSSI
#define	NM_DEVICE_WIMAX_CINR
#define	NM_DEVICE_WIMAX_TX_POWER
#define	NM_DEVICE_WIMAX_BSID

nm_device_wimax_get_nsps ()

const GPtrArray *   nm_device_wimax_get_nsps            (NMDeviceWimax *wimax);

Object Hierarchy

    GObject
+    ╰── NMObject
+        ╰── NMDevice
+            ╰── NMDeviceWimax
+

Description

-Gets all the scanned NSPs of the NMDeviceWimax.

+ +

Functions

nm_device_wimax_error_quark ()

GQuark
+nm_device_wimax_error_quark (void);

Registers an error quark for NMDeviceWimax if necessary.

Returns

the error quark used for NMDeviceWimax errors.

nm_device_wimax_new ()

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

Creates a new NMDeviceWimax.

Parameters

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

`wimax` :	a NMDeviceWimax -	connection	the DBusGConnection
Returns :	a GPtrArray containing -all the scanned NMWimaxNsps. -The returned array is owned by the client and should not be modified. [element-type NMClient.WimaxNsp] -	path	the D-Bus object path of the WiMAX device

Returns

a new WiMAX device.

[transfer full]

nm_device_wimax_get_center_frequency ()

guint               nm_device_wimax_get_center_frequency
-                                                        (NMDeviceWimax *self);

-Gets the center frequency (in KHz) of the radio channel the device is using -to communicate with the network when connected. Has no meaning when the -device is not connected. -

nm_device_wimax_get_hw_address ()

const char *
+nm_device_wimax_get_hw_address (NMDeviceWimax *wimax);

Gets the hardware (MAC) address of the NMDeviceWimax

Parameters

+++++ + + + + + +

wimax

Returns

the hardware address. This is the internal string used by the +device, and must not be modified.

nm_device_wimax_get_active_nsp ()

NMWimaxNsp *
+nm_device_wimax_get_active_nsp (NMDeviceWimax *wimax);

Gets the active NMWimaxNsp.

Parameters

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

wimax

Returns

the access point or NULL if none is active.

[transfer full]

nm_device_wimax_get_nsp_by_path ()

NMWimaxNsp *
+nm_device_wimax_get_nsp_by_path (NMDeviceWimax *wimax,
+                                 const char *path);

Gets a NMWimaxNsp by path.

Parameters

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

`self` :	a NMDeviceWimax -	wimax	a NMDeviceWimax
Returns :	the center frequency in KHz, or 0	path	the object path of the NSP

Returns

the access point or NULL if none is found.

[transfer none]

nm_device_wimax_get_rssi ()

gint                nm_device_wimax_get_rssi            (NMDeviceWimax *self);

-Gets the RSSI of the current radio link in dBm. This value indicates how +

nm_device_wimax_get_nsps ()

const GPtrArray *
+nm_device_wimax_get_nsps (NMDeviceWimax *wimax);

Gets all the scanned NSPs of the NMDeviceWimax.

Parameters

+++++ + + + + + +

wimax

Returns

a GPtrArray containing +all the scanned NMWimaxNsps. +The returned array is owned by the client and should not be modified.

[element-type NMClient.WimaxNsp]

nm_device_wimax_get_center_frequency ()

guint
+nm_device_wimax_get_center_frequency (NMDeviceWimax *self);

Gets the center frequency (in KHz) of the radio channel the device is using +to communicate with the network when connected. Has no meaning when the +device is not connected.

Parameters

+++++ + + + + + +

self

Returns

the center frequency in KHz, or 0

nm_device_wimax_get_rssi ()

gint
+nm_device_wimax_get_rssi (NMDeviceWimax *self);

Gets the RSSI of the current radio link in dBm. This value indicates how strong the raw received RF signal from the base station is, but does not indicate the overall quality of the radio link. Has no meaning when the -device is not connected. -

+device is not connected.

Parameters

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

`self` :	a NMDeviceWimax -
Returns :	the RSSI in dBm, or 0
self	a NMDeviceWimax

Returns

the RSSI in dBm, or 0

nm_device_wimax_get_cinr ()

gint                nm_device_wimax_get_cinr            (NMDeviceWimax *self);

-Gets the CINR (Carrier to Interference + Noise Ratio) of the current radio +

nm_device_wimax_get_cinr ()

gint
+nm_device_wimax_get_cinr (NMDeviceWimax *self);

Gets the CINR (Carrier to Interference + Noise Ratio) of the current radio link in dB. CINR is a more accurate measure of radio link quality. Has no -meaning when the device is not connected. -

+meaning when the device is not connected.

Parameters

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

`self` :	a NMDeviceWimax -
Returns :	the CINR in dB, or 0
self	a NMDeviceWimax

Returns

the CINR in dB, or 0

nm_device_wimax_get_tx_power ()

gint                nm_device_wimax_get_tx_power        (NMDeviceWimax *self);

-Average power of the last burst transmitted by the device, in units of +

nm_device_wimax_get_tx_power ()

gint
+nm_device_wimax_get_tx_power (NMDeviceWimax *self);

Average power of the last burst transmitted by the device, in units of 0.5 dBm. i.e. a TxPower of -11 represents an actual device TX power of --5.5 dBm. Has no meaning when the device is not connected. -

+-5.5 dBm. Has no meaning when the device is not connected.

Parameters

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

`self` :	a NMDeviceWimax -
Returns :	the TX power in dBm, or 0
self	a NMDeviceWimax

Returns

the TX power in dBm, or 0

nm_device_wimax_get_bsid ()

const char *        nm_device_wimax_get_bsid            (NMDeviceWimax *self);

-Gets the ID of the serving Base Station when the device is connected. -

nm_device_wimax_get_bsid ()

const char *
+nm_device_wimax_get_bsid (NMDeviceWimax *self);

Gets the ID of the serving Base Station when the device is connected.

Parameters

+++++ + + + + + +

self

Returns

the ID of the serving Base Station, or NULL

Types and Values

enum NMDeviceWimaxError

Members

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

`self` :	a NMDeviceWimax +	NM_DEVICE_WIMAX_ERROR_UNKNOWN	+ unknown or unclassified error
Returns :	the ID of the serving Base Station, or `NULL` +	NM_DEVICE_WIMAX_ERROR_NOT_WIMAX_CONNECTION	+ the connection was not of WiMax type
NM_DEVICE_WIMAX_ERROR_INVALID_WIMAX_CONNECTION	+ the WiMax connection was invalid +
NM_DEVICE_WIMAX_ERROR_INVALID_DEVICE_MAC	+ the device's MAC was invalid +
NM_DEVICE_WIMAX_ERROR_MAC_MISMATCH	+ the MACs of the connection and the device mismatched +

Property Details

The `"active-nsp"` property

  "active-nsp"               NMWimaxNsp*           : Read

NM_DEVICE_WIMAX_ERROR

#define NM_DEVICE_WIMAX_ERROR nm_device_wimax_error_quark ()
+

-The active NMWimaxNsp of the device.

The `"bsid"` property

  "bsid"                     gchar*                : Read

NM_DEVICE_WIMAX_HW_ADDRESS

#define NM_DEVICE_WIMAX_HW_ADDRESS       "hw-address"
+

-The ID of the serving base station as received from the network. Has -no meaning when the device is not connected.

Default value: NULL

The `"center-frequency"` property

  "center-frequency"         guint                 : Read

NM_DEVICE_WIMAX_ACTIVE_NSP

#define NM_DEVICE_WIMAX_ACTIVE_NSP       "active-nsp"
+

-The center frequency (in KHz) of the radio channel the device is using to -communicate with the network when connected. Has no meaning when the -device is not connected.

Default value: 0

The `"cinr"` property

  "cinr"                     gint                  : Read

NM_DEVICE_WIMAX_CENTER_FREQUENCY

#define NM_DEVICE_WIMAX_CENTER_FREQUENCY "center-frequency"
+

-CINR (Carrier to Interference + Noise Ratio) of the current radio link -in dB. CINR is a more accurate measure of radio link quality. Has no -meaning when the device is not connected.

Default value: 0

The `"hw-address"` property

  "hw-address"               gchar*                : Read

NM_DEVICE_WIMAX_RSSI

#define NM_DEVICE_WIMAX_RSSI             "rssi"
+

-The hardware (MAC) address of the device.

Default value: NULL

The `"rssi"` property

  "rssi"                     gint                  : Read

NM_DEVICE_WIMAX_CINR

#define NM_DEVICE_WIMAX_CINR             "cinr"
+

-RSSI of the current radio link in dBm. This value indicates how strong -the raw received RF signal from the base station is, but does not -indicate the overall quality of the radio link. Has no meaning when the -device is not connected.

Default value: 0

The `"tx-power"` property

  "tx-power"                 gint                  : Read

NM_DEVICE_WIMAX_TX_POWER

#define NM_DEVICE_WIMAX_TX_POWER         "tx-power"
+

NM_DEVICE_WIMAX_BSID

#define NM_DEVICE_WIMAX_BSID             "bsid"
+

-Average power of the last burst transmitted by the device, in units of -0.5 dBm. i.e. a TxPower of -11 represents an actual device TX power of --5.5 dBm. Has no meaning when the device is not connected.

Property Details

The `“active-nsp”` property

  “active-nsp”               NMWimaxNsp *

Active NSP.

Flags: Read

The `“bsid”` property

  “bsid”                     gchar *

BSID.

Flags: Read

Default value: NULL

The `“center-frequency”` property

  “center-frequency”         guint

Center frequency.

Flags: Read

Default value: 0

The `“cinr”` property

  “cinr”                     gint

CINR.

Flags: Read

Default value: 0

The `“hw-address”` property

  “hw-address”               gchar *

Hardware MAC address.

Flags: Read

Default value: NULL

The `“rssi”` property

  “rssi”                     gint

RSSI.

Flags: Read

Default value: 0

The `“tx-power”` property

  “tx-power”                 gint

TX Power.

Flags: Read

Default value: 0

Signal Details

The `"nsp-added"` signal

void                user_function                      (NMDeviceWimax *self,
-                                                        GObject       *nsp,
-                                                        gpointer       user_data)      : Run First

-Notifies that a NMWimaxNsp is added to the wimax device. -

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

`self` :	the wimax device that received the signal
`nsp` :	the new NSP
`user_data` :	user data set when the signal handler was connected.

The `“nsp-added”` signal

void
+user_function (NMDeviceWimax *self,
+               GObject       *nsp,
+               gpointer       user_data)

Flags: Run First

The `"nsp-removed"` signal

void                user_function                      (NMDeviceWimax *self,
-                                                        GObject       *nsp,
-                                                        gpointer       user_data)      : Run First

-Notifies that a NMWimaxNsp is removed from the wimax device. -

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

`self` :	the wimax device that received the signal
`nsp` :	the removed NSP
`user_data` :	user data set when the signal handler was connected.

The `“nsp-removed”` signal

void
+user_function (NMDeviceWimax *self,
+               GObject       *nsp,
+               gpointer       user_data)

Flags: Run First

+ Generated by GTK-Doc V1.20

\ No newline at end of file diff --git a/docs/libnm-glib/html/NMIP4Config.html b/docs/libnm-glib/html/NMIP4Config.html index 7aa6f67d..4c5fbe76 100644 --- a/docs/libnm-glib/html/NMIP4Config.html +++ b/docs/libnm-glib/html/NMIP4Config.html @@ -2,36 +2,28 @@ -NMIP4Config +libnm-glib Reference Manual: NMIP4Config - + - - - - - - - - - -

			libnm-glib Reference Manual
-Top - \| - Description - \| - Object Hierarchy - \| - Implemented Interfaces - \| - Properties -

+ + + + + + +

@@ -39,334 +31,405 @@

NMIP4Config

- +

Synopsis

                    NMIP4Config;
-                    NMIP4ConfigClass;
-#define             NM_IP4_CONFIG_ADDRESSES
-#define             NM_IP4_CONFIG_NAMESERVERS
-#define             NM_IP4_CONFIG_DOMAINS
-#define             NM_IP4_CONFIG_ROUTES
-#define             NM_IP4_CONFIG_WINS_SERVERS
-GObject *           nm_ip4_config_new                   (DBusGConnection *connection,
-                                                         const char *object_path);
-const GSList *      nm_ip4_config_get_addresses         (NMIP4Config *config);
-const GArray *      nm_ip4_config_get_nameservers       (NMIP4Config *config);
-const GPtrArray *   nm_ip4_config_get_domains           (NMIP4Config *config);
-const GSList *      nm_ip4_config_get_routes            (NMIP4Config *config);
-const GArray *      nm_ip4_config_get_wins_servers      (NMIP4Config *config);
-

Object Hierarchy

-  GObject
-   +----NMObject
-         +----NMIP4Config
-

Implemented Interfaces

-NMIP4Config implements - GInitable and GAsyncInitable.

Properties

-  "addresses"                gpointer              : Read
-  "domains"                  NMStringArray*        : Read
-  "nameservers"              NMUintArray*          : Read
-  "routes"                   gpointer              : Read
-  "wins-servers"             NMUintArray*          : Read
-

Description

Details

NMIP4Config

typedef struct _NMIP4Config NMIP4Config;

NMIP4ConfigClass

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

NM_IP4_CONFIG_ADDRESSES

#define NM_IP4_CONFIG_ADDRESSES "addresses"
-

NM_IP4_CONFIG_NAMESERVERS

#define NM_IP4_CONFIG_NAMESERVERS "nameservers"
-

NM_IP4_CONFIG_DOMAINS

#define NM_IP4_CONFIG_DOMAINS "domains"
-

NM_IP4_CONFIG_ROUTES

#define NM_IP4_CONFIG_ROUTES "routes"
-

NM_IP4_CONFIG_WINS_SERVERS

#define NM_IP4_CONFIG_WINS_SERVERS "wins-servers"
-

nm_ip4_config_new ()

GObject *           nm_ip4_config_new                   (DBusGConnection *connection,
-                                                         const char *object_path);

-Creates a new NMIP4Config. -

Functions

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

`connection` :	the DBusGConnection +	+GObject * +	+nm_ip4_config_new ()
`object_path` :	the DBus object path of the device	const GSList * +	+nm_ip4_config_get_addresses () +
Returns :	a new IP4 configuration. [transfer full] +	const GArray * +	+nm_ip4_config_get_nameservers ()

nm_ip4_config_get_addresses ()

const GSList *      nm_ip4_config_get_addresses         (NMIP4Config *config);

-Gets the IP4 addresses (containing the address, prefix, and gateway). -

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

`config` :	a NMIP4Config +	const GPtrArray * +	+nm_ip4_config_get_domains () +
const GSList * +	+nm_ip4_config_get_routes ()
Returns :	the GSList containing NMIP4Addresses. -This is the internal copy used by the configuration and must not be modified. [element-type NetworkManager.IP4Address] +	const GArray * +	+nm_ip4_config_get_wins_servers ()

nm_ip4_config_get_nameservers ()

const GArray *      nm_ip4_config_get_nameservers       (NMIP4Config *config);

-Gets the domain name servers (DNS). -

Properties

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

`config` :	a NMIP4Config -	gpointer	addresses	Read
Returns :	the GArray containing `guint32`s. This is the internal copy used by the -configuration and must not be modified. [element-type guint32] -	+NMStringArray *	domains	Read
+NMUintArray *	nameservers	Read
gpointer	routes	Read
+NMUintArray *	wins-servers	Read

nm_ip4_config_get_domains ()

const GPtrArray *   nm_ip4_config_get_domains           (NMIP4Config *config);

-Gets the domain names. -

Types and Values

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

`config` :	a NMIP4Config -	#define	NM_IP4_CONFIG_ADDRESSES
Returns :	the GPtrArray containing domains as strings. This is the -internal copy used by the configuration, and must not be modified. [element-type utf8] -	#define	NM_IP4_CONFIG_NAMESERVERS
#define	NM_IP4_CONFIG_DOMAINS
#define	NM_IP4_CONFIG_ROUTES
#define	NM_IP4_CONFIG_WINS_SERVERS

nm_ip4_config_get_routes ()

const GSList *      nm_ip4_config_get_routes            (NMIP4Config *config);

Object Hierarchy

    GObject
+    ╰── NMObject
+        ╰── NMIP4Config
+

Description

-Gets the routes.

+ +

Functions

nm_ip4_config_new ()

GObject *
+nm_ip4_config_new (DBusGConnection *connection,
+                   const char *object_path);

Creates a new NMIP4Config.

Parameters

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

`config` :	a NMIP4Config -	connection	the DBusGConnection
Returns :	the GSList containing -NMIP4Routes. This is the internal copy used by the configuration, -and must not be modified. [element-type NetworkManager.IP4Route] -	object_path	the DBus object path of the device

Returns

a new IP4 configuration.

[transfer full]

nm_ip4_config_get_wins_servers ()

const GArray *      nm_ip4_config_get_wins_servers      (NMIP4Config *config);

-Gets the Windows Internet Name Service servers (WINS). -

nm_ip4_config_get_addresses ()

const GSList *
+nm_ip4_config_get_addresses (NMIP4Config *config);

Gets the IP4 addresses (containing the address, prefix, and gateway).

Parameters

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

`config` :	a NMIP4Config -
Returns :	the GArray containing `guint32`s. -This is the internal copy used by the configuration and must not be modified. [element-type guint32] -
config	a NMIP4Config

Returns

the GSList containing NMIP4Addresses. +This is the internal copy used by the configuration and must not be modified.

[element-type NetworkManager.IP4Address]

nm_ip4_config_get_nameservers ()

const GArray *
+nm_ip4_config_get_nameservers (NMIP4Config *config);

Gets the domain name servers (DNS).

Parameters

+++++ + + + + + +

config

Returns

the GArray containing guint32s. This is the internal copy used by the +configuration and must not be modified.

[element-type guint32]

nm_ip4_config_get_domains ()

const GPtrArray *
+nm_ip4_config_get_domains (NMIP4Config *config);

Gets the domain names.

Parameters

+++++ + + + + + +

config

Returns

the GPtrArray containing domains as strings. This is the +internal copy used by the configuration, and must not be modified.

[element-type utf8]

nm_ip4_config_get_routes ()

const GSList *
+nm_ip4_config_get_routes (NMIP4Config *config);

Gets the routes.

Parameters

+++++ + + + + +

config

Returns

the GSList containing +NMIP4Routes. This is the internal copy used by the configuration, +and must not be modified.

[element-type NetworkManager.IP4Route]

nm_ip4_config_get_wins_servers ()

const GArray *
+nm_ip4_config_get_wins_servers (NMIP4Config *config);

Gets the Windows Internet Name Service servers (WINS).

Parameters

+++++ + + + + + +

config

Returns

the GArray containing guint32s. +This is the internal copy used by the configuration and must not be modified.

[element-type guint32]

Property Details

Types and Values

The `"addresses"` property

  "addresses"                gpointer              : Read

NM_IP4_CONFIG_ADDRESSES

#define NM_IP4_CONFIG_ADDRESSES "addresses"
+

-The GPtrArray containing NMSettingIP4Addresses of the configuration.

The `"domains"` property

  "domains"                  NMStringArray*        : Read

NM_IP4_CONFIG_NAMESERVERS

#define NM_IP4_CONFIG_NAMESERVERS "nameservers"
+

-The GPtrArray containing domain strings of the configuration.

The `"nameservers"` property

  "nameservers"              NMUintArray*          : Read

NM_IP4_CONFIG_DOMAINS

#define NM_IP4_CONFIG_DOMAINS "domains"
+

-The GArray containing name servers (guint32es) of the configuration.

The `"routes"` property

  "routes"                   gpointer              : Read

NM_IP4_CONFIG_ROUTES

#define NM_IP4_CONFIG_ROUTES "routes"
+

-The GPtrArray containing NMSettingIP4Routes of the configuration.

The `"wins-servers"` property

  "wins-servers"             NMUintArray*          : Read

NM_IP4_CONFIG_WINS_SERVERS

#define NM_IP4_CONFIG_WINS_SERVERS "wins-servers"
+

-The GArray containing WINS servers (guint32es) of the configuration.

Property Details

The `“addresses”` property

  “addresses”                gpointer

Addresses.

Flags: Read

The `“domains”` property

  “domains”                  NMStringArray *

Domains.

Flags: Read

The `“nameservers”` property

  “nameservers”              NMUintArray *

Nameservers.

Flags: Read

The `“routes”` property

  “routes”                   gpointer

Routes.

Flags: Read

The `“wins-servers”` property

  “wins-servers”             NMUintArray *

WINS Servers.

Flags: Read

+ Generated by GTK-Doc V1.20 \ No newline at end of file diff --git a/docs/libnm-glib/html/NMIP6Config.html b/docs/libnm-glib/html/NMIP6Config.html index 67518a3d..4d918c54 100644 --- a/docs/libnm-glib/html/NMIP6Config.html +++ b/docs/libnm-glib/html/NMIP6Config.html @@ -2,36 +2,28 @@ -NMIP6Config +libnm-glib Reference Manual: NMIP6Config - + - - - - - - - - - -

			libnm-glib Reference Manual
-Top - \| - Description - \| - Object Hierarchy - \| - Implemented Interfaces - \| - Properties -

+ + + + + + +

@@ -39,294 +31,349 @@

NMIP6Config

- +

Synopsis

                    NMIP6Config;
-                    NMIP6ConfigClass;
-#define             NM_IP6_CONFIG_ADDRESSES
-#define             NM_IP6_CONFIG_NAMESERVERS
-#define             NM_IP6_CONFIG_DOMAINS
-#define             NM_IP6_CONFIG_ROUTES
-GObject *           nm_ip6_config_new                   (DBusGConnection *connection,
-                                                         const char *object_path);
-const GSList *      nm_ip6_config_get_addresses         (NMIP6Config *config);
-const GSList *      nm_ip6_config_get_nameservers       (NMIP6Config *config);
-const GPtrArray *   nm_ip6_config_get_domains           (NMIP6Config *config);
-const GSList *      nm_ip6_config_get_routes            (NMIP6Config *config);
-

Object Hierarchy

-  GObject
-   +----NMObject
-         +----NMIP6Config
-

Implemented Interfaces

-NMIP6Config implements - GInitable and GAsyncInitable.

Properties

-  "addresses"                NMIP6AddressObjectArray*  : Read
-  "domains"                  NMStringArray*        : Read
-  "nameservers"              NMIP6AddressArray*    : Read
-  "routes"                   NMIP6RouteObjectArray*  : Read
-

Description

Details

NMIP6Config

typedef struct _NMIP6Config NMIP6Config;

NMIP6ConfigClass

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

NM_IP6_CONFIG_ADDRESSES

#define NM_IP6_CONFIG_ADDRESSES "addresses"
-

NM_IP6_CONFIG_NAMESERVERS

#define NM_IP6_CONFIG_NAMESERVERS "nameservers"
-

NM_IP6_CONFIG_DOMAINS

#define NM_IP6_CONFIG_DOMAINS "domains"
-

NM_IP6_CONFIG_ROUTES

#define NM_IP6_CONFIG_ROUTES "routes"
-

nm_ip6_config_new ()

GObject *           nm_ip6_config_new                   (DBusGConnection *connection,
-                                                         const char *object_path);

-Creates a new NMIP6Config. -

Functions

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

`connection` :	the DBusGConnection +	+GObject * +	+nm_ip6_config_new ()
`object_path` :	the DBus object path of the device	const GSList * +	+nm_ip6_config_get_addresses () +
Returns :	a new IP6 configuration. [transfer full] +	const GSList * +	+nm_ip6_config_get_nameservers ()

nm_ip6_config_get_addresses ()

const GSList *      nm_ip6_config_get_addresses         (NMIP6Config *config);

-Gets the IP6 addresses (containing the address, prefix, and gateway). -

---- - - - + - - +

`config` :	a NMIP6Config +	const GPtrArray * +	+nm_ip6_config_get_domains ()
Returns :	the GSList containing -NMIP6Addresses. This is the internal copy used by the configuration -and must not be modified. [element-type NetworkManager.IP6Address] +	const GSList * +	+nm_ip6_config_get_routes ()

nm_ip6_config_get_nameservers ()

const GSList *      nm_ip6_config_get_nameservers       (NMIP6Config *config);

-Gets the domain name servers (DNS). -

Properties

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

`config` :	a NMIP6Config -	+NMIP6AddressObjectArray *	addresses	Read
Returns :	a GSList containing elements of type 'struct in6_addr' which -contain the addresses of nameservers of the configuration. This is the -internal copy used by the configuration and must not be modified.	+NMStringArray *	domains	Read
+NMIP6AddressArray *	nameservers	Read
+NMIP6RouteObjectArray *	routes	Read

nm_ip6_config_get_domains ()

const GPtrArray *   nm_ip6_config_get_domains           (NMIP6Config *config);

-Gets the domain names. -

Types and Values

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

`config` :	a NMIP6Config -	#define	NM_IP6_CONFIG_ADDRESSES
Returns :	the GPtrArray containing domains as strings. -This is the internal copy used by the configuration, and must not be modified. [element-type utf8] -	#define	NM_IP6_CONFIG_NAMESERVERS
#define	NM_IP6_CONFIG_DOMAINS
#define	NM_IP6_CONFIG_ROUTES

nm_ip6_config_get_routes ()

const GSList *      nm_ip6_config_get_routes            (NMIP6Config *config);

Object Hierarchy

    GObject
+    ╰── NMObject
+        ╰── NMIP6Config
+

Description

-Gets the routes.

+ +

Functions

nm_ip6_config_new ()

GObject *
+nm_ip6_config_new (DBusGConnection *connection,
+                   const char *object_path);

Creates a new NMIP6Config.

Parameters

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

`config` :	a NMIP6Config -	connection	the DBusGConnection
Returns :	the GSList containing -NMIP6Routes. This is the internal copy used by the configuration, -and must not be modified. [element-type NetworkManager.IP6Route] -	object_path	the DBus object path of the device

Returns

a new IP6 configuration.

[transfer full]

nm_ip6_config_get_addresses ()

const GSList *
+nm_ip6_config_get_addresses (NMIP6Config *config);

Gets the IP6 addresses (containing the address, prefix, and gateway).

Parameters

+++++ + + + + + +

config

Returns

the GSList containing +NMIP6Addresses. This is the internal copy used by the configuration +and must not be modified.

[element-type NetworkManager.IP6Address]

nm_ip6_config_get_nameservers ()

const GSList *
+nm_ip6_config_get_nameservers (NMIP6Config *config);

Gets the domain name servers (DNS).

Parameters

+++++ + + + + + +

config

Returns

a GSList containing elements of type 'struct in6_addr' which +contain the addresses of nameservers of the configuration. This is the +internal copy used by the configuration and must not be modified.

nm_ip6_config_get_domains ()

const GPtrArray *
+nm_ip6_config_get_domains (NMIP6Config *config);

Gets the domain names.

Parameters

+++++ + + + + + +

config

Returns

the GPtrArray containing domains as strings. +This is the internal copy used by the configuration, and must not be modified.

[element-type utf8]

nm_ip6_config_get_routes ()

const GSList *
+nm_ip6_config_get_routes (NMIP6Config *config);

Gets the routes.

Parameters

+++++ + + + + + +

config

Returns

the GSList containing +NMIP6Routes. This is the internal copy used by the configuration, +and must not be modified.

[element-type NetworkManager.IP6Route]

Property Details

Types and Values

The `"addresses"` property

  "addresses"                NMIP6AddressObjectArray*  : Read

NM_IP6_CONFIG_ADDRESSES

#define NM_IP6_CONFIG_ADDRESSES "addresses"
+

-The GPtrArray containing the IPv6 addresses; use -nm_utils_ip6_addresses_from_gvalue() to return a GSList of -NMSettingIP6Address objects that is more usable than the raw data.

The `"domains"` property

  "domains"                  NMStringArray*        : Read

NM_IP6_CONFIG_NAMESERVERS

#define NM_IP6_CONFIG_NAMESERVERS "nameservers"
+

-The GPtrArray containing domain strings of the configuration.

The `"nameservers"` property

  "nameservers"              NMIP6AddressArray*    : Read

NM_IP6_CONFIG_DOMAINS

#define NM_IP6_CONFIG_DOMAINS "domains"
+

-The GPtrArray containing elements of type 'struct ip6_addr' which -contain the addresses of nameservers of the configuration.

The `"routes"` property

  "routes"                   NMIP6RouteObjectArray*  : Read

NM_IP6_CONFIG_ROUTES

#define NM_IP6_CONFIG_ROUTES "routes"
+

-The GPtrArray containing the IPv6 routes; use -nm_utils_ip6_routes_from_gvalue() to return a GSList of -NMSettingIP6Address objects that is more usable than the raw data.

Property Details

The `“addresses”` property

  “addresses”                NMIP6AddressObjectArray *

Addresses.

Flags: Read

The `“domains”` property

  “domains”                  NMStringArray *

Domains.

Flags: Read

The `“nameservers”` property

  “nameservers”              NMIP6AddressArray *

Nameservers.

Flags: Read

The `“routes”` property

  “routes”                   NMIP6RouteObjectArray *

Routes.

Flags: Read

+ Generated by GTK-Doc V1.20 \ No newline at end of file diff --git a/docs/libnm-glib/html/NMObject.html b/docs/libnm-glib/html/NMObject.html index 99b05001..6d3c8a09 100644 --- a/docs/libnm-glib/html/NMObject.html +++ b/docs/libnm-glib/html/NMObject.html @@ -2,38 +2,29 @@ -NMObject +libnm-glib Reference Manual: NMObject - + - - - - - - - - - -

			libnm-glib Reference Manual
-Top - \| - Description - \| - Object Hierarchy - \| - Implemented Interfaces - \| - Properties - \| - Signals -

+ + + + + + +

@@ -41,281 +32,286 @@

NMObject

- +

Synopsis

enum                NMObjectError;
-#define             NM_OBJECT_ERROR
-GQuark              nm_object_error_quark               (void);
-#define             NM_OBJECT_DBUS_CONNECTION
-#define             NM_OBJECT_DBUS_PATH
-                    NMObject;
-                    NMObjectClass;
-DBusGConnection *   nm_object_get_connection            (NMObject *object);
-const char *        nm_object_get_path                  (NMObject *object);
-

Object Hierarchy

-  GObject
-   +----NMObject
-         +----NMClient
-         +----NMDevice
-         +----NMWimaxNsp
-         +----NMAccessPoint
-         +----NMIP4Config
-         +----NMIP6Config
-         +----NMActiveConnection
-         +----NMDHCP4Config
-         +----NMDHCP6Config
-

Implemented Interfaces

-NMObject implements - GInitable and GAsyncInitable.

Functions

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

+GQuark +	+nm_object_error_quark () +
+DBusGConnection * +	+nm_object_get_connection () +
const char * +	+nm_object_get_path () +

Properties

-  "dbus-connection"          DBusGConnection*      : Read / Write / Construct Only
-  "dbus-path"                gchar*                : Read / Write / Construct Only
-

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

+DBusGConnection *	dbus-connection	Read / Write / Construct Only
+gchar *	dbus-path	Read / Write / Construct Only

Signals

-  "object-creation-failed"                         : Run First
-

Description

+++++ + + + + + +

void

object-creation-failed

Details

enum NMObjectError

typedef enum {
-	NM_OBJECT_ERROR_UNKNOWN = 0,
-	NM_OBJECT_ERROR_OBJECT_CREATION_FAILURE,
-} NMObjectError;
-

-Describes errors that may result from operations involving a NMObject. -

Types and Values

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

`NM_OBJECT_ERROR_UNKNOWN`	unknown or unclassified error -	enum	NMObjectError
`NM_OBJECT_ERROR_OBJECT_CREATION_FAILURE`	an error ocured while creating an NMObject -	#define	NM_OBJECT_ERROR
#define	NM_OBJECT_DBUS_CONNECTION
#define	NM_OBJECT_DBUS_PATH

NM_OBJECT_ERROR

#define NM_OBJECT_ERROR nm_object_error_quark ()
+
+Object Hierarchy
+    GObject
+    ╰── NMObject
+        ├── NMClient
+        ├── NMDevice
+        ├── NMWimaxNsp
+        ├── NMAccessPoint
+        ├── NMIP4Config
+        ├── NMIP6Config
+        ├── NMActiveConnection
+        ├── NMDHCP4Config
+        ╰── NMDHCP6Config
 
+
+
+Description
 
 
 
+
+Functions
+
+nm_object_error_quark ()
+GQuark
+nm_object_error_quark (void);
+Registers an error quark for NMObject if necessary.
+
+Returns
+ the error quark used for NMObject errors.
+
+
+
 
 
-nm_object_error_quark ()
-GQuark              nm_object_error_quark               (void);
-
-Registers an error quark for NMObject if necessary.
-
-
+nm_object_get_connection ()
+DBusGConnection *
+nm_object_get_connection (NMObject *object);
+Gets the NMObject's DBusGConnection.
+
+Parameters
+
--+++
-
-
+
+
+
 





 
 Returns : the error quark used for NMObject errors. object a NMObject  
 
 
 
-
-
-NM_OBJECT_DBUS_CONNECTION
-#define NM_OBJECT_DBUS_CONNECTION "dbus-connection"
-
-
-
+
+Returns
+ the connection. 
+[transfer none]
 
-
-
-NM_OBJECT_DBUS_PATH
-#define NM_OBJECT_DBUS_PATH "dbus-path"
-
-
-
 
 
 
-NMObject
-typedef struct _NMObject NMObject;
-
-
+nm_object_get_path ()
+const char *
+nm_object_get_path (NMObject *object);
+Gets the DBus path of the NMObject.
+
+Parameters
+
+++++
+
+
+
+
+
+



object a NMObject  
 
-
-
-NMObjectClass
-typedef struct {
-	GObjectClass parent;
-
-	/* Signals */
-	/* The "object-creation-failed" signal is PRIVATE for libnm-glib and
-	 * is not meant for any external usage.  It indicates that an error
-	 * occured during creation of an object.
-	 */
-	void (*object_creation_failed) (NMObject *master_object,
-	                                GError *error,
-	                                char *failed_path);
-
-	/* Padding for future expansion */
-	void (*_reserved1) (void);
-	void (*_reserved2) (void);
-	void (*_reserved3) (void);
-	void (*_reserved4) (void);
-	void (*_reserved5) (void);
-	void (*_reserved6) (void);
-} NMObjectClass;
-
-
-
+
+Returns
+ the object's path. This is the internal string used by the
+device, and must not be modified.
+
 
-
+
+
+
+Types and Values
 
-nm_object_get_connection ()
-DBusGConnection *   nm_object_get_connection            (NMObject *object);
-
-Gets the NMObject's DBusGConnection.
-
-
+enum NMObjectError
+Describes errors that may result from operations involving a NMObject.
+
+Members
+
--+++
-
-
+
+
-
-
+
+
 





 
 
 object : a NMObject
+ NM_OBJECT_ERROR_UNKNOWN 
+unknown or unclassified error
  
 
 Returns : the connection. [transfer none]
+ NM_OBJECT_ERROR_OBJECT_CREATION_FAILURE 
+an error ocured while creating an NMObject
  
 
 
 
 
+
 
 
-nm_object_get_path ()
-const char *        nm_object_get_path                  (NMObject *object);
+NM_OBJECT_ERROR
+#define NM_OBJECT_ERROR nm_object_error_quark ()
+
+
+
+
+
+
+NM_OBJECT_DBUS_CONNECTION
+#define NM_OBJECT_DBUS_CONNECTION "dbus-connection"
+
+
+
+
+
+
+NM_OBJECT_DBUS_PATH
+#define NM_OBJECT_DBUS_PATH "dbus-path"
+
 
-Gets the DBus path of the NMObject.
 
-
----
-
-
-
-
-
-
-
-
-
-
-


object : a NMObject
-
Returns : the object's path. This is the internal string used by the
-device, and must not be modified.
 
 
 
 Property Details
 
-The "dbus-connection" property
-  "dbus-connection"          DBusGConnection*      : Read / Write / Construct Only
+The “dbus-connection” property
+  “dbus-connection”          DBusGConnection *
 Connection.
+Flags: Read / Write / Construct Only
 
 
 
-The "dbus-path" property
-  "dbus-path"                gchar*                : Read / Write / Construct Only
+The “dbus-path” property
+  “dbus-path”                gchar *
 DBus Object Path.
+Flags: Read / Write / Construct Only
 Default value: NULL
 
 
 
 Signal Details
 
-The "object-creation-failed" signal
-void                user_function                      (NMObject *master_object,
-                                                        gpointer  error,
-                                                        gpointer  failed_path,
-                                                        gpointer  user_data)          : Run First
-
-Indicates that an error occured while creating an NMObject object
-during property handling of master_object.
-
-
-Note: Be aware that the signal is private for libnm-glib's internal
-      use.
-
-
----
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-


master_object : the object that received the signal
error : the error that occured while creating object
failed_path : object path of the failed object
user_data : user data set when the signal handler was connected.
+The “object-creation-failed” signal
+void
+user_function (NMObject *master_object,
+               gpointer  error,
+               gpointer  failed_path,
+               gpointer  user_data)
+Flags: Run First
 
 
 
 
 
-          Generated by GTK-Doc V1.19
+          Generated by GTK-Doc V1.20

\ No newline at end of file diff --git a/docs/libnm-glib/html/NMRemoteConnection.html b/docs/libnm-glib/html/NMRemoteConnection.html index 127b665b..36b650d5 100644 --- a/docs/libnm-glib/html/NMRemoteConnection.html +++ b/docs/libnm-glib/html/NMRemoteConnection.html @@ -2,38 +2,29 @@ -NMRemoteConnection +libnm-glib Reference Manual: NMRemoteConnection - + - - - - - - - - - -

			libnm-glib Reference Manual
-Top - \| - Description - \| - Object Hierarchy - \| - Implemented Interfaces - \| - Properties - \| - Signals -

+ + + + + + +

@@ -41,467 +32,511 @@

NMRemoteConnection

- +

Synopsis

#define             NM_REMOTE_CONNECTION_UPDATED
-#define             NM_REMOTE_CONNECTION_REMOVED
-                    NMRemoteConnection;
-                    NMRemoteConnectionClass;
-void                (*NMRemoteConnectionCommitFunc)     (NMRemoteConnection *connection,
-                                                         GError *error,
-                                                         gpointer user_data);
-void                (*NMRemoteConnectionDeleteFunc)     (NMRemoteConnection *connection,
-                                                         GError *error,
-                                                         gpointer user_data);
-void                (*NMRemoteConnectionGetSecretsFunc) (NMRemoteConnection *connection,
-                                                         GHashTable *secrets,
-                                                         GError *error,
-                                                         gpointer user_data);
-NMRemoteConnection * nm_remote_connection_new           (DBusGConnection *bus,
-                                                         const char *path);
-void                nm_remote_connection_commit_changes (NMRemoteConnection *connection,
-                                                         NMRemoteConnectionCommitFunc callback,
-                                                         gpointer user_data);
-void                nm_remote_connection_delete         (NMRemoteConnection *connection,
-                                                         NMRemoteConnectionDeleteFunc callback,
-                                                         gpointer user_data);
-void                nm_remote_connection_get_secrets    (NMRemoteConnection *connection,
-                                                         const char *setting_name,
-                                                         NMRemoteConnectionGetSecretsFunc callback,
-                                                         gpointer user_data);
-

Object Hierarchy

-  GObject
-   +----NMConnection
-         +----NMRemoteConnection
-

Implemented Interfaces

-NMRemoteConnection implements - GInitable and GAsyncInitable.

Functions

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

+void +	+(*NMRemoteConnectionCommitFunc) () +
+void +	+(*NMRemoteConnectionDeleteFunc) () +
+void +	+(*NMRemoteConnectionGetSecretsFunc) () +
+NMRemoteConnection * +	+nm_remote_connection_new () +
+void +	+nm_remote_connection_commit_changes () +
+void +	+nm_remote_connection_delete () +
+void +	+nm_remote_connection_get_secrets () +

Properties

-  "bus"                      DBusGConnection*      : Write / Construct Only
-  "dbus-connection"          DBusGConnection*      : Write / Construct Only
-  "dbus-path"                gchar*                : Write / Construct Only
-

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

+DBusGConnection *	bus	Write / Construct Only
+DBusGConnection *	dbus-connection	Write / Construct Only
+gchar *	dbus-path	Write / Construct Only

Signals

-  "removed"                                        : Run First
-  "updated"                                        : Run First
-  "visible"                                        : Run First
-

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

void	removed	Run First
void	updated	Run First
void	visible	Run First

Description

Types and Values

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

#define	NM_REMOTE_CONNECTION_UPDATED
#define	NM_REMOTE_CONNECTION_REMOVED

Details

NM_REMOTE_CONNECTION_UPDATED

#define NM_REMOTE_CONNECTION_UPDATED         "updated"
-

NM_REMOTE_CONNECTION_REMOVED

#define NM_REMOTE_CONNECTION_REMOVED "removed" +

Object Hierarchy

    GObject
+    ╰── NMConnection
+        ╰── NMRemoteConnection

NMRemoteConnection

typedef struct _NMRemoteConnection NMRemoteConnection;

NMRemoteConnectionClass

typedef struct {
-	NMConnectionClass parent_class;
-
-	/* Signals */
-	void (*updated) (NMRemoteConnection *connection,
-	                 GHashTable *new_settings);
-
-	void (*removed) (NMRemoteConnection *connection);
-
-	/* Padding for future expansion */
-	void (*_reserved1) (void);
-	void (*_reserved2) (void);
-	void (*_reserved3) (void);
-	void (*_reserved4) (void);
-	void (*_reserved5) (void);
-	void (*_reserved6) (void);
-} NMRemoteConnectionClass;
-

Description

Functions

NMRemoteConnectionCommitFunc ()

void                (*NMRemoteConnectionCommitFunc)     (NMRemoteConnection *connection,
-                                                         GError *error,
-                                                         gpointer user_data);

-Called when NetworkManager has committed outstanding changes to a connection -to backing storage as a result of nm_remote_connection_commit_changes(). -

NMRemoteConnectionCommitFunc ()

void
+(*NMRemoteConnectionCommitFunc) (NMRemoteConnection *connection,
+                                 GError *error,
+                                 gpointer user_data);

Called when NetworkManager has committed outstanding changes to a connection +to backing storage as a result of nm_remote_connection_commit_changes().

Parameters

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

`connection` :	the connection for which updates are to be committed	connection	the connection for which updates are to be committed
`error` :	on failure, a descriptive error	error	on failure, a descriptive error
`user_data` :	user data passed to `nm_remote_connection_commit_changes()` -	user_data	user data passed to `nm_remote_connection_commit_changes()`

NMRemoteConnectionDeleteFunc ()

void                (*NMRemoteConnectionDeleteFunc)     (NMRemoteConnection *connection,
-                                                         GError *error,
-                                                         gpointer user_data);

-Called when NetworkManager has deleted a connection as a result of -nm_remote_connection_delete(). -

NMRemoteConnectionDeleteFunc ()

void
+(*NMRemoteConnectionDeleteFunc) (NMRemoteConnection *connection,
+                                 GError *error,
+                                 gpointer user_data);

Called when NetworkManager has deleted a connection as a result of +nm_remote_connection_delete().

Parameters

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

`connection` :	the connection to be deleted	connection	the connection to be deleted
`error` :	on failure, a descriptive error	error	on failure, a descriptive error
`user_data` :	user data passed to `nm_remote_connection_delete()` -	user_data	user data passed to `nm_remote_connection_delete()`

NMRemoteConnectionGetSecretsFunc ()

void                (*NMRemoteConnectionGetSecretsFunc) (NMRemoteConnection *connection,
-                                                         GHashTable *secrets,
-                                                         GError *error,
-                                                         gpointer user_data);

-Called when NetworkManager returns secrets in response to a request for -secrets via nm_remote_connection_get_secrets(). -

NMRemoteConnectionGetSecretsFunc ()

void
+(*NMRemoteConnectionGetSecretsFunc) (NMRemoteConnection *connection,
+                                     GHashTable *secrets,
+                                     GError *error,
+                                     gpointer user_data);

Called when NetworkManager returns secrets in response to a request for +secrets via nm_remote_connection_get_secrets().

Parameters

--+++ - - + + + - - + +containing that property's value.

+ - - + + + - - + + +

`connection` :	the connection for which secrets were requested	connection	the connection for which secrets were requested
`secrets` :	on success, a hash table of +	secrets	on success, a hash table of hash tables, with each inner hash mapping a setting property to a GValue -containing that property's value. [element-type utf8 GLib.HashTable] -	[element-type utf8 GLib.HashTable]
`error` :	on failure, a descriptive error	error	on failure, a descriptive error
`user_data` :	user data passed to `nm_remote_connection_get_secrets()` -	user_data	user data passed to `nm_remote_connection_get_secrets()`

nm_remote_connection_new ()

NMRemoteConnection * nm_remote_connection_new           (DBusGConnection *bus,
-                                                         const char *path);

-Creates a new object representing the remote connection. -

nm_remote_connection_new ()

NMRemoteConnection *
+nm_remote_connection_new (DBusGConnection *bus,
+                          const char *path);

Creates a new object representing the remote connection.

Parameters

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

`bus` :	a valid and connected D-Bus connection
`path` :	the D-Bus path of the connection as exported by the settings service	bus	a valid and connected D-Bus connection
Returns :	the new remote connection object on success, or `NULL` on failure	path	the D-Bus path of the connection as exported by the settings service

Returns

the new remote connection object on success, or NULL on failure

nm_remote_connection_commit_changes ()

void                nm_remote_connection_commit_changes (NMRemoteConnection *connection,
-                                                         NMRemoteConnectionCommitFunc callback,
-                                                         gpointer user_data);

-Save any local changes to the settings and properties of this connection and -save them in the settings service. -

nm_remote_connection_commit_changes ()

void
+nm_remote_connection_commit_changes (NMRemoteConnection *connection,
+                                     NMRemoteConnectionCommitFunc callback,
+                                     gpointer user_data);

Save any local changes to the settings and properties of this connection and +save them in the settings service.

Parameters

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

`connection` :	the NMRemoteConnection -	connection	the NMRemoteConnection
`callback` :	a function to be called when the -commit completes. [scope async][allow-none] -	callback	a function to be called when the +commit completes.	[scope async][allow-none]
`user_data` :	caller-specific data to be passed to `callback`. [closure] -	user_data	caller-specific data to be passed to `callback` +.	[closure]

nm_remote_connection_delete ()

void                nm_remote_connection_delete         (NMRemoteConnection *connection,
-                                                         NMRemoteConnectionDeleteFunc callback,
-                                                         gpointer user_data);

-Delete the connection. -

nm_remote_connection_delete ()

void
+nm_remote_connection_delete (NMRemoteConnection *connection,
+                             NMRemoteConnectionDeleteFunc callback,
+                             gpointer user_data);

Delete the connection.

Parameters

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

`connection` :	the NMRemoteConnection -	connection	the NMRemoteConnection
`callback` :	a function to be called when the delete completes. [scope async][allow-none] -	callback	a function to be called when the delete completes.	[scope async][allow-none]
`user_data` :	caller-specific data to be passed to `callback`. [closure] -	user_data	caller-specific data to be passed to `callback` +.	[closure]

nm_remote_connection_get_secrets ()

void                nm_remote_connection_get_secrets    (NMRemoteConnection *connection,
-                                                         const char *setting_name,
-                                                         NMRemoteConnectionGetSecretsFunc callback,
-                                                         gpointer user_data);

-Request the connection's secrets. -

nm_remote_connection_get_secrets ()

void
+nm_remote_connection_get_secrets (NMRemoteConnection *connection,
+                                  const char *setting_name,
+                                  NMRemoteConnectionGetSecretsFunc callback,
+                                  gpointer user_data);

Request the connection's secrets.

Parameters

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

`connection` :	the NMRemoteConnection -	connection	the NMRemoteConnection
`setting_name` :	the NMSetting object name to get secrets for	setting_name	the NMSetting object name to get secrets for
`callback` :	a function to be called when the update completes; -must not be `NULL`. [scope async] -	callback	a function to be called when the update completes; +must not be `NULL`.	[scope async]
`user_data` :	caller-specific data to be passed to `callback`. [closure] -	user_data	caller-specific data to be passed to `callback` +.	[closure]

+ +

Types and Values

NM_REMOTE_CONNECTION_UPDATED

#define NM_REMOTE_CONNECTION_UPDATED         "updated"
+

NM_REMOTE_CONNECTION_REMOVED

#define NM_REMOTE_CONNECTION_REMOVED         "removed"
+

Property Details

The `"bus"` property

  "bus"                      DBusGConnection*      : Write / Construct Only

The `“bus”` property

  “bus”                      DBusGConnection *

DBusGConnection.

Flags: Write / Construct Only

The `"dbus-connection"` property

  "dbus-connection"          DBusGConnection*      : Write / Construct Only

The `“dbus-connection”` property

  “dbus-connection”          DBusGConnection *

DBusGConnection.

Flags: Write / Construct Only

The `"dbus-path"` property

  "dbus-path"                gchar*                : Write / Construct Only

The `“dbus-path”` property

  “dbus-path”                gchar *

DBus Object Path.

Flags: Write / Construct Only

Default value: NULL

Signal Details

The `"removed"` signal

void                user_function                      (NMRemoteConnection *connection,
-                                                        gpointer            user_data)       : Run First

-This signal is emitted when a connection is either deleted or becomes -invisible to the current user. -

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

`connection` :	a NMConnection -
`user_data` :	user data set when the signal handler was connected.

The `“removed”` signal

void
+user_function (NMRemoteConnection *connection,
+               gpointer            user_data)

Flags: Run First

The `"updated"` signal

void                user_function                      (NMRemoteConnection *connection,
-                                                        gpointer            user_data)       : Run First

-This signal is emitted when a connection changes, and it is -still visible to the user. -

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

`connection` :	a NMConnection -
`user_data` :	user data set when the signal handler was connected.

The `“updated”` signal

void
+user_function (NMRemoteConnection *connection,
+               gpointer            user_data)

Flags: Run First

The `"visible"` signal

void                user_function                      (NMRemoteConnection *nmremoteconnection,
-                                                        gboolean            arg1,
-                                                        gpointer            user_data)               : Run First

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

`nmremoteconnection` :	the object which received the signal.
`user_data` :	user data set when the signal handler was connected.

The `“visible”` signal

void
+user_function (NMRemoteConnection *nmremoteconnection,
+               gboolean            arg1,
+               gpointer            user_data)

Flags: Run First

+ Generated by GTK-Doc V1.20 \ No newline at end of file diff --git a/docs/libnm-glib/html/NMRemoteSettings.html b/docs/libnm-glib/html/NMRemoteSettings.html index aeaf748e..be81004e 100644 --- a/docs/libnm-glib/html/NMRemoteSettings.html +++ b/docs/libnm-glib/html/NMRemoteSettings.html @@ -2,38 +2,29 @@ -NMRemoteSettings +libnm-glib Reference Manual: NMRemoteSettings - + - - - - - - - - - -

			libnm-glib Reference Manual
-Top - \| - Description - \| - Object Hierarchy - \| - Implemented Interfaces - \| - Properties - \| - Signals -

+ + + + + + +

@@ -41,620 +32,725 @@

NMRemoteSettings

- +

Synopsis

enum                NMRemoteSettingsError;
-#define             NM_REMOTE_SETTINGS_ERROR
-GQuark              nm_remote_settings_error_quark      (void);
-#define             NM_REMOTE_SETTINGS_BUS
-#define             NM_REMOTE_SETTINGS_SERVICE_RUNNING
-#define             NM_REMOTE_SETTINGS_HOSTNAME
-#define             NM_REMOTE_SETTINGS_CAN_MODIFY
-#define             NM_REMOTE_SETTINGS_NEW_CONNECTION
-#define             NM_REMOTE_SETTINGS_CONNECTIONS_READ
-void                (*NMRemoteSettingsAddConnectionFunc)
-                                                        (NMRemoteSettings *settings,
-                                                         NMRemoteConnection *connection,
-                                                         GError *error,
-                                                         gpointer user_data);
-void                (*NMRemoteSettingsSaveHostnameFunc) (NMRemoteSettings *settings,
-                                                         GError *error,
-                                                         gpointer user_data);
-struct              NMRemoteSettings;
-struct              NMRemoteSettingsClass;
-NMRemoteSettings *  nm_remote_settings_new              (DBusGConnection *bus);
-void                nm_remote_settings_new_async        (DBusGConnection *bus,
-                                                         GCancellable *cancellable,
-                                                         GAsyncReadyCallback callback,
-                                                         gpointer user_data);
-NMRemoteSettings *  nm_remote_settings_new_finish       (GAsyncResult *result,
-                                                         GError **error);
-GSList *            nm_remote_settings_list_connections (NMRemoteSettings *settings);
-NMRemoteConnection * nm_remote_settings_get_connection_by_path
-                                                        (NMRemoteSettings *settings,
-                                                         const char *path);
-NMRemoteConnection * nm_remote_settings_get_connection_by_uuid
-                                                        (NMRemoteSettings *settings,
-                                                         const char *uuid);
-gboolean            nm_remote_settings_add_connection   (NMRemoteSettings *settings,
-                                                         NMConnection *connection,
-                                                         NMRemoteSettingsAddConnectionFunc callback,
-                                                         gpointer user_data);
-gboolean            nm_remote_settings_save_hostname    (NMRemoteSettings *settings,
-                                                         const char *hostname,
-                                                         NMRemoteSettingsSaveHostnameFunc callback,
-                                                         gpointer user_data);
-

Object Hierarchy

-  GObject
-   +----NMRemoteSettings
-

Implemented Interfaces

-NMRemoteSettings implements - GInitable and GAsyncInitable.

Properties

-  "bus"                      DBusGConnection*      : Read / Write / Construct Only
-  "can-modify"               gboolean              : Read
-  "hostname"                 gchar*                : Read
-  "service-running"          gboolean              : Read
-

Signals

-  "connections-read"                               : Run First
-  "new-connection"                                 : Run First
-

Description

Details

enum NMRemoteSettingsError

typedef enum {
-	NM_REMOTE_SETTINGS_ERROR_UNKNOWN = 0,            /*< nick=UnknownError >*/
-	NM_REMOTE_SETTINGS_ERROR_CONNECTION_REMOVED,     /*< nick=ConnectionRemoved >*/
-	NM_REMOTE_SETTINGS_ERROR_CONNECTION_UNAVAILABLE, /*< nick=ConnectionUnavailable >*/
-} NMRemoteSettingsError;
-

-Describes errors that may result from operations involving a NMRemoteSettings. -

Functions

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

`NM_REMOTE_SETTINGS_ERROR_UNKNOWN`	unknown or unclassified error +	+GQuark +	+nm_remote_settings_error_quark ()
`NM_REMOTE_SETTINGS_ERROR_CONNECTION_REMOVED`	the NMRemoteConnection object - was removed before it was completely initialized +	+void +	+(*NMRemoteSettingsAddConnectionFunc) ()
`NM_REMOTE_SETTINGS_ERROR_CONNECTION_UNAVAILABLE`	the NMRemoteConnection object - is not visible or otherwise unreadable +	+void +	+(*NMRemoteSettingsSaveHostnameFunc) () +
+NMRemoteSettings * +	+nm_remote_settings_new () +
+void +	+nm_remote_settings_new_async () +
+NMRemoteSettings * +	+nm_remote_settings_new_finish () +
+GSList * +	+nm_remote_settings_list_connections () +
+NMRemoteConnection * +	+nm_remote_settings_get_connection_by_path () +
+NMRemoteConnection * +	+nm_remote_settings_get_connection_by_uuid () +
+gboolean +	+nm_remote_settings_add_connection () +
+gboolean +	+nm_remote_settings_save_hostname ()

NM_REMOTE_SETTINGS_ERROR

#define NM_REMOTE_SETTINGS_ERROR nm_remote_settings_error_quark ()
-

Properties

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

+DBusGConnection *	bus	Read / Write / Construct Only
gboolean	can-modify	Read
+gchar *	hostname	Read
gboolean	service-running	Read

nm_remote_settings_error_quark ()

GQuark              nm_remote_settings_error_quark      (void);

-Registers an error quark for NMRemoteSettings if necessary. -

Signals

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

Returns :	the error quark used for NMRemoteSettings errors.
void	connections-read	Run First
void	new-connection	Run First

NM_REMOTE_SETTINGS_BUS

#define NM_REMOTE_SETTINGS_BUS             "bus"
-

Types and Values

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

enum	NMRemoteSettingsError
#define	NM_REMOTE_SETTINGS_ERROR
#define	NM_REMOTE_SETTINGS_BUS
#define	NM_REMOTE_SETTINGS_SERVICE_RUNNING
#define	NM_REMOTE_SETTINGS_HOSTNAME
#define	NM_REMOTE_SETTINGS_CAN_MODIFY
#define	NM_REMOTE_SETTINGS_NEW_CONNECTION
#define	NM_REMOTE_SETTINGS_CONNECTIONS_READ

NM_REMOTE_SETTINGS_SERVICE_RUNNING

#define NM_REMOTE_SETTINGS_SERVICE_RUNNING "service-running"
+
+Object Hierarchy
+    GObject
+    ╰── NMRemoteSettings
 
-
-
 
-
-
-NM_REMOTE_SETTINGS_HOSTNAME
-#define NM_REMOTE_SETTINGS_HOSTNAME        "hostname"
-
+
+Description
 
 
 
-
+
+Functions
 
-NM_REMOTE_SETTINGS_CAN_MODIFY
-#define NM_REMOTE_SETTINGS_CAN_MODIFY      "can-modify"
-
-
-
+nm_remote_settings_error_quark ()
+GQuark
+nm_remote_settings_error_quark (void);
+Registers an error quark for NMRemoteSettings if necessary.
+
+Returns
+ the error quark used for NMRemoteSettings errors.
+
 
-
-
-NM_REMOTE_SETTINGS_NEW_CONNECTION
-#define NM_REMOTE_SETTINGS_NEW_CONNECTION    "new-connection"
-
-
-
 
 
 
-NM_REMOTE_SETTINGS_CONNECTIONS_READ
-#define NM_REMOTE_SETTINGS_CONNECTIONS_READ  "connections-read"
-
+NMRemoteSettingsAddConnectionFunc ()
+void
+(*NMRemoteSettingsAddConnectionFunc) (NMRemoteSettings *settings,
+                                      NMRemoteConnection *connection,
+                                      GError *error,
+                                      gpointer user_data);
 
 
 
 
 
-NMRemoteSettingsAddConnectionFunc ()
-void                (*NMRemoteSettingsAddConnectionFunc)
-                                                        (NMRemoteSettings *settings,
-                                                         NMRemoteConnection *connection,
-                                                         GError *error,
-                                                         gpointer user_data);
+NMRemoteSettingsSaveHostnameFunc ()
+void
+(*NMRemoteSettingsSaveHostnameFunc) (NMRemoteSettings *settings,
+                                     GError *error,
+                                     gpointer user_data);
 
 
 
 
 
-NMRemoteSettingsSaveHostnameFunc ()
-void                (*NMRemoteSettingsSaveHostnameFunc) (NMRemoteSettings *settings,
-                                                         GError *error,
-                                                         gpointer user_data);
-
-
+nm_remote_settings_new ()
+NMRemoteSettings *
+nm_remote_settings_new (DBusGConnection *bus);
+Creates a new object representing the remote settings service.
+Note that this will do blocking D-Bus calls to initialize the
+settings object. You can use nm_remote_settings_new_async() if you
+want to avoid that.
+
+Parameters
+
+++++
+
+
+
+
+
+



bus  a valid and connected D-Bus connection. [allow-none]
 
-
-
-struct NMRemoteSettings
-struct NMRemoteSettings;
-
-
+
+Returns
+ the new remote settings object on success, or NULL on failure
+
 
-
-
-struct NMRemoteSettingsClass
-struct NMRemoteSettingsClass {
-	GObjectClass parent;
-
-	/* Signals */
-	void (*new_connection) (NMRemoteSettings *settings,
-	                        NMRemoteConnection *connection);
-
-	void (*connections_read) (NMRemoteSettings *settings);
-
-	/* Padding for future expansion */
-	void (*_reserved1) (void);
-	void (*_reserved2) (void);
-	void (*_reserved3) (void);
-	void (*_reserved4) (void);
-	void (*_reserved5) (void);
-	void (*_reserved6) (void);
-};
-
-
-
 
 
 
-nm_remote_settings_new ()
-NMRemoteSettings *  nm_remote_settings_new              (DBusGConnection *bus);
-
-Creates a new object representing the remote settings service.
-
-
-Note that this will do blocking D-Bus calls to initialize the
-settings object. You can use nm_remote_settings_new_async() if you
-want to avoid that.
-
-
+nm_remote_settings_new_async ()
+void
+nm_remote_settings_new_async (DBusGConnection *bus,
+                              GCancellable *cancellable,
+                              GAsyncReadyCallback callback,
+                              gpointer user_data);
+Creates a new object representing the remote settings service and
+begins asynchronously initializing it. callback
+ will be called
+when it is done; use nm_remote_settings_new_finish() to get the
+result.
+
+Parameters
+
--+++
-
-
+
+
+
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
 





 
 
 bus : a valid and connected D-Bus connection. [allow-none]
- bus  a valid and connected D-Bus connection. [allow-none]
 
 Returns : the new remote settings object on success, or NULL on failure cancellable a GCancellable, or NULL  
callback callback to call when the settings object is created  
user_data data for callback
+  
 
 
 
 
+
 
 
-nm_remote_settings_new_async ()
-void                nm_remote_settings_new_async        (DBusGConnection *bus,
-                                                         GCancellable *cancellable,
-                                                         GAsyncReadyCallback callback,
-                                                         gpointer user_data);
-
-Creates a new object representing the remote settings service and
-begins asynchronously initializing it. callback will be called
-when it is done; use nm_remote_settings_new_finish() to get the
-result.
-
-
+nm_remote_settings_new_finish ()
+NMRemoteSettings *
+nm_remote_settings_new_finish (GAsyncResult *result,
+                               GError **error);
+Gets the result of an nm_remote_settings_new_async() call.
+
+Parameters
+
--+++
-
-
-
-
-
-
+
+
+
-
-
-
-
-
-
+
+
+
 





 
 
 bus : a valid and connected D-Bus connection. [allow-none]
-
cancellable : a GCancellable, or NULL
- result a GAsyncResult  
 
 callback : callback to call when the settings object is created
user_data : data for callback
- error location for a GError, or NULL  
 
 
 
 
+
+Returns
+ a new NMRemoteSettings object, or NULL on error
+
+
+
 
 
-nm_remote_settings_new_finish ()
-NMRemoteSettings *  nm_remote_settings_new_finish       (GAsyncResult *result,
-                                                         GError **error);
-
-Gets the result of an nm_remote_settings_new_async() call.
-
-
+nm_remote_settings_list_connections ()
+GSList *
+nm_remote_settings_list_connections (NMRemoteSettings *settings);
+
+Parameters
+
--+++
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
 





 result : a GAsyncResult
-
error : location for a GError, or NULL
-
Returns : a new NMRemoteSettings object, or NULL on error
settings the NMRemoteSettings  
 
 
+
+Returns
+ a
+list containing all connections provided by the remote settings service.
+Each element of the returned list is a NMRemoteConnection instance, which is
+owned by the NMRemoteSettings object and should not be freed by the caller.
+The returned list is, however, owned by the caller and should be freed
+using g_slist_free() when no longer required. 
+[transfer container][element-type NMClient.RemoteConnection]
+
+
 
 
-nm_remote_settings_list_connections ()
-GSList *            nm_remote_settings_list_connections (NMRemoteSettings *settings);
-
+nm_remote_settings_get_connection_by_path ()
+NMRemoteConnection *
+nm_remote_settings_get_connection_by_path
+                               (NMRemoteSettings *settings,
+                                const char *path);
+Returns the NMRemoteConnection representing the connection at path
+.
+
+Parameters
+
--+++
-
-
+
+
+
-
-
+
+
+
 





 
 
 settings : the NMRemoteSettings
- settings the NMRemoteSettings  
 
 Returns : a
-list containing all connections provided by the remote settings service.
-Each element of the returned list is a NMRemoteConnection instance, which is
-owned by the NMRemoteSettings object and should not be freed by the caller.
-The returned list is, however, owned by the caller and should be freed
-using g_slist_free() when no longer required. [transfer container][element-type NMClient.RemoteConnection]
- path the D-Bus object path of the remote connection  
 
 
 
 
+
+Returns
+ the remote connection object on success, or NULL if the object was
+not known. 
+[transfer none]
+
+
 
 
-nm_remote_settings_get_connection_by_path ()
-NMRemoteConnection * nm_remote_settings_get_connection_by_path
-                                                        (NMRemoteSettings *settings,
-                                                         const char *path);
-
-Returns the NMRemoteConnection representing the connection at path.
-
-
+nm_remote_settings_get_connection_by_uuid ()
+NMRemoteConnection *
+nm_remote_settings_get_connection_by_uuid
+                               (NMRemoteSettings *settings,
+                                const char *uuid);
+Returns the NMRemoteConnection identified by uuid
+.
+
+Parameters
+
--+++
-
-
-
-
-
-
+
+
+
-
-
+
+
+
 





 
 
 settings : the NMRemoteSettings
-
path : the D-Bus object path of the remote connection settings the NMRemoteSettings  
 
 Returns : the remote connection object on success, or NULL if the object was
-not known. [transfer none]
- uuid the UUID of the remote connection  
 
 
 
 
+
+Returns
+ the remote connection object on success, or NULL if the object was
+not known. 
+[transfer none]
+
+
 
 
-nm_remote_settings_get_connection_by_uuid ()
-NMRemoteConnection * nm_remote_settings_get_connection_by_uuid
-                                                        (NMRemoteSettings *settings,
-                                                         const char *uuid);
-
-Returns the NMRemoteConnection identified by uuid.
-
-
+nm_remote_settings_add_connection ()
+gboolean
+nm_remote_settings_add_connection (NMRemoteSettings *settings,
+                                   NMConnection *connection,
+                                   NMRemoteSettingsAddConnectionFunc callback,
+                                   gpointer user_data);
+Requests that the remote settings service add the given settings to a new
+connection.
+
+Parameters
+
--+++
-
-
+
+
+
-
-
+
+
+
-
-
+
+
+
+
+
+
+
+
 





 
 
 settings : the NMRemoteSettings
- settings the NMRemoteSettings  
 
 uuid : the UUID of the remote connection connection the connection to add. Note that this object's settings will be
+added, not the object itself  
 
 Returns : the remote connection object on success, or NULL if the object was
-not known. [transfer none]
- callback  callback to be called when the add operation completes. [scope async]
user_data  caller-specific data passed to callback
+. [closure]
 
 
 
 
+
+Returns
+ TRUE if the request was successful, FALSE if it failed
+
+
+

nm_remote_settings_add_connection ()

gboolean            nm_remote_settings_add_connection   (NMRemoteSettings *settings,
-                                                         NMConnection *connection,
-                                                         NMRemoteSettingsAddConnectionFunc callback,
-                                                         gpointer user_data);

-Requests that the remote settings service add the given settings to a new -connection. -

nm_remote_settings_save_hostname ()

gboolean
+nm_remote_settings_save_hostname (NMRemoteSettings *settings,
+                                  const char *hostname,
+                                  NMRemoteSettingsSaveHostnameFunc callback,
+                                  gpointer user_data);

Requests that the machine's persistent hostname be set to the specified value +or cleared.

Parameters

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

`settings` :	the `NMRemoteSettings` -	settings	the `NMRemoteSettings`
`connection` :	the connection to add. Note that this object's settings will be -added, not the object itself	hostname	the new persistent hostname to set, or `NULL` to clear any existing +persistent hostname
`callback` :	callback to be called when the add operation completes. [scope async] -	callback	callback to be called when the +hostname operation completes.	[scope async][allow-none]
`user_data` :	caller-specific data passed to `callback`. [closure] -
Returns :	TRUE if the request was successful, FALSE if it failed	user_data	caller-specific data passed to `callback` +.	[closure]

Returns

TRUE if the request was successful, FALSE if it failed

Types and Values

nm_remote_settings_save_hostname ()

gboolean            nm_remote_settings_save_hostname    (NMRemoteSettings *settings,
-                                                         const char *hostname,
-                                                         NMRemoteSettingsSaveHostnameFunc callback,
-                                                         gpointer user_data);

-Requests that the machine's persistent hostname be set to the specified value -or cleared. -

enum NMRemoteSettingsError

Describes errors that may result from operations involving a NMRemoteSettings.

Members

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

`settings` :	the `NMRemoteSettings` +	NM_REMOTE_SETTINGS_ERROR_UNKNOWN	+ unknown or unclassified error
`hostname` :	the new persistent hostname to set, or `NULL` to clear any existing -persistent hostname
`callback` :	callback to be called when the -hostname operation completes. [scope async][allow-none] +	NM_REMOTE_SETTINGS_ERROR_CONNECTION_REMOVED	+ the NMRemoteConnection object + was removed before it was completely initialized
`user_data` :	caller-specific data passed to `callback`. [closure] +	NM_REMOTE_SETTINGS_ERROR_CONNECTION_UNAVAILABLE	+ the NMRemoteConnection object + is not visible or otherwise unreadable
Returns :	TRUE if the request was successful, FALSE if it failed

NM_REMOTE_SETTINGS_ERROR

#define NM_REMOTE_SETTINGS_ERROR nm_remote_settings_error_quark ()
+

NM_REMOTE_SETTINGS_BUS

#define NM_REMOTE_SETTINGS_BUS             "bus"
+

NM_REMOTE_SETTINGS_SERVICE_RUNNING

#define NM_REMOTE_SETTINGS_SERVICE_RUNNING "service-running"
+

NM_REMOTE_SETTINGS_HOSTNAME

#define NM_REMOTE_SETTINGS_HOSTNAME        "hostname"
+

NM_REMOTE_SETTINGS_CAN_MODIFY

#define NM_REMOTE_SETTINGS_CAN_MODIFY      "can-modify"
+

NM_REMOTE_SETTINGS_NEW_CONNECTION

#define NM_REMOTE_SETTINGS_NEW_CONNECTION    "new-connection"
+

NM_REMOTE_SETTINGS_CONNECTIONS_READ

#define NM_REMOTE_SETTINGS_CONNECTIONS_READ  "connections-read"
+

Property Details

The `"bus"` property

  "bus"                      DBusGConnection*      : Read / Write / Construct Only

The `“bus”` property

  “bus”                      DBusGConnection *

DBusGConnection.

Flags: Read / Write / Construct Only

The `"can-modify"` property

  "can-modify"               gboolean              : Read

The `“can-modify”` property

  “can-modify”               gboolean

Can modify anything (hostname, connections, etc).

Flags: Read

Default value: FALSE

The `"hostname"` property

  "hostname"                 gchar*                : Read

The `“hostname”` property

  “hostname”                 gchar *

Persistent hostname.

Flags: Read

Default value: NULL

The `"service-running"` property

  "service-running"          gboolean              : Read

The `“service-running”` property

  “service-running”          gboolean

Is service running.

Flags: Read

Default value: FALSE

Signal Details

The `"connections-read"` signal

void                user_function                      (NMRemoteSettings *nmremotesettings,
-                                                        gpointer          user_data)             : Run First

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

`nmremotesettings` :	the object which received the signal.
`user_data` :	user data set when the signal handler was connected.

The `“connections-read”` signal

void
+user_function (NMRemoteSettings *nmremotesettings,
+               gpointer          user_data)

Flags: Run First

The `"new-connection"` signal

void                user_function                      (NMRemoteSettings *nmremotesettings,
-                                                        GObject          *arg1,
-                                                        gpointer          user_data)             : Run First

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

`nmremotesettings` :	the object which received the signal.
`user_data` :	user data set when the signal handler was connected.

The `“new-connection”` signal

void
+user_function (NMRemoteSettings *nmremotesettings,
+               GObject          *arg1,
+               gpointer          user_data)

Flags: Run First

+ Generated by GTK-Doc V1.20 \ No newline at end of file diff --git a/docs/libnm-glib/html/NMSecretAgent.html b/docs/libnm-glib/html/NMSecretAgent.html index 671cd029..94bc4e1f 100644 --- a/docs/libnm-glib/html/NMSecretAgent.html +++ b/docs/libnm-glib/html/NMSecretAgent.html @@ -2,36 +2,29 @@ -NMSecretAgent +libnm-glib Reference Manual: NMSecretAgent - + - - - - - - - - - -

			libnm-glib Reference Manual
-Top - \| - Description - \| - Object Hierarchy - \| - Properties - \| - Signals -

+ + + + + + +

@@ -39,266 +32,230 @@

NMSecretAgent

- +

Synopsis

#define             NM_SECRET_AGENT_ERROR
-GQuark              nm_secret_agent_error_quark         (void);
-enum                NMSecretAgentError;
-enum                NMSecretAgentGetSecretsFlags;
-#define             NM_SECRET_AGENT_IDENTIFIER
-#define             NM_SECRET_AGENT_AUTO_REGISTER
-#define             NM_SECRET_AGENT_REGISTERED
-#define             NM_SECRET_AGENT_REGISTRATION_RESULT
-                    NMSecretAgent;
-void                (*NMSecretAgentGetSecretsFunc)      (NMSecretAgent *agent,
-                                                         NMConnection *connection,
-                                                         GHashTable *secrets,
-                                                         GError *error,
-                                                         gpointer user_data);
-void                (*NMSecretAgentSaveSecretsFunc)     (NMSecretAgent *agent,
-                                                         NMConnection *connection,
-                                                         GError *error,
-                                                         gpointer user_data);
-void                (*NMSecretAgentDeleteSecretsFunc)   (NMSecretAgent *agent,
-                                                         NMConnection *connection,
-                                                         GError *error,
-                                                         gpointer user_data);
-                    NMSecretAgentClass;
-gboolean            nm_secret_agent_register            (NMSecretAgent *self);
-gboolean            nm_secret_agent_unregister          (NMSecretAgent *self);
-gboolean            nm_secret_agent_get_registered      (NMSecretAgent *self);
-void                nm_secret_agent_get_secrets         (NMSecretAgent *self,
-                                                         NMConnection *connection,
-                                                         const char *setting_name,
-                                                         const char **hints,
-                                                         NMSecretAgentGetSecretsFlags flags,
-                                                         NMSecretAgentGetSecretsFunc callback,
-                                                         gpointer user_data);
-void                nm_secret_agent_save_secrets        (NMSecretAgent *self,
-                                                         NMConnection *connection,
-                                                         NMSecretAgentSaveSecretsFunc callback,
-                                                         gpointer user_data);
-void                nm_secret_agent_delete_secrets      (NMSecretAgent *self,
-                                                         NMConnection *connection,
-                                                         NMSecretAgentDeleteSecretsFunc callback,
-                                                         gpointer user_data);
-

Object Hierarchy

-  GObject
-   +----NMSecretAgent
-

Properties

-  "auto-register"            gboolean              : Read / Write / Construct
-  "identifier"               gchar*                : Read / Write / Construct Only
-  "registered"               gboolean              : Read
-

Signals

-  "registration-result"                            : Run First
-

Description

Details

NM_SECRET_AGENT_ERROR

#define NM_SECRET_AGENT_ERROR         (nm_secret_agent_error_quark ())
-

nm_secret_agent_error_quark ()

GQuark              nm_secret_agent_error_quark         (void);

enum NMSecretAgentError

typedef enum {
-	NM_SECRET_AGENT_ERROR_NOT_AUTHORIZED = 0, /*< nick=NotAuthorized >*/
-	NM_SECRET_AGENT_ERROR_INVALID_CONNECTION, /*< nick=InvalidConnection >*/
-	NM_SECRET_AGENT_ERROR_USER_CANCELED,      /*< nick=UserCanceled >*/
-	NM_SECRET_AGENT_ERROR_AGENT_CANCELED,     /*< nick=AgentCanceled >*/
-	NM_SECRET_AGENT_ERROR_INTERNAL_ERROR,     /*< nick=InternalError >*/
-	NM_SECRET_AGENT_ERROR_NO_SECRETS,         /*< nick=NoSecrets >*/
-} NMSecretAgentError;
-

-NMSecretAgentError values are passed by secret agents back to NetworkManager -when they encounter problems retrieving secrets on behalf of NM. -

Functions

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

`NM_SECRET_AGENT_ERROR_NOT_AUTHORIZED`	the caller (ie, NetworkManager) is not - authorized to make this request +	#define	NM_SECRET_AGENT_ERROR
+GQuark +	+nm_secret_agent_error_quark () +
+void +	+(*NMSecretAgentGetSecretsFunc) () +
+void +	+(*NMSecretAgentSaveSecretsFunc) () +
+void +	+(*NMSecretAgentDeleteSecretsFunc) () +
+gboolean +	+nm_secret_agent_register ()
`NM_SECRET_AGENT_ERROR_INVALID_CONNECTION`	the connection for which secrets - were requested could not be found +	+gboolean +	+nm_secret_agent_unregister ()
`NM_SECRET_AGENT_ERROR_USER_CANCELED`	the request was canceled by the user +	+gboolean +	+nm_secret_agent_get_registered ()
`NM_SECRET_AGENT_ERROR_AGENT_CANCELED`	the agent canceled the request - because it was requested to do so by NetworkManager +	+void +	+nm_secret_agent_get_secrets ()
`NM_SECRET_AGENT_ERROR_INTERNAL_ERROR`	some internal error in the agent caused - the request to fail +	+void +	+nm_secret_agent_save_secrets ()
`NM_SECRET_AGENT_ERROR_NO_SECRETS`	the agent cannot find any secrets for this - connection +	+void +	+nm_secret_agent_delete_secrets ()

enum NMSecretAgentGetSecretsFlags

typedef enum {
-	NM_SECRET_AGENT_GET_SECRETS_FLAG_NONE = 0x0,
-	NM_SECRET_AGENT_GET_SECRETS_FLAG_ALLOW_INTERACTION = 0x1,
-	NM_SECRET_AGENT_GET_SECRETS_FLAG_REQUEST_NEW = 0x2,
-	NM_SECRET_AGENT_GET_SECRETS_FLAG_USER_REQUESTED = 0x4
-} NMSecretAgentGetSecretsFlags;
-

-NMSecretAgentGetSecretsFlags values modify the behavior of a GetSecrets request. -

Properties

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

`NM_SECRET_AGENT_GET_SECRETS_FLAG_NONE`	no special behavior; by default no -user interaction is allowed and requests for secrets are fulfilled from -persistent storage, or if no secrets are available an error is returned. -	gboolean	auto-register	Read / Write / Construct
`NM_SECRET_AGENT_GET_SECRETS_FLAG_ALLOW_INTERACTION`	allows the request to -interact with the user, possibly prompting via UI for secrets if any are -required, or if none are found in persistent storage. -	+gchar *	identifier	Read / Write / Construct Only
`NM_SECRET_AGENT_GET_SECRETS_FLAG_REQUEST_NEW`	explicitly prompt for new -secrets from the user. This flag signals that NetworkManager thinks any -existing secrets are invalid or wrong. This flag implies that interaction -is allowed. -	gboolean	registered	Read

Signals

+++++ + + + + + +

void

registration-result

Types and Values

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

`NM_SECRET_AGENT_GET_SECRETS_FLAG_USER_REQUESTED`	set if the request was -initiated by user-requested action via the D-Bus interface, as opposed to -automatically initiated by NetworkManager in response to (for example) scan -results or carrier changes. -	enum	NMSecretAgentError
enum	NMSecretAgentGetSecretsFlags
#define	NM_SECRET_AGENT_IDENTIFIER
#define	NM_SECRET_AGENT_AUTO_REGISTER
#define	NM_SECRET_AGENT_REGISTERED
#define	NM_SECRET_AGENT_REGISTRATION_RESULT

NM_SECRET_AGENT_IDENTIFIER

#define NM_SECRET_AGENT_IDENTIFIER          "identifier"
+
+Object Hierarchy
+    GObject
+    ╰── NMSecretAgent
 
-
-
 
-
-
-NM_SECRET_AGENT_AUTO_REGISTER
-#define NM_SECRET_AGENT_AUTO_REGISTER       "auto-register"
-
+
+Description
 
 
 
-
+
+Functions
 
-NM_SECRET_AGENT_REGISTERED
-#define NM_SECRET_AGENT_REGISTERED          "registered"
+NM_SECRET_AGENT_ERROR
+#define NM_SECRET_AGENT_ERROR         (nm_secret_agent_error_quark ())
 
 
 
 
 
 
-NM_SECRET_AGENT_REGISTRATION_RESULT
-#define NM_SECRET_AGENT_REGISTRATION_RESULT "registration-result"
-
+nm_secret_agent_error_quark ()
+GQuark
+nm_secret_agent_error_quark (void);
 
 
+
+Returns
+
 
-
-
-NMSecretAgent
-typedef struct _NMSecretAgent NMSecretAgent;
-
-
 
 
 
-NMSecretAgentGetSecretsFunc ()
-void                (*NMSecretAgentGetSecretsFunc)      (NMSecretAgent *agent,
-                                                         NMConnection *connection,
-                                                         GHashTable *secrets,
-                                                         GError *error,
-                                                         gpointer user_data);
-
-Called as a result of a request by NM to retrieve secrets.  When the
+
NMSecretAgentGetSecretsFunc ()
+void
+(*NMSecretAgentGetSecretsFunc) (NMSecretAgent *agent,
+                                NMConnection *connection,
+                                GHashTable *secrets,
+                                GError *error,
+                                gpointer user_data);
+Called as a result of a request by NM to retrieve secrets.  When the
 NMSecretAgent subclass has finished retrieving secrets and is ready to
 return them, or to return an error, this function should be called with
-those secrets or the error.
-
-
-To easily create the hash table to return the WiFi PSK, you could do
-something like this:
-
+those secrets or the error.
+To easily create the hash table to return the WiFi PSK, you could do
+something like this:
 
-Example 1. Creating a secrets hash
+Example 1. Creating a secrets hash
 
   
@@ -323,13 +280,13 @@ something like this:
 NMSettingWirelessSecurity *s_wsec;GHashTable *secrets_hash;
 
-secrets = nm_connection_new ();
-s_wsec = (NMSettingWirelessSecurity *) nm_setting_wireless_security_new ();
+secrets = nm_connection_new ();
+s_wsec = (NMSettingWirelessSecurity *) nm_setting_wireless_security_new ();g_object_set (G_OBJECT (s_wsec),
-              NM_SETTING_WIRELESS_SECURITY_PSK, "my really cool PSK",
+              NM_SETTING_WIRELESS_SECURITY_PSK, "my really cool PSK",              NULL);
-nm_connection_add_setting (secrets, NM_SETTING (s_wsec));
-secrets_hash = nm_connection_to_hash (secrets, NM_SETTING_HASH_FLAG_ALL);
+nm_connection_add_setting (secrets, NM_SETTING (s_wsec));
+secrets_hash = nm_connection_to_hash (secrets, NM_SETTING_HASH_FLAG_ALL);(call the NMSecretAgentGetSecretsFunc with secrets_hash)
 
@@ -341,508 +298,591 @@ something like this:
 
-

-
-

     
 
 
 
 
 
 
 
+

+Parameters
+
--+++
-
-
+
+
+
-
-
+
+has returned. 
+
-
-
+
+is the secret. 
+
-
-
+
+
+
-
-
+
+
+
 





 
 
 agent : the secret agent object agent the secret agent object  
 
 connection : the connection for which secrets were requested,
+ connection  the connection for which secrets were requested,
 note that this object will be unrefed after the callback has returned, use
 g_object_ref()/g_object_unref() if you want to use this object after the callback
-has returned. [transfer none]
- [transfer none]
 
 secrets : the GHashTable containing
-the requested secrets in the same format as an NMConnection hash (as
-created by nm_connection_to_hash() for example).  Each key in secrets
-should be the name of a NMSetting object (like "802-11-wireless-security")
+ secrets  the GHashTable containing
+the requested secrets in the same format as an NMConnection hash (as
+created by nm_connection_to_hash() for example).  Each key in secrets
+should be the name of a NMSetting object (like "802-11-wireless-security")
 and each value should be a GHashTable.  The sub-hashes map string:GValue
 where the string is the setting property name (like "psk") and the value
-is the secret. [element-type utf8 GLib.HashTable]
- [element-type utf8 GLib.HashTable]
 
 error : if the secrets request failed, give a descriptive error here error if the secrets request failed, give a descriptive error here  
 
 user_data : caller-specific data to be passed to the function user_data caller-specific data to be passed to the function  
 
 
 
 
+
 
 
-NMSecretAgentSaveSecretsFunc ()
-void                (*NMSecretAgentSaveSecretsFunc)     (NMSecretAgent *agent,
-                                                         NMConnection *connection,
-                                                         GError *error,
-                                                         gpointer user_data);
-
-Called as a result of a request by NM to save secrets.  When the
+
NMSecretAgentSaveSecretsFunc ()
+void
+(*NMSecretAgentSaveSecretsFunc) (NMSecretAgent *agent,
+                                 NMConnection *connection,
+                                 GError *error,
+                                 gpointer user_data);
+Called as a result of a request by NM to save secrets.  When the
 NMSecretAgent subclass has finished saving the secrets, this function
-should be called.
-
-
+should be called.
+
+Parameters
+
--+++
-
-
+
+
+
-
-
+
+has returned. 
+
-
-
+
+
+
-
-
+
+
+
 





 
 
 agent : the secret agent object agent the secret agent object  
 
 connection : the connection for which secrets were to be saved,
+ connection  the connection for which secrets were to be saved,
 note that this object will be unrefed after the callback has returned, use
 g_object_ref()/g_object_unref() if you want to use this object after the callback
-has returned. [transfer none]
- [transfer none]
 
 error : if the saving secrets failed, give a descriptive error here error if the saving secrets failed, give a descriptive error here  
 
 user_data : caller-specific data to be passed to the function user_data caller-specific data to be passed to the function  
 
 
 
 
+
 
 
-NMSecretAgentDeleteSecretsFunc ()
-void                (*NMSecretAgentDeleteSecretsFunc)   (NMSecretAgent *agent,
-                                                         NMConnection *connection,
-                                                         GError *error,
-                                                         gpointer user_data);
-
-Called as a result of a request by NM to delete secrets.  When the
+
NMSecretAgentDeleteSecretsFunc ()
+void
+(*NMSecretAgentDeleteSecretsFunc) (NMSecretAgent *agent,
+                                   NMConnection *connection,
+                                   GError *error,
+                                   gpointer user_data);
+Called as a result of a request by NM to delete secrets.  When the
 NMSecretAgent subclass has finished deleting the secrets, this function
-should be called.
-
-
+should be called.
+
+Parameters
+
--+++
-
-
+
+
+
-
-
+
+has returned. 
+
-
-
+
+
+
-
-
+
+
+
 





 
 
 agent : the secret agent object agent the secret agent object  
 
 connection : the connection for which secrets were to be deleted,
+ connection  the connection for which secrets were to be deleted,
 note that this object will be unrefed after the callback has returned, use
 g_object_ref()/g_object_unref() if you want to use this object after the callback
-has returned. [transfer none]
- [transfer none]
 
 error : if the deleting secrets failed, give a descriptive error here error if the deleting secrets failed, give a descriptive error here  
 
 user_data : caller-specific data to be passed to the function user_data caller-specific data to be passed to the function  
 
 
 
 
-
-
-NMSecretAgentClass
-typedef struct {
-	GObjectClass parent;
-
-	/* Virtual methods for subclasses */
-
-	/* Called when the subclass should retrieve and return secrets.  Subclass
-	 * must copy or reference any arguments it may require after returning from
-	 * this method, as the arguments will freed (except for 'self', 'callback',
-	 * and 'user_data' of course).  If the request is canceled, the callback
-	 * should still be called, but with the NM_SECRET_AGENT_ERROR_AGENT_CANCELED
-	 * error.
-	 */
-	void (*get_secrets) (NMSecretAgent *self,
-	                     NMConnection *connection,
-	                     const char *connection_path,
-	                     const char *setting_name,
-	                     const char **hints,
-	                     NMSecretAgentGetSecretsFlags flags,
-	                     NMSecretAgentGetSecretsFunc callback,
-	                     gpointer user_data);
-
-	/* Called when the subclass should cancel an outstanding request to
-	 * get secrets for a given connection.  Canceling the request MUST
-	 * call the callback that was passed along with the initial get_secrets
-	 * call, sending the NM_SECRET_AGENT_ERROR/NM_SECRET_AGENT_ERROR_AGENT_CANCELED
-	 * error to that callback.
-	 */
-	void (*cancel_get_secrets) (NMSecretAgent *self,
-	                            const char *connection_path,
-	                            const char *setting_name);
-
-	/* Called when the subclass should save the secrets contained in the
-	 * connection to backing storage.  Subclass must copy or reference any
-	 * arguments it may require after returning from this method, as the
-	 * arguments will freed (except for 'self', 'callback', and 'user_data'
-	 * of course).
-	 */
-	void (*save_secrets) (NMSecretAgent *self,
-	                      NMConnection *connection,
-	                      const char *connection_path,
-	                      NMSecretAgentSaveSecretsFunc callback,
-	                      gpointer user_data);
-
-	/* Called when the subclass should delete the secrets contained in the
-	 * connection from backing storage.  Subclass must copy or reference any
-	 * arguments it may require after returning from this method, as the
-	 * arguments will freed (except for 'self', 'callback', and 'user_data'
-	 * of course).
-	 */
-	void (*delete_secrets) (NMSecretAgent *self,
-	                        NMConnection *connection,
-	                        const char *connection_path,
-	                        NMSecretAgentDeleteSecretsFunc callback,
-	                        gpointer user_data);
-
-	/* Signals */
-	void (*registration_result) (NMSecretAgent *agent, GError *error);
-
-	/* Padding for future expansion */
-	void (*_reserved1) (void);
-	void (*_reserved2) (void);
-	void (*_reserved3) (void);
-	void (*_reserved4) (void);
-	void (*_reserved5) (void);
-	void (*_reserved6) (void);
-} NMSecretAgentClass;
-
-
-
 
 
 
-nm_secret_agent_register ()
-gboolean            nm_secret_agent_register            (NMSecretAgent *self);
-
-Registers the NMSecretAgent with the NetworkManager secret manager,
+
nm_secret_agent_register ()
+gboolean
+nm_secret_agent_register (NMSecretAgent *self);
+Registers the NMSecretAgent with the NetworkManager secret manager,
 indicating to NetworkManager that the agent is able to provide and save
 secrets for connections on behalf of its user.  Registration is an
 asynchronous operation and its success or failure is indicated via the
-'registration-result' signal.
-
-
+'registration-result' signal.
+
+Parameters
+
--+++
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
 





 self : a NMSecretAgent
-
Returns : a new TRUE if registration was successfully requested (this does
-not mean registration itself was successful), FALSE if registration was not
-successfully requested.
self a NMSecretAgent  
 
 
+
+Returns
+ a new TRUE if registration was successfully requested (this does
+not mean registration itself was successful), FALSE if registration was not
+successfully requested.
+
+
+
 
 
-nm_secret_agent_unregister ()
-gboolean            nm_secret_agent_unregister          (NMSecretAgent *self);
-
-Unregisters the NMSecretAgent with the NetworkManager secret manager,
+
nm_secret_agent_unregister ()
+gboolean
+nm_secret_agent_unregister (NMSecretAgent *self);
+Unregisters the NMSecretAgent with the NetworkManager secret manager,
 indicating to NetworkManager that the agent is will no longer provide or
-store secrets on behalf of this user.
-
-
+store secrets on behalf of this user.
+
+Parameters
+
--+++
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
 





 self : a NMSecretAgent
-
Returns : a new TRUE if unregistration was successful, FALSE if it was not.
self a NMSecretAgent  
 
 
+
+Returns
+ a new TRUE if unregistration was successful, FALSE if it was not.
+
+
+
 
 
-nm_secret_agent_get_registered ()
-gboolean            nm_secret_agent_get_registered      (NMSecretAgent *self);
-
+nm_secret_agent_get_registered ()
+gboolean
+nm_secret_agent_get_registered (NMSecretAgent *self);
+
+Parameters
+
--++++
+
+
+
+
+
+
 





self a NMSecretAgent  
+
+
+Returns
+ a TRUE if the agent is registered, FALSE if it is not.
+
+
+

nm_secret_agent_get_secrets ()

void
+nm_secret_agent_get_secrets (NMSecretAgent *self,
+                             NMConnection *connection,
+                             const char *setting_name,
+                             const char **hints,
+                             NMSecretAgentGetSecretsFlags flags,
+                             NMSecretAgentGetSecretsFunc callback,
+                             gpointer user_data);

Asyncronously retrieve secrets belonging to connection + for the +setting setting_name +. flags + indicate specific behavior that the secret +agent should use when performing the request, for example returning only +existing secrets without user interaction, or requesting entirely new +secrets from the user.

Virtual: get_secrets

Parameters

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

`self` :	a NMSecretAgent -	self	a NMSecretAgent
connection	the NMConnection for which we're asked secrets
setting_name	the name of the secret setting
hints	hints to the agent.	[array zero-terminated=1]
Returns :	a `TRUE` if the agent is registered, `FALSE` if it is not.	flags	flags that modify the behavior of the request
callback	a callback, to be invoked when the operation is done.	[scope async]
user_data	caller-specific data to be passed to `callback` +.	[closure]

nm_secret_agent_get_secrets ()

void                nm_secret_agent_get_secrets         (NMSecretAgent *self,
-                                                         NMConnection *connection,
-                                                         const char *setting_name,
-                                                         const char **hints,
-                                                         NMSecretAgentGetSecretsFlags flags,
-                                                         NMSecretAgentGetSecretsFunc callback,
-                                                         gpointer user_data);

-Asyncronously retrieve secrets belonging to connection for the -setting setting_name. flags indicate specific behavior that the secret -agent should use when performing the request, for example returning only -existing secrets without user interaction, or requesting entirely new -secrets from the user. -

-Virtual: get_secrets -

nm_secret_agent_save_secrets ()

void
+nm_secret_agent_save_secrets (NMSecretAgent *self,
+                              NMConnection *connection,
+                              NMSecretAgentSaveSecretsFunc callback,
+                              gpointer user_data);

Asyncronously ensure that all secrets inside connection + +are stored to disk.

Virtual: save_secrets

Parameters

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

`self` :	a NMSecretAgent -	self	a NMSecretAgent
`connection` :	the NMConnection for which we're asked secrets	connection	a NMConnection
`setting_name` :	the name of the secret setting	callback	a callback, to be invoked when the operation is done.	[scope async]
`hints` :	hints to the agent. [array zero-terminated=1] -	user_data	caller-specific data to be passed to `callback` +.	[closure]

nm_secret_agent_delete_secrets ()

void
+nm_secret_agent_delete_secrets (NMSecretAgent *self,
+                                NMConnection *connection,
+                                NMSecretAgentDeleteSecretsFunc callback,
+                                gpointer user_data);

Asynchronously ask the agent to delete all saved secrets belonging to +connection +.

Virtual: delete_secrets

Parameters

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

self	a NMSecretAgent
`flags` :	flags that modify the behavior of the request	connection	a NMConnection
`callback` :	a callback, to be invoked when the operation is done. [scope async] -	callback	a callback, to be invoked when the operation is done.	[scope async]
`user_data` :	caller-specific data to be passed to `callback`. [closure] -	user_data	caller-specific data to be passed to `callback` +.	[closure]

Types and Values

nm_secret_agent_save_secrets ()

void                nm_secret_agent_save_secrets        (NMSecretAgent *self,
-                                                         NMConnection *connection,
-                                                         NMSecretAgentSaveSecretsFunc callback,
-                                                         gpointer user_data);

-Asyncronously ensure that all secrets inside connection -are stored to disk. -

-Virtual: save_secrets -

enum NMSecretAgentError

NMSecretAgentError values are passed by secret agents back to NetworkManager +when they encounter problems retrieving secrets on behalf of NM.

Members

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

`self` :	a NMSecretAgent +	NM_SECRET_AGENT_ERROR_NOT_AUTHORIZED	+ the caller (ie, NetworkManager) is not + authorized to make this request
`connection` :	a NMConnection +	NM_SECRET_AGENT_ERROR_INVALID_CONNECTION	+ the connection for which secrets + were requested could not be found
`callback` :	a callback, to be invoked when the operation is done. [scope async] +	NM_SECRET_AGENT_ERROR_USER_CANCELED	+ the request was canceled by the user
`user_data` :	caller-specific data to be passed to `callback`. [closure] +	NM_SECRET_AGENT_ERROR_AGENT_CANCELED	+ the agent canceled the request + because it was requested to do so by NetworkManager
NM_SECRET_AGENT_ERROR_INTERNAL_ERROR	+ some internal error in the agent caused + the request to fail +
NM_SECRET_AGENT_ERROR_NO_SECRETS	+ the agent cannot find any secrets for this + connection +

nm_secret_agent_delete_secrets ()

void                nm_secret_agent_delete_secrets      (NMSecretAgent *self,
-                                                         NMConnection *connection,
-                                                         NMSecretAgentDeleteSecretsFunc callback,
-                                                         gpointer user_data);

-Asynchronously ask the agent to delete all saved secrets belonging to -connection. -

-Virtual: delete_secrets -

enum NMSecretAgentGetSecretsFlags

NMSecretAgentGetSecretsFlags values modify the behavior of a GetSecrets request.

Members

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

`self` :	a NMSecretAgent +	NM_SECRET_AGENT_GET_SECRETS_FLAG_NONE	+ no special behavior; by default no +user interaction is allowed and requests for secrets are fulfilled from +persistent storage, or if no secrets are available an error is returned.
`connection` :	a NMConnection +	NM_SECRET_AGENT_GET_SECRETS_FLAG_ALLOW_INTERACTION	+ allows the request to +interact with the user, possibly prompting via UI for secrets if any are +required, or if none are found in persistent storage.
`callback` :	a callback, to be invoked when the operation is done. [scope async] +	NM_SECRET_AGENT_GET_SECRETS_FLAG_REQUEST_NEW	+ explicitly prompt for new +secrets from the user. This flag signals that NetworkManager thinks any +existing secrets are invalid or wrong. This flag implies that interaction +is allowed.
`user_data` :	caller-specific data to be passed to `callback`. [closure] +	NM_SECRET_AGENT_GET_SECRETS_FLAG_USER_REQUESTED	+ set if the request was +initiated by user-requested action via the D-Bus interface, as opposed to +automatically initiated by NetworkManager in response to (for example) scan +results or carrier changes.

Property Details

The `"auto-register"` property

  "auto-register"            gboolean              : Read / Write / Construct

NM_SECRET_AGENT_IDENTIFIER

#define NM_SECRET_AGENT_IDENTIFIER          "identifier"
+

-If TRUE, the agent will attempt to automatically register itself after -it is created (via an idle handler) and to re-register itself if -NetworkManager restarts. If FALSE, the agent does not automatically -register with NetworkManager, and nm_secret_agent_register() must be -called. If 'auto-register' is TRUE, calling nm_secret_agent_unregister() -will suppress auto-registration until nm_secret_agent_register() is -called, which re-enables auto-registration.

Default value: TRUE

The `"identifier"` property

  "identifier"               gchar*                : Read / Write / Construct Only

NM_SECRET_AGENT_AUTO_REGISTER

#define NM_SECRET_AGENT_AUTO_REGISTER       "auto-register"
+

-Identifies this agent; only one agent in each user session may use the -same identifier. Identifier formatting follows the same rules as -D-Bus bus names with the exception that the ':' character is not -allowed. The valid set of characters is "[A-Z][a-z][0-9]_-." and the -identifier is limited in length to 255 characters with a minimum -of 3 characters. An example valid identifier is 'org.gnome.nm-applet' -(without quotes).

Default value: NULL

The `"registered"` property

  "registered"               gboolean              : Read

NM_SECRET_AGENT_REGISTERED

#define NM_SECRET_AGENT_REGISTERED          "registered"
+

-TRUE if the agent is registered with NetworkManager, FALSE if not.

NM_SECRET_AGENT_REGISTRATION_RESULT

#define NM_SECRET_AGENT_REGISTRATION_RESULT "registration-result"
+

Property Details

The `“auto-register”` property

  “auto-register”            gboolean

Auto Register.

Flags: Read / Write / Construct

Default value: TRUE

The `“identifier”` property

  “identifier”               gchar *

Identifier.

Flags: Read / Write / Construct Only

Default value: NULL

The `“registered”` property

  “registered”               gboolean

Registered.

Flags: Read

Default value: FALSE

Signal Details

The `"registration-result"` signal

void                user_function                      (NMSecretAgent *agent,
-                                                        gpointer       error,
-                                                        gpointer       user_data)      : Run First

-Indicates the result of a registration request; if error is NULL the -request was successful. -

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

`agent` :	the agent that received the signal
`error` :	the error, if any, that occured while registering
`user_data` :	user data set when the signal handler was connected.

The `“registration-result”` signal

void
+user_function (NMSecretAgent *agent,
+               gpointer       error,
+               gpointer       user_data)

Flags: Run First

+ Generated by GTK-Doc V1.20 \ No newline at end of file diff --git a/docs/libnm-glib/html/NMVPNConnection.html b/docs/libnm-glib/html/NMVPNConnection.html index 4241b467..1b1238f9 100644 --- a/docs/libnm-glib/html/NMVPNConnection.html +++ b/docs/libnm-glib/html/NMVPNConnection.html @@ -2,38 +2,29 @@ -NMVPNConnection +libnm-glib Reference Manual: NMVPNConnection - + - - - - - - - - - -

			libnm-glib Reference Manual
-Top - \| - Description - \| - Object Hierarchy - \| - Implemented Interfaces - \| - Properties - \| - Signals -

+ + + + + + +

@@ -41,200 +32,237 @@

NMVPNConnection

- +

Synopsis

#define             NM_VPN_CONNECTION_VPN_STATE
-#define             NM_VPN_CONNECTION_BANNER
-                    NMVPNConnection;
-                    NMVPNConnectionClass;
-GObject *           nm_vpn_connection_new               (DBusGConnection *connection,
-                                                         const char *path);
-NMVPNConnectionState nm_vpn_connection_get_vpn_state    (NMVPNConnection *vpn);
-const char *        nm_vpn_connection_get_banner        (NMVPNConnection *vpn);
-

Object Hierarchy

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

Implemented Interfaces

-NMVPNConnection implements - GInitable and GAsyncInitable.

Functions

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

+GObject * +	+nm_vpn_connection_new () +
+NMVPNConnectionState +	+nm_vpn_connection_get_vpn_state () +
const char * +	+nm_vpn_connection_get_banner () +

Properties

-  "banner"                   gchar*                : Read
-  "vpn-state"                guint                 : Read
-

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

+gchar *	banner	Read
guint	vpn-state	Read

Signals

-  "vpn-state-changed"                              : Run First
-

+++++ + + + + + +

void

vpn-state-changed