From a4256940da049f91bbbea5e53e469a59ea9c10f7 Mon Sep 17 00:00:00 2001 From: Sjoerd Simons Date: Fri, 25 Oct 2013 21:20:58 +0200 Subject: Imported Upstream version 0.9.8.8 --- docs/libnm-util/html/NMConnection.html | 1362 +++++++------ docs/libnm-util/html/NMSetting.html | 1042 +++++----- docs/libnm-util/html/NMSetting8021x.html | 2098 +++++++++++--------- docs/libnm-util/html/NMSettingAdsl.html | 246 ++- docs/libnm-util/html/NMSettingBluetooth.html | 137 +- docs/libnm-util/html/NMSettingBond.html | 283 +-- docs/libnm-util/html/NMSettingBridge.html | 244 ++- docs/libnm-util/html/NMSettingBridgePort.html | 164 +- docs/libnm-util/html/NMSettingCdma.html | 163 +- docs/libnm-util/html/NMSettingConnection.html | 588 +++--- docs/libnm-util/html/NMSettingGsm.html | 586 +++--- docs/libnm-util/html/NMSettingIP4Config.html | 1389 +++++++------ docs/libnm-util/html/NMSettingIP6Config.html | 1439 ++++++++------ docs/libnm-util/html/NMSettingInfiniband.html | 134 +- docs/libnm-util/html/NMSettingOlpcMesh.html | 128 +- docs/libnm-util/html/NMSettingPPP.html | 441 ++-- docs/libnm-util/html/NMSettingPPPOE.html | 187 +- docs/libnm-util/html/NMSettingSerial.html | 172 +- docs/libnm-util/html/NMSettingVPN.html | 486 +++-- docs/libnm-util/html/NMSettingVlan.html | 515 ++--- docs/libnm-util/html/NMSettingWimax.html | 141 +- docs/libnm-util/html/NMSettingWired.html | 391 ++-- docs/libnm-util/html/NMSettingWireless.html | 565 +++--- .../libnm-util/html/NMSettingWirelessSecurity.html | 853 ++++---- docs/libnm-util/html/annotation-glossary.html | 67 +- docs/libnm-util/html/api-index-full.html | 18 +- docs/libnm-util/html/ch01.html | 12 +- docs/libnm-util/html/index.html | 12 +- docs/libnm-util/html/index.sgml | 1154 +++++------ docs/libnm-util/html/libnm-util-nm-utils.html | 1314 ++++++------ docs/libnm-util/html/libnm-util.devhelp2 | 1102 +++++----- docs/libnm-util/html/object-tree.html | 10 +- 32 files changed, 9532 insertions(+), 7911 deletions(-) (limited to 'docs/libnm-util/html') diff --git a/docs/libnm-util/html/NMConnection.html b/docs/libnm-util/html/NMConnection.html index 3f55caf8..7c3d81b0 100644 --- a/docs/libnm-util/html/NMConnection.html +++ b/docs/libnm-util/html/NMConnection.html @@ -3,12 +3,12 @@ NMConnection - + - + @@ -46,47 +46,74 @@
 #include <nm-connection.h>
 
-                    NMConnection;
-                    NMConnectionClass;
 enum                NMConnectionError;
 #define             NM_CONNECTION_ERROR
+GQuark              nm_connection_error_quark           (void);
 #define             NM_CONNECTION_PATH
+                    NMConnection;
+                    NMConnectionClass;
+NMConnection *      nm_connection_new                   (void);
+NMConnection *      nm_connection_new_from_hash         (GHashTable *hash,
+                                                         GError **error);
+NMConnection *      nm_connection_duplicate             (NMConnection *connection);
+NMSetting *         nm_connection_create_setting        (const char *name);
 void                nm_connection_add_setting           (NMConnection *connection,
                                                          NMSetting *setting);
-void                nm_connection_clear_secrets         (NMConnection *connection);
-void                nm_connection_clear_secrets_with_flags
-                                                        (NMConnection *connection,
-                                                         NMSettingClearSecretsWithFlagsFn func,
-                                                         gpointer user_data);
+void                nm_connection_remove_setting        (NMConnection *connection,
+                                                         GType setting_type);
+NMSetting *         nm_connection_get_setting           (NMConnection *connection,
+                                                         GType setting_type);
+NMSetting *         nm_connection_get_setting_by_name   (NMConnection *connection,
+                                                         const char *name);
+gboolean            nm_connection_replace_settings      (NMConnection *connection,
+                                                         GHashTable *new_settings,
+                                                         GError **error);
 gboolean            nm_connection_compare               (NMConnection *a,
                                                          NMConnection *b,
                                                          NMSettingCompareFlags flags);
-NMSetting *         nm_connection_create_setting        (const char *name);
 gboolean            nm_connection_diff                  (NMConnection *a,
                                                          NMConnection *b,
                                                          NMSettingCompareFlags flags,
                                                          GHashTable **out_settings);
-void                nm_connection_dump                  (NMConnection *connection);
-NMConnection *      nm_connection_duplicate             (NMConnection *connection);
-GQuark              nm_connection_error_quark           (void);
+gboolean            nm_connection_verify                (NMConnection *connection,
+                                                         GError **error);
+const char *        nm_connection_need_secrets          (NMConnection *connection,
+                                                         GPtrArray **hints);
+void                nm_connection_clear_secrets         (NMConnection *connection);
+void                nm_connection_clear_secrets_with_flags
+                                                        (NMConnection *connection,
+                                                         NMSettingClearSecretsWithFlagsFn func,
+                                                         gpointer user_data);
+gboolean            nm_connection_update_secrets        (NMConnection *connection,
+                                                         const char *setting_name,
+                                                         GHashTable *secrets,
+                                                         GError **error);
+void                nm_connection_set_path              (NMConnection *connection,
+                                                         const char *path);
+const char *        nm_connection_get_path              (NMConnection *connection);
+const char *        nm_connection_get_virtual_iface_name
+                                                        (NMConnection *connection);
+gboolean            nm_connection_is_type               (NMConnection *connection,
+                                                         const char *type);
 void                nm_connection_for_each_setting_value
                                                         (NMConnection *connection,
                                                          NMSettingValueIterFn func,
                                                          gpointer user_data);
+GHashTable *        nm_connection_to_hash               (NMConnection *connection,
+                                                         NMSettingHashFlags flags);
+void                nm_connection_dump                  (NMConnection *connection);
+GType               nm_connection_lookup_setting_type   (const char *name);
+GType               nm_connection_lookup_setting_type_by_quark
+                                                        (GQuark error_quark);
+const char *        nm_connection_get_uuid              (NMConnection *connection);
 const char *        nm_connection_get_id                (NMConnection *connection);
-const char *        nm_connection_get_path              (NMConnection *connection);
-NMSetting *         nm_connection_get_setting           (NMConnection *connection,
-                                                         GType setting_type);
 NMSetting8021x *    nm_connection_get_setting_802_1x    (NMConnection *connection);
-NMSettingAdsl *     nm_connection_get_setting_adsl      (NMConnection *connection);
 NMSettingBluetooth * nm_connection_get_setting_bluetooth
                                                         (NMConnection *connection);
 NMSettingBond *     nm_connection_get_setting_bond      (NMConnection *connection);
 NMSettingBridge *   nm_connection_get_setting_bridge    (NMConnection *connection);
 NMSettingBridgePort * nm_connection_get_setting_bridge_port
                                                         (NMConnection *connection);
-NMSetting *         nm_connection_get_setting_by_name   (NMConnection *connection,
-                                                         const char *name);
 NMSettingCdma *     nm_connection_get_setting_cdma      (NMConnection *connection);
 NMSettingConnection * nm_connection_get_setting_connection
                                                         (NMConnection *connection);
@@ -101,53 +128,26 @@ const char *        NMSettingPPP *      nm_connection_get_setting_ppp       (NMConnection *connection);
 NMSettingPPPOE *    nm_connection_get_setting_pppoe     (NMConnection *connection);
 NMSettingSerial *   nm_connection_get_setting_serial    (NMConnection *connection);
-NMSettingVlan *     nm_connection_get_setting_vlan      (NMConnection *connection);
 NMSettingVPN *      nm_connection_get_setting_vpn       (NMConnection *connection);
 NMSettingWimax *    nm_connection_get_setting_wimax     (NMConnection *connection);
+NMSettingAdsl *     nm_connection_get_setting_adsl      (NMConnection *connection);
 NMSettingWired *    nm_connection_get_setting_wired     (NMConnection *connection);
 NMSettingWireless * nm_connection_get_setting_wireless  (NMConnection *connection);
 NMSettingWirelessSecurity * nm_connection_get_setting_wireless_security
                                                         (NMConnection *connection);
-const char *        nm_connection_get_uuid              (NMConnection *connection);
-const char *        nm_connection_get_virtual_iface_name
-                                                        (NMConnection *connection);
-gboolean            nm_connection_is_type               (NMConnection *connection,
-                                                         const char *type);
-GType               nm_connection_lookup_setting_type   (const char *name);
-GType               nm_connection_lookup_setting_type_by_quark
-                                                        (GQuark error_quark);
-const char *        nm_connection_need_secrets          (NMConnection *connection,
-                                                         GPtrArray **hints);
-NMConnection *      nm_connection_new                   (void);
-NMConnection *      nm_connection_new_from_hash         (GHashTable *hash,
-                                                         GError **error);
-void                nm_connection_remove_setting        (NMConnection *connection,
-                                                         GType setting_type);
-gboolean            nm_connection_replace_settings      (NMConnection *connection,
-                                                         GHashTable *new_settings,
-                                                         GError **error);
-void                nm_connection_set_path              (NMConnection *connection,
-                                                         const char *path);
-GHashTable *        nm_connection_to_hash               (NMConnection *connection,
-                                                         NMSettingHashFlags flags);
-gboolean            nm_connection_update_secrets        (NMConnection *connection,
-                                                         const char *setting_name,
-                                                         GHashTable *secrets,
-                                                         GError **error);
-gboolean            nm_connection_verify                (NMConnection *connection,
-                                                         GError **error);
+NMSettingVlan *     nm_connection_get_setting_vlan      (NMConnection *connection);
 

Object Hierarchy

-
-  GObject
-   +----NMConnection
-
   GEnum
    +----NMConnectionError
 
+
+  GObject
+   +----NMConnection
+

Properties

@@ -183,28 +183,6 @@ parameters (MTU, SSID, APN, channel, rate, etc) and IP-level parameters

Details

-

NMConnection

-
typedef struct _NMConnection NMConnection;
-

-The NMConnection struct contains only private data. -It should only be accessed through the functions described below. -

-
-
-
-

NMConnectionClass

-
typedef struct {
-	GObjectClass parent;
-
-	/* Signals */
-	void (*secrets_updated) (NMConnection *connection, const char * setting);
-} NMConnectionClass;
-
-

-

-
-
-

enum NMConnectionError

typedef enum {
 	NM_CONNECTION_ERROR_UNKNOWN = 0,                  /*< nick=UnknownError >*/
@@ -216,8 +194,11 @@ It should only be accessed through the functions described below.
 

Describes errors that may result from operations involving a NMConnection.

-
+
+++ @@ -258,6 +239,24 @@ Describes errors that may result from operations involving a
+

nm_connection_error_quark ()

+
GQuark              nm_connection_error_quark           (void);
+

+Registers an error quark for NMConnection if necessary. +

+

NM_CONNECTION_ERROR_UNKNOWN

++++ + + + + +

Returns :

the error quark used for NMConnection errors.
+
+
+

NM_CONNECTION_PATH

#define NM_CONNECTION_PATH "path"
 
@@ -266,112 +265,100 @@ Describes errors that may result from operations involving a
-

nm_connection_add_setting ()

-
void                nm_connection_add_setting           (NMConnection *connection,
-                                                         NMSetting *setting);
+

NMConnection

+
typedef struct _NMConnection NMConnection;

-Adds a NMSetting to the connection, replacing any previous NMSetting of the -same name which has previously been added to the NMConnection. The -connection takes ownership of the NMSetting object and does not increase -the setting object's reference count. +The NMConnection struct contains only private data. +It should only be accessed through the functions described below.

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

connection :

a NMConnection -

setting :

the NMSetting to add to the connection object. [transfer full] -

-

nm_connection_clear_secrets ()

-
void                nm_connection_clear_secrets         (NMConnection *connection);
+

NMConnectionClass

+
typedef struct {
+	GObjectClass parent;
+
+	/* Signals */
+	void (*secrets_updated) (NMConnection *connection, const char * setting);
+} NMConnectionClass;
+

-Clears and frees any secrets that may be stored in the connection, to avoid -keeping secret data in memory when not needed.

-
+ +
+
+

nm_connection_new ()

+
NMConnection *      nm_connection_new                   (void);
+

+Creates a new NMConnection object with no NMSetting objects. +

+
+++ - - + +

connection :

the NMConnection -

Returns :

the new empty NMConnection object

-

nm_connection_clear_secrets_with_flags ()

-
void                nm_connection_clear_secrets_with_flags
-                                                        (NMConnection *connection,
-                                                         NMSettingClearSecretsWithFlagsFn func,
-                                                         gpointer user_data);
+

nm_connection_new_from_hash ()

+
NMConnection *      nm_connection_new_from_hash         (GHashTable *hash,
+                                                         GError **error);

-Clears and frees secrets determined by func. +Creates a new NMConnection from a hash table describing the connection. See +nm_connection_to_hash() for a description of the expected hash table.

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

connection :

the NMConnection +

hash :

the GHashTable describing +the connection. [element-type utf8 GLib.HashTable]

func :

function to be called to determine whether a -specific secret should be cleared or not. [scope call] -

error :

on unsuccessful return, an error

user_data :

caller-supplied data passed to func -

Returns :

the new NMConnection object, populated with settings created +from the values in the hash table, or NULL if the connection failed to +validate

-

nm_connection_compare ()

-
gboolean            nm_connection_compare               (NMConnection *a,
-                                                         NMConnection *b,
-                                                         NMSettingCompareFlags flags);
+

nm_connection_duplicate ()

+
NMConnection *      nm_connection_duplicate             (NMConnection *connection);

-Compares two NMConnection objects for similarity, with comparison behavior -modified by a set of flags. See nm_setting_compare() for a description of -each flag's behavior. +Duplicates a NMConnection.

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

a :

a NMConnection -

b :

a second NMConnection to compare with the first

flags :

compare flags, e.g. NM_SETTING_COMPARE_FLAG_EXACT -

connection :

the NMConnection to duplicate

Returns :

-TRUE if the comparison succeeds, FALSE if it does nota new NMConnection containing the same settings and properties +as the source NMConnection. [transfer full] +
@@ -383,8 +370,11 @@ each flag's behavior.

Create a new NMSetting object of the desired type, given a setting name.

-
+
+++ @@ -392,7 +382,7 @@ Create a new - @@ -400,88 +390,89 @@ Create a new
-

nm_connection_diff ()

-
gboolean            nm_connection_diff                  (NMConnection *a,
-                                                         NMConnection *b,
-                                                         NMSettingCompareFlags flags,
-                                                         GHashTable **out_settings);
+

nm_connection_add_setting ()

+
void                nm_connection_add_setting           (NMConnection *connection,
+                                                         NMSetting *setting);

-Compares two NMConnection objects for similarity, with comparison behavior -modified by a set of flags. See nm_setting_compare() for a description of -each flag's behavior. If the connections differ, settings and keys within -each setting that differ are added to the returned out_settings hash table. -No values are returned, only key names. +Adds a NMSetting to the connection, replacing any previous NMSetting of the +same name which has previously been added to the NMConnection. The +connection takes ownership of the NMSetting object and does not increase +the setting object's reference count.

-

name :

Returns :

the new setting object, or NULL if the setting name was unknown. [transfer full] +the new setting object, or NULL if the setting name was unknown. [transfer full]
+
+++ - + - - - - - - - - - - + - - - -

a :

connection :

a NMConnection

b :

a second NMConnection to compare with the first

flags :

compare flags, e.g. NM_SETTING_COMPARE_FLAG_EXACT -

out_settings :

if the -connections differ, on return a hash table mapping setting names to -second-level GHashTable (utf8 to guint32), which contains the key names that -differ mapped to one or more of NMSettingDiffResult as a bitfield. [element-type utf8 GLib.HashTable] +

setting :

the NMSetting to add to the connection object. [transfer full]

Returns :

-TRUE if the connections contain the same values, FALSE if they do -not

-

nm_connection_dump ()

-
void                nm_connection_dump                  (NMConnection *connection);
+

nm_connection_remove_setting ()

+
void                nm_connection_remove_setting        (NMConnection *connection,
+                                                         GType setting_type);

-Print the connection to stdout. For debugging purposes ONLY, should NOT -be used for serialization of the connection or machine-parsed in any way. The -output format is not guaranteed to be stable and may change at any time. +Removes the NMSetting with the given GType from the NMConnection. This +operation dereferences the NMSetting object.

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

connection :

the NMConnection +a NMConnection

setting_type :

the GType of the setting object to remove

-

nm_connection_duplicate ()

-
NMConnection *      nm_connection_duplicate             (NMConnection *connection);
+

nm_connection_get_setting ()

+
NMSetting *         nm_connection_get_setting           (NMConnection *connection,
+                                                         GType setting_type);

-Duplicates a NMConnection. +Gets the NMSetting with the given GType, if one has been previously added +to the NMConnection.

-
+
+++ - + + + + + - @@ -489,134 +480,219 @@ as the source
-

nm_connection_error_quark ()

-
GQuark              nm_connection_error_quark           (void);
+

nm_connection_get_setting_by_name ()

+
NMSetting *         nm_connection_get_setting_by_name   (NMConnection *connection,
+                                                         const char *name);

-Registers an error quark for NMConnection if necessary. +Gets the NMSetting with the given name, if one has been previously added +the the NMConnection.

-

connection :

the NMConnection to duplicatea NMConnection +

setting_type :

the GType of the setting object to return

Returns :

a new NMConnection containing the same settings and properties -as the source NMConnection. [transfer full] +the NMSetting, or NULL if no setting of that type was previously +added to the NMConnection. [transfer none]
+
+- ++ + + + + + + + + + + - - + + +

connection :

a NMConnection +

name :

a setting name

Returns :

the error quark used for NMConnection errors.
the NMSetting, or NULL if no setting with that name was previously +added to the NMConnection. [transfer none] +

-

nm_connection_for_each_setting_value ()

-
void                nm_connection_for_each_setting_value
-                                                        (NMConnection *connection,
-                                                         NMSettingValueIterFn func,
-                                                         gpointer user_data);
-

-Iterates over the properties of each NMSetting object in the NMConnection, -calling the supplied user function for each property. -

-
+

nm_connection_replace_settings ()

+
gboolean            nm_connection_replace_settings      (NMConnection *connection,
+                                                         GHashTable *new_settings,
+                                                         GError **error);
+
+++ - - - + - - + + + + + +

connection :

the NMConnection +a NMConnection

func :

user-supplied function called for each setting's property. [scope call] +

new_settings :

a GHashTable of settings. [element-type utf8 GLib.HashTable]

user_data :

user data passed to func at each invocation

error :

location to store error, or NULL +

Returns :

+TRUE if the settings were valid and added to the connection, FALSE +if they were not

-

nm_connection_get_id ()

-
const char *        nm_connection_get_id                (NMConnection *connection);
+

nm_connection_compare ()

+
gboolean            nm_connection_compare               (NMConnection *a,
+                                                         NMConnection *b,
+                                                         NMSettingCompareFlags flags);

-A shortcut to return the ID from the connection's NMSettingConnection. +Compares two NMConnection objects for similarity, with comparison behavior +modified by a set of flags. See nm_setting_compare() for a description of +each flag's behavior.

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

connection :

the NMConnection +

a :

a NMConnection +

b :

a second NMConnection to compare with the first

flags :

compare flags, e.g. NM_SETTING_COMPARE_FLAG_EXACT

Returns :

the ID from the connection's 'connection' setting +TRUE if the comparison succeeds, FALSE if it does not

-

nm_connection_get_path ()

-
const char *        nm_connection_get_path              (NMConnection *connection);
+

nm_connection_diff ()

+
gboolean            nm_connection_diff                  (NMConnection *a,
+                                                         NMConnection *b,
+                                                         NMSettingCompareFlags flags,
+                                                         GHashTable **out_settings);

-Returns the connection's D-Bus path. +Compares two NMConnection objects for similarity, with comparison behavior +modified by a set of flags. See nm_setting_compare() for a description of +each flag's behavior. If the connections differ, settings and keys within +each setting that differ are added to the returned out_settings hash table. +No values are returned, only key names.

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

connection :

the NMConnection +

a :

a NMConnection +

b :

a second NMConnection to compare with the first

flags :

compare flags, e.g. NM_SETTING_COMPARE_FLAG_EXACT +

out_settings :

if the +connections differ, on return a hash table mapping setting names to +second-level GHashTable (utf8 to guint32), which contains the key names that +differ mapped to one or more of NMSettingDiffResult as a bitfield. [element-type utf8 GLib.HashTable]

Returns :

the D-Bus path of the connection, previously set by a call to -nm_connection_set_path(). +TRUE if the connections contain the same values, FALSE if they do +not

-

nm_connection_get_setting ()

-
NMSetting *         nm_connection_get_setting           (NMConnection *connection,
-                                                         GType setting_type);
+

nm_connection_verify ()

+
gboolean            nm_connection_verify                (NMConnection *connection,
+                                                         GError **error);

-Gets the NMSetting with the given GType, if one has been previously added -to the NMConnection. +Validates the connection and all its settings. Each setting's properties +have allowed values, and some values are dependent on other values. For +example, if a WiFi connection is security enabled, the NMSettingWireless +setting object's 'security' property must contain the setting name of the +NMSettingWirelessSecurity object, which must also be present in the +connection for the connection to be valid. As another example, the +NMSettingWired object's 'mac-address' property must be a validly formatted +MAC address. The returned GError contains information about which +setting and which property failed validation, and how it failed validation.

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

connection :

a NMConnection -the NMConnection to verify

setting_type :

the GType of the setting object to return

error :

location to store error, or NULL +

Returns :

the NMSetting, or NULL if no setting of that type was previously -added to the NMConnection. [transfer none] - +TRUE if the connection is valid, FALSE if it is not

-

nm_connection_get_setting_802_1x ()

-
NMSetting8021x *    nm_connection_get_setting_802_1x    (NMConnection *connection);
+

nm_connection_need_secrets ()

+
const char *        nm_connection_need_secrets          (NMConnection *connection,
+                                                         GPtrArray **hints);

-A shortcut to return any NMSetting8021x the connection might contain. +Returns the name of the first setting object in the connection which would +need secrets to make a successful connection. The returned hints are only +intended as a guide to what secrets may be required, because in some +circumstances, there is no way to conclusively determine exactly which +secrets are needed.

-
+
+++ @@ -624,22 +700,57 @@ A shortcut to return any Returns :

-
+ + + + +

connection :

an NMSetting8021x if the connection contains one, otherwise NULL. [transfer none] +

hints :

the address of a pointer to a GPtrArray, initialized to NULL, which on +return points to an allocated GPtrArray containing the property names of +secrets of the NMSetting which may be required; the caller owns the array +and must free the array itself with g_ptr_array_free(), but not free its +elements. [out][element-type utf8][allow-none][transfer container]

Returns :

the setting name of the NMSetting object which has invalid or +missing secrets

-

nm_connection_get_setting_adsl ()

-
NMSettingAdsl *     nm_connection_get_setting_adsl      (NMConnection *connection);
+

nm_connection_clear_secrets ()

+
void                nm_connection_clear_secrets         (NMConnection *connection);
+

+Clears and frees any secrets that may be stored in the connection, to avoid +keeping secret data in memory when not needed. +

+
++++ + + + + +

connection :

the NMConnection +
+
+
+
+

nm_connection_clear_secrets_with_flags ()

+
void                nm_connection_clear_secrets_with_flags
+                                                        (NMConnection *connection,
+                                                         NMSettingClearSecretsWithFlagsFn func,
+                                                         gpointer user_data);

-A shortcut to return any NMSettingAdsl the connection might contain. +Clears and frees secrets determined by func.

-
+
+++ @@ -647,8 +758,14 @@ A shortcut to return any Returns :

-
+ + + + + @@ -656,14 +773,24 @@ A shortcut to return any -

nm_connection_get_setting_bluetooth ()

-
NMSettingBluetooth * nm_connection_get_setting_bluetooth
-                                                        (NMConnection *connection);
+

nm_connection_update_secrets ()

+
gboolean            nm_connection_update_secrets        (NMConnection *connection,
+                                                         const char *setting_name,
+                                                         GHashTable *secrets,
+                                                         GError **error);

-A shortcut to return any NMSettingBluetooth the connection might contain. +Update the specified setting's secrets, given a hash table of secrets +intended for that setting (deserialized from D-Bus for example). Will also +extract the given setting's secrets hash if given a hash of hashes, as would +be returned from nm_connection_to_hash(). If setting_name is NULL, expects +a fully serialized NMConnection as returned by nm_connection_to_hash() and +will update all secrets from all settings contained in secrets.

-

connection :

an NMSettingAdsl if the connection contains one, otherwise NULL. [transfer none] +

func :

function to be called to determine whether a +specific secret should be cleared or not. [scope call] +

user_data :

caller-supplied data passed to func
+
+++ @@ -671,22 +798,44 @@ A shortcut to return any Returns :

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

connection :

an NMSettingBluetooth if the connection contains one, otherwise NULL. [transfer none] +

setting_name :

the setting object name to which the secrets apply

secrets :

a GHashTable mapping +string:GValue of setting property names and secrets of the given setting_name. [element-type utf8 GObject.Value] +

error :

location to store error, or NULL

Returns :

+TRUE if the secrets were successfully updated, FALSE if the update +failed (tried to update secrets for a setting that doesn't exist, etc)

-

nm_connection_get_setting_bond ()

-
NMSettingBond *     nm_connection_get_setting_bond      (NMConnection *connection);
+

nm_connection_set_path ()

+
void                nm_connection_set_path              (NMConnection *connection,
+                                                         const char *path);

-A shortcut to return any NMSettingBond the connection might contain. +Sets the D-Bus path of the connection. This property is not serialized, and +is only for the reference of the caller. Sets the "path" +property.

-
+
+++ @@ -694,22 +843,25 @@ A shortcut to return any Returns :

-
+ +

connection :

an NMSettingBond if the connection contains one, otherwise NULL. [transfer none] -

path :

the D-Bus path of the connection as given by the settings service +which provides the connection

-

nm_connection_get_setting_bridge ()

-
NMSettingBridge *   nm_connection_get_setting_bridge    (NMConnection *connection);
+

nm_connection_get_path ()

+
const char *        nm_connection_get_path              (NMConnection *connection);

-A shortcut to return any NMSettingBridge the connection might contain. +Returns the connection's D-Bus path.

-
+
+++ @@ -718,31 +870,37 @@ A shortcut to return any Returns :

-
+

connection :

an NMSettingBridge if the connection contains one, otherwise NULL. [transfer none] -the D-Bus path of the connection, previously set by a call to +nm_connection_set_path().

-

nm_connection_get_setting_bridge_port ()

-
NMSettingBridgePort * nm_connection_get_setting_bridge_port
+

nm_connection_get_virtual_iface_name ()

+
const char *        nm_connection_get_virtual_iface_name
                                                         (NMConnection *connection);

-A shortcut to return any NMSettingBridgePort the connection might contain. +Returns the name of the virtual kernel interface which the connection +needs to use if specified in the settings. This function abstracts all +connection types which require this functionality. For all other +connection types, this function will return NULL.

-
+
+++ - - @@ -750,43 +908,54 @@ A shortcut to return any -

nm_connection_get_setting_by_name ()

-
NMSetting *         nm_connection_get_setting_by_name   (NMConnection *connection,
-                                                         const char *name);
+

nm_connection_is_type ()

+
gboolean            nm_connection_is_type               (NMConnection *connection,
+                                                         const char *type);

-Gets the NMSetting with the given name, if one has been previously added -the the NMConnection. +A convenience function to check if the given connection is a particular +type (ie wired, wifi, ppp, etc). Checks the "type" +property of the connection and matches that against type.

-

connection :

the NMConnection +The NMConnection

Returns :

an NMSettingBridgePort if the connection contains one, otherwise NULL. [transfer none] +Name of the kernel interface or NULL
+
+++ - - - + + - +

connection :

a NMConnection +the NMConnection

name :

a setting name

type :

a setting name to check the connection's type against (like +NM_SETTING_WIRELESS_SETTING_NAME or NM_SETTING_WIRED_SETTING_NAME)

Returns :

the NMSetting, or NULL if no setting with that name was previously -added to the NMConnection. [transfer none] - +TRUE if the connection is of the given type, FALSE if not

-

nm_connection_get_setting_cdma ()

-
NMSettingCdma *     nm_connection_get_setting_cdma      (NMConnection *connection);
+

nm_connection_for_each_setting_value ()

+
void                nm_connection_for_each_setting_value
+                                                        (NMConnection *connection,
+                                                         NMSettingValueIterFn func,
+                                                         gpointer user_data);

-A shortcut to return any NMSettingCdma the connection might contain. +Iterates over the properties of each NMSetting object in the NMConnection, +calling the supplied user function for each property.

-
+
+++ @@ -794,23 +963,35 @@ A shortcut to return any Returns :

-
+ + + + +

connection :

an NMSettingCdma if the connection contains one, otherwise NULL. [transfer none] +

func :

user-supplied function called for each setting's property. [scope call]

user_data :

user data passed to func at each invocation

-

nm_connection_get_setting_connection ()

-
NMSettingConnection * nm_connection_get_setting_connection
-                                                        (NMConnection *connection);
+

nm_connection_to_hash ()

+
GHashTable *        nm_connection_to_hash               (NMConnection *connection,
+                                                         NMSettingHashFlags flags);

-A shortcut to return any NMSettingConnection the connection might contain. +Converts the NMConnection into a GHashTable describing the connection, +suitable for marshalling over D-Bus or serializing. The hash table mapping +is string:GHashTable with each element in the returned hash representing +a NMSetting object. The keys are setting object names, and the values +are GHashTables mapping string:GValue, each of which represents the +properties of the NMSetting object.

-
+
+++ @@ -818,8 +999,16 @@ A shortcut to return any flags :

+
+ + - @@ -827,85 +1016,87 @@ A shortcut to return any -

nm_connection_get_setting_gsm ()

-
NMSettingGsm *      nm_connection_get_setting_gsm       (NMConnection *connection);
+

nm_connection_dump ()

+
void                nm_connection_dump                  (NMConnection *connection);

-A shortcut to return any NMSettingGsm the connection might contain. +Print the connection to stdout. For debugging purposes ONLY, should NOT +be used for serialization of the connection or machine-parsed in any way. The +output format is not guaranteed to be stable and may change at any time.

-

connection :

hash flags, e.g. NM_SETTING_HASH_FLAG_ALL +

Returns :

an NMSettingConnection if the connection contains one, otherwise NULL. [transfer none] +a new +GHashTable describing the connection, its settings, and each setting's +properties. The caller owns the hash table and must unref the hash table +with g_hash_table_unref() when it is no longer needed. [transfer full][element-type utf8 GLib.HashTable]
+
+- - ++ + - - - - - - +

connection :

the NMConnection

Returns :

an NMSettingGsm if the connection contains one, otherwise NULL. [transfer none] -

-

nm_connection_get_setting_infiniband ()

-
NMSettingInfiniband * nm_connection_get_setting_infiniband
-                                                        (NMConnection *connection);
+

nm_connection_lookup_setting_type ()

+
GType               nm_connection_lookup_setting_type   (const char *name);

-A shortcut to return any NMSettingInfiniband the connection might contain. +Returns the GType of the setting's class for a given setting name.

-
+
+++ - - + + - +

connection :

the NMConnection -

name :

a setting name

Returns :

an NMSettingInfiniband if the connection contains one, otherwise NULL. [transfer none] -the GType of the setting's class

-

nm_connection_get_setting_ip4_config ()

-
NMSettingIP4Config * nm_connection_get_setting_ip4_config
-                                                        (NMConnection *connection);
+

nm_connection_lookup_setting_type_by_quark ()

+
GType               nm_connection_lookup_setting_type_by_quark
+                                                        (GQuark error_quark);

-A shortcut to return any NMSettingIP4Config the connection might contain. +Returns the GType of the setting's class for a given setting error quark. +Useful for figuring out which setting a returned error is for.

-
+
+++ - - + + - +

connection :

the NMConnection -

error_quark :

a setting error quark

Returns :

an NMSettingIP4Config if the connection contains one, otherwise NULL. [transfer none] -the GType of the setting's class

-

nm_connection_get_setting_ip6_config ()

-
NMSettingIP6Config * nm_connection_get_setting_ip6_config
-                                                        (NMConnection *connection);
+

nm_connection_get_uuid ()

+
const char *        nm_connection_get_uuid              (NMConnection *connection);

-A shortcut to return any NMSettingIP6Config the connection might contain. +A shortcut to return the UUID from the connection's NMSettingConnection.

-
+
+++ @@ -914,21 +1105,23 @@ A shortcut to return any Returns :

-
+

connection :

an NMSettingIP6Config if the connection contains one, otherwise NULL. [transfer none] -the UUID from the connection's 'connection' setting

-

nm_connection_get_setting_olpc_mesh ()

-
NMSettingOlpcMesh * nm_connection_get_setting_olpc_mesh (NMConnection *connection);
+

nm_connection_get_id ()

+
const char *        nm_connection_get_id                (NMConnection *connection);

-A shortcut to return any NMSettingOlpcMesh the connection might contain. +A shortcut to return the ID from the connection's NMSettingConnection.

-
+
+++ @@ -937,21 +1130,23 @@ A shortcut to return any Returns :

-
+

connection :

an NMSettingOlpcMesh if the connection contains one, otherwise NULL. [transfer none] -the ID from the connection's 'connection' setting

-

nm_connection_get_setting_ppp ()

-
NMSettingPPP *      nm_connection_get_setting_ppp       (NMConnection *connection);
+

nm_connection_get_setting_802_1x ()

+
NMSetting8021x *    nm_connection_get_setting_802_1x    (NMConnection *connection);

-A shortcut to return any NMSettingPPP the connection might contain. +A shortcut to return any NMSetting8021x the connection might contain.

-
+
+++ @@ -960,7 +1155,7 @@ A shortcut to return any Returns :

-
@@ -968,13 +1163,17 @@ A shortcut to return any -

nm_connection_get_setting_pppoe ()

-
NMSettingPPPOE *    nm_connection_get_setting_pppoe     (NMConnection *connection);
+

nm_connection_get_setting_bluetooth ()

+
NMSettingBluetooth * nm_connection_get_setting_bluetooth
+                                                        (NMConnection *connection);

-A shortcut to return any NMSettingPPPOE the connection might contain. +A shortcut to return any NMSettingBluetooth the connection might contain.

-

connection :

an NMSettingPPP if the connection contains one, otherwise NULL. [transfer none] +an NMSetting8021x if the connection contains one, otherwise NULL. [transfer none]
+
+++ @@ -983,7 +1182,7 @@ A shortcut to return any Returns :

-
@@ -991,13 +1190,16 @@ A shortcut to return any -

nm_connection_get_setting_serial ()

-
NMSettingSerial *   nm_connection_get_setting_serial    (NMConnection *connection);
+

nm_connection_get_setting_bond ()

+
NMSettingBond *     nm_connection_get_setting_bond      (NMConnection *connection);

-A shortcut to return any NMSettingSerial the connection might contain. +A shortcut to return any NMSettingBond the connection might contain.

-

connection :

an NMSettingPPPOE if the connection contains one, otherwise NULL. [transfer none] +an NMSettingBluetooth if the connection contains one, otherwise NULL. [transfer none]
+
+++ @@ -1006,7 +1208,7 @@ A shortcut to return any Returns :

-
@@ -1014,13 +1216,16 @@ A shortcut to return any -

nm_connection_get_setting_vlan ()

-
NMSettingVlan *     nm_connection_get_setting_vlan      (NMConnection *connection);
+

nm_connection_get_setting_bridge ()

+
NMSettingBridge *   nm_connection_get_setting_bridge    (NMConnection *connection);

-A shortcut to return any NMSettingVlan the connection might contain. +A shortcut to return any NMSettingBridge the connection might contain.

-

connection :

an NMSettingSerial if the connection contains one, otherwise NULL. [transfer none] +an NMSettingBond if the connection contains one, otherwise NULL. [transfer none]
+
+++ @@ -1029,7 +1234,7 @@ A shortcut to return any Returns :

-
@@ -1037,13 +1242,17 @@ A shortcut to return any -

nm_connection_get_setting_vpn ()

-
NMSettingVPN *      nm_connection_get_setting_vpn       (NMConnection *connection);
+

nm_connection_get_setting_bridge_port ()

+
NMSettingBridgePort * nm_connection_get_setting_bridge_port
+                                                        (NMConnection *connection);

-A shortcut to return any NMSettingVPN the connection might contain. +A shortcut to return any NMSettingBridgePort the connection might contain.

-

connection :

an NMSettingVlan if the connection contains one, otherwise NULL. [transfer none] +an NMSettingBridge if the connection contains one, otherwise NULL. [transfer none]
+
+++ @@ -1052,7 +1261,7 @@ A shortcut to return any Returns :

-
@@ -1060,13 +1269,16 @@ A shortcut to return any -

nm_connection_get_setting_wimax ()

-
NMSettingWimax *    nm_connection_get_setting_wimax     (NMConnection *connection);
+

nm_connection_get_setting_cdma ()

+
NMSettingCdma *     nm_connection_get_setting_cdma      (NMConnection *connection);

-A shortcut to return any NMSettingWimax the connection might contain. +A shortcut to return any NMSettingCdma the connection might contain.

-

connection :

an NMSettingVPN if the connection contains one, otherwise NULL. [transfer none] +an NMSettingBridgePort if the connection contains one, otherwise NULL. [transfer none]
+
+++ @@ -1075,7 +1287,7 @@ A shortcut to return any Returns :

-
@@ -1083,13 +1295,17 @@ A shortcut to return any -

nm_connection_get_setting_wired ()

-
NMSettingWired *    nm_connection_get_setting_wired     (NMConnection *connection);
+

nm_connection_get_setting_connection ()

+
NMSettingConnection * nm_connection_get_setting_connection
+                                                        (NMConnection *connection);

-A shortcut to return any NMSettingWired the connection might contain. +A shortcut to return any NMSettingConnection the connection might contain.

-

connection :

an NMSettingWimax if the connection contains one, otherwise NULL. [transfer none] +an NMSettingCdma if the connection contains one, otherwise NULL. [transfer none]
+
+++ @@ -1098,7 +1314,7 @@ A shortcut to return any Returns :

-
@@ -1106,13 +1322,16 @@ A shortcut to return any -

nm_connection_get_setting_wireless ()

-
NMSettingWireless * nm_connection_get_setting_wireless  (NMConnection *connection);
+

nm_connection_get_setting_gsm ()

+
NMSettingGsm *      nm_connection_get_setting_gsm       (NMConnection *connection);

-A shortcut to return any NMSettingWireless the connection might contain. +A shortcut to return any NMSettingGsm the connection might contain.

-

connection :

an NMSettingWired if the connection contains one, otherwise NULL. [transfer none] +an NMSettingConnection if the connection contains one, otherwise NULL. [transfer none]
+
+++ @@ -1121,7 +1340,7 @@ A shortcut to return any Returns :

-
@@ -1129,14 +1348,17 @@ A shortcut to return any -

nm_connection_get_setting_wireless_security ()

-
NMSettingWirelessSecurity * nm_connection_get_setting_wireless_security
+

nm_connection_get_setting_infiniband ()

+
NMSettingInfiniband * nm_connection_get_setting_infiniband
                                                         (NMConnection *connection);

-A shortcut to return any NMSettingWirelessSecurity the connection might contain. +A shortcut to return any NMSettingInfiniband the connection might contain.

-

connection :

an NMSettingWireless if the connection contains one, otherwise NULL. [transfer none] +an NMSettingGsm if the connection contains one, otherwise NULL. [transfer none]
+
+++ @@ -1145,7 +1367,7 @@ A shortcut to return any - @@ -1153,13 +1375,17 @@ A shortcut to return any
-

nm_connection_get_uuid ()

-
const char *        nm_connection_get_uuid              (NMConnection *connection);
+

nm_connection_get_setting_ip4_config ()

+
NMSettingIP4Config * nm_connection_get_setting_ip4_config
+                                                        (NMConnection *connection);

-A shortcut to return the UUID from the connection's NMSettingConnection. +A shortcut to return any NMSettingIP4Config the connection might contain.

-

connection :

Returns :

an NMSettingWirelessSecurity if the connection contains one, otherwise NULL. [transfer none] +an NMSettingInfiniband if the connection contains one, otherwise NULL. [transfer none]
+
+++ @@ -1168,49 +1394,51 @@ A shortcut to return the UUID from the connection's Returns :

-
+

connection :

the UUID from the connection's 'connection' settingan NMSettingIP4Config if the connection contains one, otherwise NULL. [transfer none] +

-

nm_connection_get_virtual_iface_name ()

-
const char *        nm_connection_get_virtual_iface_name
+

nm_connection_get_setting_ip6_config ()

+
NMSettingIP6Config * nm_connection_get_setting_ip6_config
                                                         (NMConnection *connection);

-Returns the name of the virtual kernel interface which the connection -needs to use if specified in the settings. This function abstracts all -connection types which require this functionality. For all other -connection types, this function will return NULL. +A shortcut to return any NMSettingIP6Config the connection might contain.

-
+
+++ - - +

connection :

The NMConnection +the NMConnection

Returns :

Name of the kernel interface or NULLan NMSettingIP6Config if the connection contains one, otherwise NULL. [transfer none] +

-

nm_connection_is_type ()

-
gboolean            nm_connection_is_type               (NMConnection *connection,
-                                                         const char *type);
+

nm_connection_get_setting_olpc_mesh ()

+
NMSettingOlpcMesh * nm_connection_get_setting_olpc_mesh (NMConnection *connection);

-A convenience function to check if the given connection is a particular -type (ie wired, wifi, ppp, etc). Checks the "type" -property of the connection and matches that against type. +A shortcut to return any NMSettingOlpcMesh the connection might contain.

-
+
+++ @@ -1218,76 +1446,77 @@ property of the connection and matches that against - - - - - +

connection :

type :

a setting name to check the connection's type against (like -NM_SETTING_WIRELESS_SETTING_NAME or NM_SETTING_WIRED_SETTING_NAME)

Returns :

-TRUE if the connection is of the given type, FALSE if notan NMSettingOlpcMesh if the connection contains one, otherwise NULL. [transfer none] +

-

nm_connection_lookup_setting_type ()

-
GType               nm_connection_lookup_setting_type   (const char *name);
+

nm_connection_get_setting_ppp ()

+
NMSettingPPP *      nm_connection_get_setting_ppp       (NMConnection *connection);

-Returns the GType of the setting's class for a given setting name. +A shortcut to return any NMSettingPPP the connection might contain.

-
+
+++ - - + + - +

name :

a setting name

connection :

the NMConnection +

Returns :

the GType of the setting's classan NMSettingPPP if the connection contains one, otherwise NULL. [transfer none] +

-

nm_connection_lookup_setting_type_by_quark ()

-
GType               nm_connection_lookup_setting_type_by_quark
-                                                        (GQuark error_quark);
+

nm_connection_get_setting_pppoe ()

+
NMSettingPPPOE *    nm_connection_get_setting_pppoe     (NMConnection *connection);

-Returns the GType of the setting's class for a given setting error quark. -Useful for figuring out which setting a returned error is for. +A shortcut to return any NMSettingPPPOE the connection might contain.

-
+
+++ - - + + - +

error_quark :

a setting error quark

connection :

the NMConnection +

Returns :

the GType of the setting's classan NMSettingPPPOE if the connection contains one, otherwise NULL. [transfer none] +

-

nm_connection_need_secrets ()

-
const char *        nm_connection_need_secrets          (NMConnection *connection,
-                                                         GPtrArray **hints);
+

nm_connection_get_setting_serial ()

+
NMSettingSerial *   nm_connection_get_setting_serial    (NMConnection *connection);

-Returns the name of the first setting object in the connection which would -need secrets to make a successful connection. The returned hints are only -intended as a guide to what secrets may be required, because in some -circumstances, there is no way to conclusively determine exactly which -secrets are needed. +A shortcut to return any NMSettingSerial the connection might contain.

-
+
+++ @@ -1295,137 +1524,103 @@ secrets are needed. - - - - - +

connection :

hints :

the address of a pointer to a GPtrArray, initialized to NULL, which on -return points to an allocated GPtrArray containing the property names of -secrets of the NMSetting which may be required; the caller owns the array -and must free the each array element with g_free(), as well as the array -itself with g_ptr_array_free(). [out callee-allocates][element-type utf8][allow-none][transfer full] -

Returns :

the setting name of the NMSetting object which has invalid or -missing secretsan NMSettingSerial if the connection contains one, otherwise NULL. [transfer none] +

-

nm_connection_new ()

-
NMConnection *      nm_connection_new                   (void);
-

-Creates a new NMConnection object with no NMSetting objects. -

-
-- - - - -

Returns :

the new empty NMConnection object
-
-
-
-

nm_connection_new_from_hash ()

-
NMConnection *      nm_connection_new_from_hash         (GHashTable *hash,
-                                                         GError **error);
+

nm_connection_get_setting_vpn ()

+
NMSettingVPN *      nm_connection_get_setting_vpn       (NMConnection *connection);

-Creates a new NMConnection from a hash table describing the connection. See -nm_connection_to_hash() for a description of the expected hash table. +A shortcut to return any NMSettingVPN the connection might contain.

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

hash :

the GHashTable describing -the connection. [element-type utf8 GLib.HashTable] +

connection :

the NMConnection

error :

on unsuccessful return, an error

Returns :

the new NMConnection object, populated with settings created -from the values in the hash table, or NULL if the connection failed to -validatean NMSettingVPN if the connection contains one, otherwise NULL. [transfer none] +

-

nm_connection_remove_setting ()

-
void                nm_connection_remove_setting        (NMConnection *connection,
-                                                         GType setting_type);
+

nm_connection_get_setting_wimax ()

+
NMSettingWimax *    nm_connection_get_setting_wimax     (NMConnection *connection);

-Removes the NMSetting with the given GType from the NMConnection. This -operation dereferences the NMSetting object. +A shortcut to return any NMSettingWimax the connection might contain.

-
+
+++ - - - + +

connection :

a NMConnection +the NMConnection

setting_type :

the GType of the setting object to remove

Returns :

an NMSettingWimax if the connection contains one, otherwise NULL. [transfer none] +

-

nm_connection_replace_settings ()

-
gboolean            nm_connection_replace_settings      (NMConnection *connection,
-                                                         GHashTable *new_settings,
-                                                         GError **error);
-
+

nm_connection_get_setting_adsl ()

+
NMSettingAdsl *     nm_connection_get_setting_adsl      (NMConnection *connection);
+

+A shortcut to return any NMSettingAdsl the connection might contain. +

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

connection :

a NMConnection -

new_settings :

a GHashTable of settings. [element-type utf8 GLib.HashTable] -

error :

location to store error, or NULL +the NMConnection

Returns :

-TRUE if the settings were valid and added to the connection, FALSE -if they were notan NMSettingAdsl if the connection contains one, otherwise NULL. [transfer none] +

-

nm_connection_set_path ()

-
void                nm_connection_set_path              (NMConnection *connection,
-                                                         const char *path);
+

nm_connection_get_setting_wired ()

+
NMSettingWired *    nm_connection_get_setting_wired     (NMConnection *connection);

-Sets the D-Bus path of the connection. This property is not serialized, and -is only for the reference of the caller. Sets the "path" -property. +A shortcut to return any NMSettingWired the connection might contain.

-
+
+++ @@ -1433,28 +1628,25 @@ property. - - + +

connection :

path :

the D-Bus path of the connection as given by the settings service -which provides the connection

Returns :

an NMSettingWired if the connection contains one, otherwise NULL. [transfer none] +

-

nm_connection_to_hash ()

-
GHashTable *        nm_connection_to_hash               (NMConnection *connection,
-                                                         NMSettingHashFlags flags);
+

nm_connection_get_setting_wireless ()

+
NMSettingWireless * nm_connection_get_setting_wireless  (NMConnection *connection);

-Converts the NMConnection into a GHashTable describing the connection, -suitable for marshalling over D-Bus or serializing. The hash table mapping -is string:GHashTable with each element in the returned hash representing -a NMSetting object. The keys are setting object names, and the values -are GHashTables mapping string:GValue, each of which represents the -properties of the NMSetting object. +A shortcut to return any NMSettingWireless the connection might contain.

-
+
+++ @@ -1462,16 +1654,8 @@ properties of the - - - - - @@ -1479,21 +1663,17 @@ with -

nm_connection_update_secrets ()

-
gboolean            nm_connection_update_secrets        (NMConnection *connection,
-                                                         const char *setting_name,
-                                                         GHashTable *secrets,
-                                                         GError **error);
+

nm_connection_get_setting_wireless_security ()

+
NMSettingWirelessSecurity * nm_connection_get_setting_wireless_security
+                                                        (NMConnection *connection);

-Update the specified setting's secrets, given a hash table of secrets -intended for that setting (deserialized from D-Bus for example). Will also -extract the given setting's secrets hash if given a hash of hashes, as would -be returned from nm_connection_to_hash(). If setting_name is NULL, expects -a fully serialized NMConnection as returned by nm_connection_to_hash() and -will update all secrets from all settings contained in secrets. +A shortcut to return any NMSettingWirelessSecurity the connection might contain.

-

connection :

flags :

hash flags, e.g. NM_SETTING_HASH_FLAG_ALL -

Returns :

a new -GHashTable describing the connection, its settings, and each setting's -properties. The caller owns the hash table and must unref the hash table -with g_hash_table_unref() when it is no longer needed. [transfer full][element-type utf8 GLib.HashTable] +an NMSettingWireless if the connection contains one, otherwise NULL. [transfer none]
+
+++ @@ -1501,61 +1681,35 @@ will update all secrets from all settings contained in - - - - - - - - - - - - - +

connection :

setting_name :

the setting object name to which the secrets apply

secrets :

a GHashTable mapping -string:GValue of setting property names and secrets of the given setting_name. [element-type utf8 GObject.Value] -

error :

location to store error, or NULL -

Returns :

-TRUE if the secrets were successfully updated, FALSE if the update -failed (tried to update secrets for a setting that doesn't exist, etc)an NMSettingWirelessSecurity if the connection contains one, otherwise NULL. [transfer none] +

-

nm_connection_verify ()

-
gboolean            nm_connection_verify                (NMConnection *connection,
-                                                         GError **error);
+

nm_connection_get_setting_vlan ()

+
NMSettingVlan *     nm_connection_get_setting_vlan      (NMConnection *connection);

-Validates the connection and all its settings. Each setting's properties -have allowed values, and some values are dependent on other values. For -example, if a WiFi connection is security enabled, the NMSettingWireless -setting object's 'security' property must contain the setting name of the -NMSettingWirelessSecurity object, which must also be present in the -connection for the connection to be valid. As another example, the -NMSettingWired object's 'mac-address' property must be a validly formatted -MAC address. The returned GError contains information about which -setting and which property failed validation, and how it failed validation. +A shortcut to return any NMSettingVlan the connection might contain.

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

connection :

the NMConnection to verify

error :

location to store error, or NULL +the NMConnection

Returns :

-TRUE if the connection is valid, FALSE if it is notan NMSettingVlan if the connection contains one, otherwise NULL. [transfer none] +
@@ -1583,8 +1737,11 @@ of the D-Bus path of the connection as provided by a settings service. The ::secrets-cleared signal is emitted when the secrets of a connection are cleared.

-
+
+++ @@ -1607,8 +1764,11 @@ are cleared. The ::secrets-updated signal is emitted when the secrets of a setting have been changed.

-

connection :

+
+++ @@ -1630,6 +1790,6 @@ updated + Generated by GTK-Doc V1.19 \ No newline at end of file diff --git a/docs/libnm-util/html/NMSetting.html b/docs/libnm-util/html/NMSetting.html index 12b826b1..a44ef38f 100644 --- a/docs/libnm-util/html/NMSetting.html +++ b/docs/libnm-util/html/NMSetting.html @@ -3,12 +3,12 @@ NMSetting - + - + @@ -41,74 +41,86 @@

connection :

Synopsis

-
+
 #include <nm-setting.h>
 
+enum                NMSettingError;
+#define             NM_SETTING_ERROR
+GQuark              nm_setting_error_quark              (void);
+#define             NM_SETTING_PARAM_SERIALIZE
+#define             NM_SETTING_PARAM_REQUIRED
+#define             NM_SETTING_PARAM_SECRET
+#define             NM_SETTING_PARAM_FUZZY_IGNORE
+#define             NM_SETTING_NAME
+enum                NMSettingSecretFlags;
+enum                NMSettingCompareFlags;
                     NMSetting;
-                    NMSettingClass;
 gboolean            (*NMSettingClearSecretsWithFlagsFn) (NMSetting *setting,
                                                          const char *secret,
                                                          NMSettingSecretFlags flags,
                                                          gpointer user_data);
-enum                NMSettingCompareFlags;
-enum                NMSettingDiffResult;
-enum                NMSettingError;
-enum                NMSettingHashFlags;
-enum                NMSettingSecretFlags;
+                    NMSettingClass;
 void                (*NMSettingValueIterFn)             (NMSetting *setting,
                                                          const char *key,
                                                          const GValue *value,
                                                          GParamFlags flags,
                                                          gpointer user_data);
-#define             NM_SETTING_ERROR
-#define             NM_SETTING_NAME
-#define             NM_SETTING_PARAM_FUZZY_IGNORE
-#define             NM_SETTING_PARAM_REQUIRED
-#define             NM_SETTING_PARAM_SECRET
-#define             NM_SETTING_PARAM_SERIALIZE
-void                nm_setting_clear_secrets            (NMSetting *setting);
-void                nm_setting_clear_secrets_with_flags (NMSetting *setting,
-                                                         NMSettingClearSecretsWithFlagsFn func,
-                                                         gpointer user_data);
+enum                NMSettingHashFlags;
+GHashTable *        nm_setting_to_hash                  (NMSetting *setting,
+                                                         NMSettingHashFlags flags);
+NMSetting *         nm_setting_new_from_hash            (GType setting_type,
+                                                         GHashTable *hash);
+NMSetting *         nm_setting_duplicate                (NMSetting *setting);
+const char *        nm_setting_get_name                 (NMSetting *setting);
+gboolean            nm_setting_verify                   (NMSetting *setting,
+                                                         GSList *all_settings,
+                                                         GError **error);
 gboolean            nm_setting_compare                  (NMSetting *a,
                                                          NMSetting *b,
                                                          NMSettingCompareFlags flags);
+enum                NMSettingDiffResult;
 gboolean            nm_setting_diff                     (NMSetting *a,
                                                          NMSetting *b,
                                                          NMSettingCompareFlags flags,
                                                          gboolean invert_results,
                                                          GHashTable **results);
-NMSetting *         nm_setting_duplicate                (NMSetting *setting);
 void                nm_setting_enumerate_values         (NMSetting *setting,
                                                          NMSettingValueIterFn func,
                                                          gpointer user_data);
-GQuark              nm_setting_error_quark              (void);
-const char *        nm_setting_get_name                 (NMSetting *setting);
+char *              nm_setting_to_string                (NMSetting *setting);
+void                nm_setting_clear_secrets            (NMSetting *setting);
+void                nm_setting_clear_secrets_with_flags (NMSetting *setting,
+                                                         NMSettingClearSecretsWithFlagsFn func,
+                                                         gpointer user_data);
+GPtrArray *         nm_setting_need_secrets             (NMSetting *setting);
+gboolean            nm_setting_update_secrets           (NMSetting *setting,
+                                                         GHashTable *secrets,
+                                                         GError **error);
 gboolean            nm_setting_get_secret_flags         (NMSetting *setting,
                                                          const char *secret_name,
                                                          NMSettingSecretFlags *out_flags,
                                                          GError **error);
-const char *        nm_setting_get_virtual_iface_name   (NMSetting *setting);
-GPtrArray *         nm_setting_need_secrets             (NMSetting *setting);
-NMSetting *         nm_setting_new_from_hash            (GType setting_type,
-                                                         GHashTable *hash);
 gboolean            nm_setting_set_secret_flags         (NMSetting *setting,
                                                          const char *secret_name,
                                                          NMSettingSecretFlags flags,
                                                          GError **error);
-GHashTable *        nm_setting_to_hash                  (NMSetting *setting,
-                                                         NMSettingHashFlags flags);
-char *              nm_setting_to_string                (NMSetting *setting);
-gboolean            nm_setting_update_secrets           (NMSetting *setting,
-                                                         GHashTable *secrets,
-                                                         GError **error);
-gboolean            nm_setting_verify                   (NMSetting *setting,
-                                                         GSList *all_settings,
-                                                         GError **error);
+const char *        nm_setting_get_virtual_iface_name   (NMSetting *setting);
 

Object Hierarchy

+
+  GEnum
+   +----NMSettingError
+
+
+  GEnum
+   +----NMSettingSecretFlags
+
+
+  GEnum
+   +----NMSettingCompareFlags
+
   GObject
    +----NMSetting
@@ -135,25 +147,13 @@ const char *        NMSettingWirelessSecurity
          +----NMSettingVPN
 
-
-  GEnum
-   +----NMSettingCompareFlags
-
-
-  GEnum
-   +----NMSettingDiffResult
-
-
-  GEnum
-   +----NMSettingError
-
   GEnum
    +----NMSettingHashFlags
 
   GEnum
-   +----NMSettingSecretFlags
+   +----NMSettingDiffResult
 
@@ -176,95 +176,165 @@ of properties and allowed values.

Details

-

NMSetting

-
typedef struct _NMSetting NMSetting;
+

enum NMSettingError

+
typedef enum {
+	NM_SETTING_ERROR_UNKNOWN = 0,           /*< nick=UnknownError >*/
+	NM_SETTING_ERROR_PROPERTY_NOT_FOUND,    /*< nick=PropertyNotFound >*/
+	NM_SETTING_ERROR_PROPERTY_NOT_SECRET,   /*< nick=PropertyNotSecret >*/
+	NM_SETTING_ERROR_PROPERTY_TYPE_MISMATCH /*< nick=PropertyTypeMismatch >*/
+} NMSettingError;
+

-The NMSetting struct contains only private data. -It should only be accessed through the functions described below. +Describes errors that may result from operations involving a NMSetting.

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

NM_SETTING_ERROR_UNKNOWN

unknown or unclassified error +

NM_SETTING_ERROR_PROPERTY_NOT_FOUND

a property required by the operation + was not found; for example, an attempt to update an invalid secret +

NM_SETTING_ERROR_PROPERTY_NOT_SECRET

an operation which requires a secret + was attempted on a non-secret property +

NM_SETTING_ERROR_PROPERTY_TYPE_MISMATCH

the operation requires a property + of a specific type, or the value couldn't be transformed to the same type + as the property being acted upon +

-

NMSettingClass

-
typedef struct {
-	GObjectClass parent;
-
-	/* Virtual functions */
-	gboolean    (*verify)            (NMSetting  *setting,
-	                                  GSList     *all_settings,
-	                                  GError     **error);
-
-	GPtrArray  *(*need_secrets)      (NMSetting  *setting);
-
-	gboolean    (*update_one_secret) (NMSetting  *setting,
-	                                  const char *key,
-	                                  GValue     *value,
-	                                  GError    **error);
-
-	gboolean    (*get_secret_flags)  (NMSetting  *setting,
-	                                  const char *secret_name,
-	                                  gboolean verify_secret,
-	                                  NMSettingSecretFlags *out_flags,
-	                                  GError **error);
-
-	gboolean    (*set_secret_flags)  (NMSetting  *setting,
-	                                  const char *secret_name,
-	                                  gboolean verify_secret,
-	                                  NMSettingSecretFlags flags,
-	                                  GError **error);
-
-	/* Returns TRUE if the given property contains the same value in both settings */
-	gboolean    (*compare_property)  (NMSetting *setting,
-	                                  NMSetting *other,
-	                                  const GParamSpec *prop_spec,
-	                                  NMSettingCompareFlags flags);
-
-	void        (*clear_secrets_with_flags) (NMSetting *setting,
-	                                         GParamSpec *pspec,
-	                                         NMSettingClearSecretsWithFlagsFn func,
-	                                         gpointer user_data);
-
-	const char *(*get_virtual_iface_name) (NMSetting *setting);
-
-	/* Padding for future expansion */
-	void (*_reserved1) (void);
-} NMSettingClass;
+

NM_SETTING_ERROR

+
#define NM_SETTING_ERROR nm_setting_error_quark ()
 


-

NMSettingClearSecretsWithFlagsFn ()

-
gboolean            (*NMSettingClearSecretsWithFlagsFn) (NMSetting *setting,
-                                                         const char *secret,
-                                                         NMSettingSecretFlags flags,
-                                                         gpointer user_data);
-
+

nm_setting_error_quark ()

+
GQuark              nm_setting_error_quark              (void);
+

+Registers an error quark for NMSetting if necessary. +

+
++++ + + + + +

Returns :

the error quark used for NMSetting errors.
+
+
+
+

NM_SETTING_PARAM_SERIALIZE

+
#define NM_SETTING_PARAM_SERIALIZE    (1 << (0 + G_PARAM_USER_SHIFT))
+
+

+

+
+
+
+

NM_SETTING_PARAM_REQUIRED

+
#define NM_SETTING_PARAM_REQUIRED     (1 << (1 + G_PARAM_USER_SHIFT))
+
+

+

+
+
+
+

NM_SETTING_PARAM_SECRET

+
#define NM_SETTING_PARAM_SECRET       (1 << (2 + G_PARAM_USER_SHIFT))
+
+

+

+
+
+
+

NM_SETTING_PARAM_FUZZY_IGNORE

+
#define NM_SETTING_PARAM_FUZZY_IGNORE (1 << (3 + G_PARAM_USER_SHIFT))
+
+

+

+
+
+
+

NM_SETTING_NAME

+
#define NM_SETTING_NAME "name"
+
+

+

+
+
+
+

enum NMSettingSecretFlags

+
typedef enum {
+	NM_SETTING_SECRET_FLAG_NONE         = 0x00000000,
+	NM_SETTING_SECRET_FLAG_AGENT_OWNED  = 0x00000001,
+	NM_SETTING_SECRET_FLAG_NOT_SAVED    = 0x00000002,
+	NM_SETTING_SECRET_FLAG_NOT_REQUIRED = 0x00000004
+
+	/* NOTE: if adding flags, update nm-setting-private.h as well */
+} NMSettingSecretFlags;
+
+

+These flags indicate specific behavior related to handling of a secret. Each +secret has a corresponding set of these flags which indicate how the secret +is to be stored and/or requested when it is needed. +

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

setting :

The setting for which secrets are being iterated

secret :

The secret's name

NM_SETTING_SECRET_FLAG_NONE

the system is responsible for providing and +storing this secret (default) +

flags :

The secret's flags, eg NM_SETTING_SECRET_FLAG_AGENT_OWNED +

NM_SETTING_SECRET_FLAG_AGENT_OWNED

a user secret agent is responsible +for providing and storing this secret; when it is required agents will be +asked to retrieve it

user_data :

User data passed to nm_connection_clear_secrets_with_flags() +

NM_SETTING_SECRET_FLAG_NOT_SAVED

this secret should not be saved, but +should be requested from the user each time it is needed

Returns :

-TRUE to clear the secret, FALSE to not clear the secret

NM_SETTING_SECRET_FLAG_NOT_REQUIRED

in situations where it cannot be +automatically determined that the secret is required (some VPNs and PPP +providers dont require all secrets) this flag indicates that the specific +secret is not required +
@@ -285,8 +355,11 @@ It should only be accessed through the functions described below. These flags modify the comparison behavior when comparing two settings or two connections.

-
+
+++ @@ -329,75 +402,138 @@ storage (ie, the secret's flag includes NM_SETTING_S
-

enum NMSettingDiffResult

-
typedef enum {
-	NM_SETTING_DIFF_RESULT_UNKNOWN = 0x00000000,
-	NM_SETTING_DIFF_RESULT_IN_A =    0x00000001,
-	NM_SETTING_DIFF_RESULT_IN_B =    0x00000002,
-} NMSettingDiffResult;
-
+

NMSetting

+
typedef struct _NMSetting NMSetting;

-These values indicate the result of a setting difference operation. +The NMSetting struct contains only private data. +It should only be accessed through the functions described below.

-

NM_SETTING_COMPARE_FLAG_EXACT

+ +
+
+

NMSettingClearSecretsWithFlagsFn ()

+
gboolean            (*NMSettingClearSecretsWithFlagsFn) (NMSetting *setting,
+                                                         const char *secret,
+                                                         NMSettingSecretFlags flags,
+                                                         gpointer user_data);
+
+++ - - + + - - + + + + + - - + + + + +

NM_SETTING_DIFF_RESULT_UNKNOWN

unknown result -

setting :

The setting for which secrets are being iterated

NM_SETTING_DIFF_RESULT_IN_A

the property is present in setting A +

secret :

The secret's name

flags :

The secret's flags, eg NM_SETTING_SECRET_FLAG_AGENT_OWNED

NM_SETTING_DIFF_RESULT_IN_B

the property is present in setting B +

user_data :

User data passed to nm_connection_clear_secrets_with_flags()

Returns :

+TRUE to clear the secret, FALSE to not clear the secret

-

enum NMSettingError

-
typedef enum {
-	NM_SETTING_ERROR_UNKNOWN = 0,           /*< nick=UnknownError >*/
-	NM_SETTING_ERROR_PROPERTY_NOT_FOUND,    /*< nick=PropertyNotFound >*/
-	NM_SETTING_ERROR_PROPERTY_NOT_SECRET,   /*< nick=PropertyNotSecret >*/
-	NM_SETTING_ERROR_PROPERTY_TYPE_MISMATCH /*< nick=PropertyTypeMismatch >*/
-} NMSettingError;
+

NMSettingClass

+
typedef struct {
+	GObjectClass parent;
+
+	/* Virtual functions */
+	gboolean    (*verify)            (NMSetting  *setting,
+	                                  GSList     *all_settings,
+	                                  GError     **error);
+
+	GPtrArray  *(*need_secrets)      (NMSetting  *setting);
+
+	gboolean    (*update_one_secret) (NMSetting  *setting,
+	                                  const char *key,
+	                                  GValue     *value,
+	                                  GError    **error);
+
+	gboolean    (*get_secret_flags)  (NMSetting  *setting,
+	                                  const char *secret_name,
+	                                  gboolean verify_secret,
+	                                  NMSettingSecretFlags *out_flags,
+	                                  GError **error);
+
+	gboolean    (*set_secret_flags)  (NMSetting  *setting,
+	                                  const char *secret_name,
+	                                  gboolean verify_secret,
+	                                  NMSettingSecretFlags flags,
+	                                  GError **error);
+
+	/* Returns TRUE if the given property contains the same value in both settings */
+	gboolean    (*compare_property)  (NMSetting *setting,
+	                                  NMSetting *other,
+	                                  const GParamSpec *prop_spec,
+	                                  NMSettingCompareFlags flags);
+
+	void        (*clear_secrets_with_flags) (NMSetting *setting,
+	                                         GParamSpec *pspec,
+	                                         NMSettingClearSecretsWithFlagsFn func,
+	                                         gpointer user_data);
+
+	const char *(*get_virtual_iface_name) (NMSetting *setting);
+
+	/* Padding for future expansion */
+	void (*_reserved1) (void);
+} NMSettingClass;
 

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

-
+ +
+
+

NMSettingValueIterFn ()

+
void                (*NMSettingValueIterFn)             (NMSetting *setting,
+                                                         const char *key,
+                                                         const GValue *value,
+                                                         GParamFlags flags,
+                                                         gpointer user_data);
+
+++ - - + - - + + - - + + + + + - - + @@ -416,8 +552,11 @@ Describes errors that may result from operations involving a nm_setting_to_hash().

-

NM_SETTING_ERROR_UNKNOWN

unknown or unclassified error +

setting :

The setting for which properties are being iterated, given to +nm_setting_enumerate_values()

NM_SETTING_ERROR_PROPERTY_NOT_FOUND

a property required by the operation - was not found; for example, an attempt to update an invalid secret -

key :

The value/property name

NM_SETTING_ERROR_PROPERTY_NOT_SECRET

an operation which requires a secret - was attempted on a non-secret property +

value :

The property's value

flags :

The property's flags, like NM_SETTING_PARAM_SECRET

NM_SETTING_ERROR_PROPERTY_TYPE_MISMATCH

the operation requires a property - of a specific type, or the value couldn't be transformed to the same type - as the property being acted upon +

user_data :

User data passed to nm_setting_enumerate_values()
+
+++ @@ -439,49 +578,34 @@ when calling -

enum NMSettingSecretFlags

-
typedef enum {
-	NM_SETTING_SECRET_FLAG_NONE         = 0x00000000,
-	NM_SETTING_SECRET_FLAG_AGENT_OWNED  = 0x00000001,
-	NM_SETTING_SECRET_FLAG_NOT_SAVED    = 0x00000002,
-	NM_SETTING_SECRET_FLAG_NOT_REQUIRED = 0x00000004
-
-	/* NOTE: if adding flags, update nm-setting-private.h as well */
-} NMSettingSecretFlags;
-
+

nm_setting_to_hash ()

+
GHashTable *        nm_setting_to_hash                  (NMSetting *setting,
+                                                         NMSettingHashFlags flags);

-These flags indicate specific behavior related to handling of a secret. Each -secret has a corresponding set of these flags which indicate how the secret -is to be stored and/or requested when it is needed. +Converts the NMSetting into a GHashTable mapping each setting property +name to a GValue describing that property, suitable for marshalling over +D-Bus or serializing. The mapping is string to GValue.

-

NM_SETTING_HASH_FLAG_ALL

+
+++ - - - - - - + - - + - - + @@ -489,136 +613,131 @@ secret is not required
-

NMSettingValueIterFn ()

-
void                (*NMSettingValueIterFn)             (NMSetting *setting,
-                                                         const char *key,
-                                                         const GValue *value,
-                                                         GParamFlags flags,
-                                                         gpointer user_data);
-

NM_SETTING_SECRET_FLAG_NONE

the system is responsible for providing and -storing this secret (default) -

NM_SETTING_SECRET_FLAG_AGENT_OWNED

a user secret agent is responsible -for providing and storing this secret; when it is required agents will be -asked to retrieve it +

setting :

the NMSetting

NM_SETTING_SECRET_FLAG_NOT_SAVED

this secret should not be saved, but -should be requested from the user each time it is needed +

flags :

hash flags, e.g. NM_SETTING_HASH_FLAG_ALL

NM_SETTING_SECRET_FLAG_NOT_REQUIRED

in situations where it cannot be -automatically determined that the secret is required (some VPNs and PPP -providers dont require all secrets) this flag indicates that the specific -secret is not required +

Returns :

a new GHashTable +describing the setting's properties. [transfer full][element-type utf8 GObject.Value]
+

nm_setting_new_from_hash ()

+
NMSetting *         nm_setting_new_from_hash            (GType setting_type,
+                                                         GHashTable *hash);
+

+Creates a new NMSetting object and populates that object with the properties +contained in the hash table, using each hash key as the property to set, +and each hash value as the value to set that property to. Setting properties +are strongly typed, thus the GValue type of the hash value must be correct. +See the documentation on each NMSetting object subclass for the correct +property names and value types. +

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

setting :

The setting for which properties are being iterated, given to -nm_setting_enumerate_values() -

key :

The value/property name

value :

The property's value

setting_type :

the NMSetting type which the hash contains properties for

flags :

The property's flags, like NM_SETTING_PARAM_SECRET +

hash :

the GHashTable containing a +string to GValue mapping of properties that apply to the setting. [element-type utf8 GObject.Value]

user_data :

User data passed to nm_setting_enumerate_values() -

Returns :

a new NMSetting object populated with the properties from the +hash table, or NULL on failure

-

NM_SETTING_ERROR

-
#define NM_SETTING_ERROR nm_setting_error_quark ()
-
-

-

-
-
-
-

NM_SETTING_NAME

-
#define NM_SETTING_NAME "name"
-
-

-

-
-
-
-

NM_SETTING_PARAM_FUZZY_IGNORE

-
#define NM_SETTING_PARAM_FUZZY_IGNORE (1 << (3 + G_PARAM_USER_SHIFT))
-
-

-

-
-
-
-

NM_SETTING_PARAM_REQUIRED

-
#define NM_SETTING_PARAM_REQUIRED     (1 << (1 + G_PARAM_USER_SHIFT))
-
-

-

-
-
-
-

NM_SETTING_PARAM_SECRET

-
#define NM_SETTING_PARAM_SECRET       (1 << (2 + G_PARAM_USER_SHIFT))
-
-

-

-
-
-
-

NM_SETTING_PARAM_SERIALIZE

-
#define NM_SETTING_PARAM_SERIALIZE    (1 << (0 + G_PARAM_USER_SHIFT))
-
+

nm_setting_duplicate ()

+
NMSetting *         nm_setting_duplicate                (NMSetting *setting);

+Duplicates a NMSetting.

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

setting :

the NMSetting to duplicate

Returns :

a new NMSetting containing the same properties and values as the +source NMSetting. [transfer full] +

-

nm_setting_clear_secrets ()

-
void                nm_setting_clear_secrets            (NMSetting *setting);
+

nm_setting_get_name ()

+
const char *        nm_setting_get_name                 (NMSetting *setting);

-Resets and clears any secrets in the setting. Secrets should be added to the -setting only when needed, and cleared immediately after use to prevent -leakage of information. +Returns the type name of the NMSetting object

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

setting :

the NMSetting

Returns :

a string containing the type name of the NMSetting object, +like 'ppp' or 'wireless' or 'wired'.

-

nm_setting_clear_secrets_with_flags ()

-
void                nm_setting_clear_secrets_with_flags (NMSetting *setting,
-                                                         NMSettingClearSecretsWithFlagsFn func,
-                                                         gpointer user_data);
+

nm_setting_verify ()

+
gboolean            nm_setting_verify                   (NMSetting *setting,
+                                                         GSList *all_settings,
+                                                         GError **error);

-Clears and frees secrets determined by func. +Validates the setting. Each setting's properties have allowed values, and +some are dependent on other values (hence the need for all_settings). The +returned GError contains information about which property of the setting +failed validation, and in what way that property failed validation.

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

setting :

the NMSetting -the NMSetting to verify

func :

function to be called to determine whether a -specific secret should be cleared or not. [scope call] +

all_settings :

a GSList of all settings +in the connection from which setting came. [element-type NMSetting]

user_data :

caller-supplied data passed to func +

error :

location to store error, or NULL

Returns :

+TRUE if the setting is valid, FALSE if it is not
@@ -633,8 +752,11 @@ Compares two NMSettingCompareFlags for a description of each flag's behavior.

-
+
+++ @@ -660,6 +782,42 @@ for a description of each flag's behavior.
+

enum NMSettingDiffResult

+
typedef enum {
+	NM_SETTING_DIFF_RESULT_UNKNOWN = 0x00000000,
+	NM_SETTING_DIFF_RESULT_IN_A =    0x00000001,
+	NM_SETTING_DIFF_RESULT_IN_B =    0x00000002,
+} NMSettingDiffResult;
+
+

+These values indicate the result of a setting difference operation. +

+

a :

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

NM_SETTING_DIFF_RESULT_UNKNOWN

unknown result +

NM_SETTING_DIFF_RESULT_IN_A

the property is present in setting A +

NM_SETTING_DIFF_RESULT_IN_B

the property is present in setting B +
+
+
+

nm_setting_diff ()

gboolean            nm_setting_diff                     (NMSetting *a,
                                                          NMSetting *b,
@@ -673,8 +831,11 @@ for a description of each flag's behavior.  If the settings differ, the keys
 of each setting that differ from the other are added to results, mapped to
 one or more NMSettingDiffResult values.
 

-
+
+++ @@ -714,29 +875,6 @@ in and the settings differ, a new one is created and returned. -

nm_setting_duplicate ()

-
NMSetting *         nm_setting_duplicate                (NMSetting *setting);
-

-Duplicates a NMSetting. -

-

a :

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

setting :

the NMSetting to duplicate

Returns :

a new NMSetting containing the same properties and values as the -source NMSetting. [transfer full] -
-
-
-

nm_setting_enumerate_values ()

void                nm_setting_enumerate_values         (NMSetting *setting,
                                                          NMSettingValueIterFn func,
@@ -745,8 +883,11 @@ source NMSetting object, calling the supplied
 user function for each property.
 

-
+
+++ @@ -767,28 +908,18 @@ user function for each property.
-

nm_setting_error_quark ()

-
GQuark              nm_setting_error_quark              (void);
-

-Registers an error quark for NMSetting if necessary. -

-

setting :

-- - - - -

Returns :

the error quark used for NMSetting errors.
-
-
-
-

nm_setting_get_name ()

-
const char *        nm_setting_get_name                 (NMSetting *setting);
+

nm_setting_to_string ()

+
char *              nm_setting_to_string                (NMSetting *setting);

-Returns the type name of the NMSetting object +Convert the setting into a string. For debugging purposes ONLY, should NOT +be used for serialization of the setting, or machine-parsed in any way. The +output format is not guaranteed to be stable and may change at any time.

-
+
+++ @@ -797,62 +928,49 @@ Returns the type name of the Returns :

-
+

setting :

a string containing the type name of the NMSetting object, -like 'ppp' or 'wireless' or 'wired'.an allocated string containing a textual representation of the +setting's properties and values (including secrets!), which the caller should +free with g_free() +

-

nm_setting_get_secret_flags ()

-
gboolean            nm_setting_get_secret_flags         (NMSetting *setting,
-                                                         const char *secret_name,
-                                                         NMSettingSecretFlags *out_flags,
-                                                         GError **error);
+

nm_setting_clear_secrets ()

+
void                nm_setting_clear_secrets            (NMSetting *setting);

-For a given secret, retrieves the NMSettingSecretFlags describing how to -handle that secret. +Resets and clears any secrets in the setting. Secrets should be added to the +setting only when needed, and cleared immediately after use to prevent +leakage of information.

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

setting :

the NMSetting

secret_name :

the secret key name to get flags for

out_flags :

on success, the NMSettingSecretFlags for the secret

error :

location to store error, or NULL -

Returns :

TRUE on success (if the given secret name was a valid property of -this setting, and if that property is secret), FALSE if not

-

nm_setting_get_virtual_iface_name ()

-
const char *        nm_setting_get_virtual_iface_name   (NMSetting *setting);
+

nm_setting_clear_secrets_with_flags ()

+
void                nm_setting_clear_secrets_with_flags (NMSetting *setting,
+                                                         NMSettingClearSecretsWithFlagsFn func,
+                                                         gpointer user_data);

-Returns the name of the virtual kernel interface which the connection -needs to use if specified in the settings. +Clears and frees secrets determined by func.

-
+
+++ @@ -860,9 +978,15 @@ needs to use if specified in the settings. - - + + + + + +

setting :

Returns :

Name of the virtual interface or NULL if the setting does not -support this feature

func :

function to be called to determine whether a +specific secret should be cleared or not. [scope call] +

user_data :

caller-supplied data passed to func +
@@ -877,8 +1001,11 @@ to make a successful connection. The returned hints are only intended as a guide to what secrets may be required, because in some circumstances, there is no way to conclusively determine exactly which secrets are needed.

-
+
+++ @@ -887,10 +1014,10 @@ is no way to conclusively determine exactly which secrets are needed. - @@ -898,51 +1025,61 @@ itself with -

nm_setting_new_from_hash ()

-
NMSetting *         nm_setting_new_from_hash            (GType setting_type,
-                                                         GHashTable *hash);
+

nm_setting_update_secrets ()

+
gboolean            nm_setting_update_secrets           (NMSetting *setting,
+                                                         GHashTable *secrets,
+                                                         GError **error);

-Creates a new NMSetting object and populates that object with the properties -contained in the hash table, using each hash key as the property to set, -and each hash value as the value to set that property to. Setting properties -are strongly typed, thus the GValue type of the hash value must be correct. -See the documentation on each NMSetting object subclass for the correct -property names and value types. +Update the setting's secrets, given a hash table of secrets intended for that +setting (deserialized from D-Bus for example).

-

setting :

Returns :

a GPtrArray containing the property names of secrets of the -NMSetting which may be required; the caller owns the array -and must free the each array element with g_free(), as well as the array -itself with g_ptr_array_free(). [transfer full][element-type utf8] +a GPtrArray containing +the property names of secrets of the NMSetting which may be required; the +caller owns the array and must free it with g_ptr_array_free(), but must not +free the elements. [transfer container][element-type utf8]
+
+++ - - + + - - + + + + + - +

setting_type :

the NMSetting type which the hash contains properties for

setting :

the NMSetting +

hash :

the GHashTable containing a -string to GValue mapping of properties that apply to the setting. [element-type utf8 GObject.Value] +

secrets :

a GHashTable mapping +string to GValue of setting property names and secrets. [element-type utf8 GObject.Value] +

error :

location to store error, or NULL

Returns :

a new NMSetting object populated with the properties from the -hash table, or NULL on failure +TRUE if the secrets were successfully updated, FALSE on failure to +update one or more of the secrets.

-

nm_setting_set_secret_flags ()

-
gboolean            nm_setting_set_secret_flags         (NMSetting *setting,
+

nm_setting_get_secret_flags ()

+
gboolean            nm_setting_get_secret_flags         (NMSetting *setting,
                                                          const char *secret_name,
-                                                         NMSettingSecretFlags flags,
+                                                         NMSettingSecretFlags *out_flags,
                                                          GError **error);

For a given secret, retrieves the NMSettingSecretFlags describing how to handle that secret.

-
+
+++ @@ -951,15 +1088,15 @@ handle that secret. - + - - + + - @@ -972,47 +1109,20 @@ this setting, and if that property is secret), FALSE if not
-

nm_setting_to_hash ()

-
GHashTable *        nm_setting_to_hash                  (NMSetting *setting,
-                                                         NMSettingHashFlags flags);
-

-Converts the NMSetting into a GHashTable mapping each setting property -name to a GValue describing that property, suitable for marshalling over -D-Bus or serializing. The mapping is string to GValue. -

-

setting :

secret_name :

the secret key name to set flags forthe secret key name to get flags for

flags :

the NMSettingSecretFlags for the secret

out_flags :

on success, the NMSettingSecretFlags for the secret

error :

location to store error, or NULL +location to store error, or NULL
-- - - - - - - - - - - - - - -

setting :

the NMSetting -

flags :

hash flags, e.g. NM_SETTING_HASH_FLAG_ALL -

Returns :

a new GHashTable -describing the setting's properties. [transfer full][element-type utf8 GObject.Value] -
-
-
-
-

nm_setting_to_string ()

-
char *              nm_setting_to_string                (NMSetting *setting);
+

nm_setting_set_secret_flags ()

+
gboolean            nm_setting_set_secret_flags         (NMSetting *setting,
+                                                         const char *secret_name,
+                                                         NMSettingSecretFlags flags,
+                                                         GError **error);

-Convert the setting into a string. For debugging purposes ONLY, should NOT -be used for serialization of the setting, or machine-parsed in any way. The -output format is not guaranteed to be stable and may change at any time. +For a given secret, retrieves the NMSettingSecretFlags describing how to +handle that secret.

-
+
+++ @@ -1020,87 +1130,49 @@ output format is not guaranteed to be stable and may change at any time. - - - - -

setting :

Returns :

an allocated string containing a textual representation of the -setting's properties and values (including secrets!), which the caller should -free with g_free() -
-
-
-
-

nm_setting_update_secrets ()

-
gboolean            nm_setting_update_secrets           (NMSetting *setting,
-                                                         GHashTable *secrets,
-                                                         GError **error);
-

-Update the setting's secrets, given a hash table of secrets intended for that -setting (deserialized from D-Bus for example). -

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

setting :

the NMSetting -

secret_name :

the secret key name to set flags for

secrets :

a GHashTable mapping -string to GValue of setting property names and secrets. [element-type utf8 GObject.Value] -

flags :

the NMSettingSecretFlags for the secret

error :

location to store error, or NULL +location to store error, or NULL

Returns :

-TRUE if the secrets were successfully updated and the connection -is valid, FALSE on failure or if the setting was never added to the connectionTRUE on success (if the given secret name was a valid property of +this setting, and if that property is secret), FALSE if not

-

nm_setting_verify ()

-
gboolean            nm_setting_verify                   (NMSetting *setting,
-                                                         GSList *all_settings,
-                                                         GError **error);
+

nm_setting_get_virtual_iface_name ()

+
const char *        nm_setting_get_virtual_iface_name   (NMSetting *setting);

-Validates the setting. Each setting's properties have allowed values, and -some are dependent on other values (hence the need for all_settings). The -returned GError contains information about which property of the setting -failed validation, and in what way that property failed validation. +Returns the name of the virtual kernel interface which the connection +needs to use if specified in the settings.

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

setting :

the NMSetting to verify

all_settings :

a GSList of all settings -in the connection from which setting came. [element-type NMSetting] -

error :

location to store error, or NULL +the NMSetting

Returns :

-TRUE if the setting is valid, FALSE if it is notName of the virtual interface or NULL if the setting does not +support this feature
@@ -1122,6 +1194,6 @@ example 'ppp' or 'wireless' or 'wired'.
+ Generated by GTK-Doc V1.19
\ No newline at end of file diff --git a/docs/libnm-util/html/NMSetting8021x.html b/docs/libnm-util/html/NMSetting8021x.html index a81f903d..0078c61b 100644 --- a/docs/libnm-util/html/NMSetting8021x.html +++ b/docs/libnm-util/html/NMSetting8021x.html @@ -3,12 +3,12 @@ NMSetting8021x - + - + @@ -44,179 +44,179 @@
 #include <nm-setting-8021x.h>
 
-                    NMSetting8021x;
 enum                NMSetting8021xCKFormat;
 enum                NMSetting8021xCKScheme;
-                    NMSetting8021xClass;
+#define             NM_SETTING_802_1X_SETTING_NAME
 enum                NMSetting8021xError;
-#define             NM_SETTING_802_1X_ALTSUBJECT_MATCHES
+#define             NM_SETTING_802_1X_ERROR
+GQuark              nm_setting_802_1x_error_quark       (void);
+#define             NM_SETTING_802_1X_EAP
+#define             NM_SETTING_802_1X_IDENTITY
 #define             NM_SETTING_802_1X_ANONYMOUS_IDENTITY
+#define             NM_SETTING_802_1X_PAC_FILE
 #define             NM_SETTING_802_1X_CA_CERT
 #define             NM_SETTING_802_1X_CA_PATH
+#define             NM_SETTING_802_1X_SUBJECT_MATCH
+#define             NM_SETTING_802_1X_ALTSUBJECT_MATCHES
 #define             NM_SETTING_802_1X_CLIENT_CERT
-#define             NM_SETTING_802_1X_EAP
-#define             NM_SETTING_802_1X_ERROR
-#define             NM_SETTING_802_1X_IDENTITY
-#define             NM_SETTING_802_1X_PAC_FILE
-#define             NM_SETTING_802_1X_PASSWORD
-#define             NM_SETTING_802_1X_PASSWORD_FLAGS
-#define             NM_SETTING_802_1X_PASSWORD_RAW
-#define             NM_SETTING_802_1X_PASSWORD_RAW_FLAGS
-#define             NM_SETTING_802_1X_PHASE1_FAST_PROVISIONING
-#define             NM_SETTING_802_1X_PHASE1_PEAPLABEL
 #define             NM_SETTING_802_1X_PHASE1_PEAPVER
-#define             NM_SETTING_802_1X_PHASE2_ALTSUBJECT_MATCHES
+#define             NM_SETTING_802_1X_PHASE1_PEAPLABEL
+#define             NM_SETTING_802_1X_PHASE1_FAST_PROVISIONING
 #define             NM_SETTING_802_1X_PHASE2_AUTH
 #define             NM_SETTING_802_1X_PHASE2_AUTHEAP
 #define             NM_SETTING_802_1X_PHASE2_CA_CERT
 #define             NM_SETTING_802_1X_PHASE2_CA_PATH
+#define             NM_SETTING_802_1X_PHASE2_SUBJECT_MATCH
+#define             NM_SETTING_802_1X_PHASE2_ALTSUBJECT_MATCHES
 #define             NM_SETTING_802_1X_PHASE2_CLIENT_CERT
+#define             NM_SETTING_802_1X_PASSWORD
+#define             NM_SETTING_802_1X_PASSWORD_FLAGS
+#define             NM_SETTING_802_1X_PASSWORD_RAW
+#define             NM_SETTING_802_1X_PASSWORD_RAW_FLAGS
+#define             NM_SETTING_802_1X_PRIVATE_KEY
+#define             NM_SETTING_802_1X_PRIVATE_KEY_PASSWORD
+#define             NM_SETTING_802_1X_PRIVATE_KEY_PASSWORD_FLAGS
 #define             NM_SETTING_802_1X_PHASE2_PRIVATE_KEY
 #define             NM_SETTING_802_1X_PHASE2_PRIVATE_KEY_PASSWORD
 #define             NM_SETTING_802_1X_PHASE2_PRIVATE_KEY_PASSWORD_FLAGS
-#define             NM_SETTING_802_1X_PHASE2_SUBJECT_MATCH
 #define             NM_SETTING_802_1X_PIN
 #define             NM_SETTING_802_1X_PIN_FLAGS
-#define             NM_SETTING_802_1X_PRIVATE_KEY
-#define             NM_SETTING_802_1X_PRIVATE_KEY_PASSWORD
-#define             NM_SETTING_802_1X_PRIVATE_KEY_PASSWORD_FLAGS
-#define             NM_SETTING_802_1X_SETTING_NAME
-#define             NM_SETTING_802_1X_SUBJECT_MATCH
 #define             NM_SETTING_802_1X_SYSTEM_CA_CERTS
-gboolean            nm_setting_802_1x_add_altsubject_match
-                                                        (NMSetting8021x *setting,
-                                                         const char *altsubject_match);
+                    NMSetting8021x;
+                    NMSetting8021xClass;
+NMSetting *         nm_setting_802_1x_new               (void);
+guint32             nm_setting_802_1x_get_num_eap_methods
+                                                        (NMSetting8021x *setting);
+const char *        nm_setting_802_1x_get_eap_method    (NMSetting8021x *setting,
+                                                         guint32 i);
 gboolean            nm_setting_802_1x_add_eap_method    (NMSetting8021x *setting,
                                                          const char *eap);
-gboolean            nm_setting_802_1x_add_phase2_altsubject_match
-                                                        (NMSetting8021x *setting,
-                                                         const char *phase2_altsubject_match);
-void                nm_setting_802_1x_clear_altsubject_matches
-                                                        (NMSetting8021x *setting);
-void                nm_setting_802_1x_clear_eap_methods (NMSetting8021x *setting);
-void                nm_setting_802_1x_clear_phase2_altsubject_matches
-                                                        (NMSetting8021x *setting);
-GQuark              nm_setting_802_1x_error_quark       (void);
-const char *        nm_setting_802_1x_get_altsubject_match
-                                                        (NMSetting8021x *setting,
+void                nm_setting_802_1x_remove_eap_method (NMSetting8021x *setting,
                                                          guint32 i);
+void                nm_setting_802_1x_clear_eap_methods (NMSetting8021x *setting);
+const char *        nm_setting_802_1x_get_identity      (NMSetting8021x *setting);
 const char *        nm_setting_802_1x_get_anonymous_identity
                                                         (NMSetting8021x *setting);
-const GByteArray *  nm_setting_802_1x_get_ca_cert_blob  (NMSetting8021x *setting);
-const char *        nm_setting_802_1x_get_ca_cert_path  (NMSetting8021x *setting);
-NMSetting8021xCKScheme nm_setting_802_1x_get_ca_cert_scheme
+const char *        nm_setting_802_1x_get_pac_file      (NMSetting8021x *setting);
+gboolean            nm_setting_802_1x_get_system_ca_certs
                                                         (NMSetting8021x *setting);
 const char *        nm_setting_802_1x_get_ca_path       (NMSetting8021x *setting);
-const GByteArray *  nm_setting_802_1x_get_client_cert_blob
-                                                        (NMSetting8021x *setting);
-const char *        nm_setting_802_1x_get_client_cert_path
+const char *        nm_setting_802_1x_get_phase2_ca_path
                                                         (NMSetting8021x *setting);
-NMSetting8021xCKScheme nm_setting_802_1x_get_client_cert_scheme
+NMSetting8021xCKScheme nm_setting_802_1x_get_ca_cert_scheme
                                                         (NMSetting8021x *setting);
-const char *        nm_setting_802_1x_get_eap_method    (NMSetting8021x *setting,
-                                                         guint32 i);
-const char *        nm_setting_802_1x_get_identity      (NMSetting8021x *setting);
+const GByteArray *  nm_setting_802_1x_get_ca_cert_blob  (NMSetting8021x *setting);
+const char *        nm_setting_802_1x_get_ca_cert_path  (NMSetting8021x *setting);
+gboolean            nm_setting_802_1x_set_ca_cert       (NMSetting8021x *setting,
+                                                         const char *cert_path,
+                                                         NMSetting8021xCKScheme scheme,
+                                                         NMSetting8021xCKFormat *out_format,
+                                                         GError **error);
+const char *        nm_setting_802_1x_get_subject_match (NMSetting8021x *setting);
 guint32             nm_setting_802_1x_get_num_altsubject_matches
                                                         (NMSetting8021x *setting);
-guint32             nm_setting_802_1x_get_num_eap_methods
+const char *        nm_setting_802_1x_get_altsubject_match
+                                                        (NMSetting8021x *setting,
+                                                         guint32 i);
+gboolean            nm_setting_802_1x_add_altsubject_match
+                                                        (NMSetting8021x *setting,
+                                                         const char *altsubject_match);
+void                nm_setting_802_1x_remove_altsubject_match
+                                                        (NMSetting8021x *setting,
+                                                         guint32 i);
+void                nm_setting_802_1x_clear_altsubject_matches
                                                         (NMSetting8021x *setting);
-guint32             nm_setting_802_1x_get_num_phase2_altsubject_matches
+NMSetting8021xCKScheme nm_setting_802_1x_get_client_cert_scheme
                                                         (NMSetting8021x *setting);
-const char *        nm_setting_802_1x_get_pac_file      (NMSetting8021x *setting);
-const char *        nm_setting_802_1x_get_password      (NMSetting8021x *setting);
-NMSettingSecretFlags nm_setting_802_1x_get_password_flags
+const GByteArray *  nm_setting_802_1x_get_client_cert_blob
                                                         (NMSetting8021x *setting);
-const GByteArray *  nm_setting_802_1x_get_password_raw  (NMSetting8021x *setting);
-NMSettingSecretFlags nm_setting_802_1x_get_password_raw_flags
+const char *        nm_setting_802_1x_get_client_cert_path
                                                         (NMSetting8021x *setting);
-const char *        nm_setting_802_1x_get_phase1_fast_provisioning
+gboolean            nm_setting_802_1x_set_client_cert   (NMSetting8021x *setting,
+                                                         const char *cert_path,
+                                                         NMSetting8021xCKScheme scheme,
+                                                         NMSetting8021xCKFormat *out_format,
+                                                         GError **error);
+const char *        nm_setting_802_1x_get_phase1_peapver
                                                         (NMSetting8021x *setting);
 const char *        nm_setting_802_1x_get_phase1_peaplabel
                                                         (NMSetting8021x *setting);
-const char *        nm_setting_802_1x_get_phase1_peapver
+const char *        nm_setting_802_1x_get_phase1_fast_provisioning
                                                         (NMSetting8021x *setting);
-const char *        nm_setting_802_1x_get_phase2_altsubject_match
-                                                        (NMSetting8021x *setting,
-                                                         guint32 i);
 const char *        nm_setting_802_1x_get_phase2_auth   (NMSetting8021x *setting);
 const char *        nm_setting_802_1x_get_phase2_autheap
                                                         (NMSetting8021x *setting);
+NMSetting8021xCKScheme nm_setting_802_1x_get_phase2_ca_cert_scheme
+                                                        (NMSetting8021x *setting);
 const GByteArray *  nm_setting_802_1x_get_phase2_ca_cert_blob
                                                         (NMSetting8021x *setting);
 const char *        nm_setting_802_1x_get_phase2_ca_cert_path
                                                         (NMSetting8021x *setting);
-NMSetting8021xCKScheme nm_setting_802_1x_get_phase2_ca_cert_scheme
-                                                        (NMSetting8021x *setting);
-const char *        nm_setting_802_1x_get_phase2_ca_path
+gboolean            nm_setting_802_1x_set_phase2_ca_cert
+                                                        (NMSetting8021x *setting,
+                                                         const char *cert_path,
+                                                         NMSetting8021xCKScheme scheme,
+                                                         NMSetting8021xCKFormat *out_format,
+                                                         GError **error);
+const char *        nm_setting_802_1x_get_phase2_subject_match
                                                         (NMSetting8021x *setting);
-const GByteArray *  nm_setting_802_1x_get_phase2_client_cert_blob
+guint32             nm_setting_802_1x_get_num_phase2_altsubject_matches
                                                         (NMSetting8021x *setting);
-const char *        nm_setting_802_1x_get_phase2_client_cert_path
+const char *        nm_setting_802_1x_get_phase2_altsubject_match
+                                                        (NMSetting8021x *setting,
+                                                         guint32 i);
+gboolean            nm_setting_802_1x_add_phase2_altsubject_match
+                                                        (NMSetting8021x *setting,
+                                                         const char *phase2_altsubject_match);
+void                nm_setting_802_1x_remove_phase2_altsubject_match
+                                                        (NMSetting8021x *setting,
+                                                         guint32 i);
+void                nm_setting_802_1x_clear_phase2_altsubject_matches
                                                         (NMSetting8021x *setting);
 NMSetting8021xCKScheme nm_setting_802_1x_get_phase2_client_cert_scheme
                                                         (NMSetting8021x *setting);
-const GByteArray *  nm_setting_802_1x_get_phase2_private_key_blob
-                                                        (NMSetting8021x *setting);
-NMSetting8021xCKFormat nm_setting_802_1x_get_phase2_private_key_format
-                                                        (NMSetting8021x *setting);
-const char *        nm_setting_802_1x_get_phase2_private_key_password
-                                                        (NMSetting8021x *setting);
-NMSettingSecretFlags nm_setting_802_1x_get_phase2_private_key_password_flags
+const GByteArray *  nm_setting_802_1x_get_phase2_client_cert_blob
                                                         (NMSetting8021x *setting);
-const char *        nm_setting_802_1x_get_phase2_private_key_path
+const char *        nm_setting_802_1x_get_phase2_client_cert_path
                                                         (NMSetting8021x *setting);
-NMSetting8021xCKScheme nm_setting_802_1x_get_phase2_private_key_scheme
+gboolean            nm_setting_802_1x_set_phase2_client_cert
+                                                        (NMSetting8021x *setting,
+                                                         const char *cert_path,
+                                                         NMSetting8021xCKScheme scheme,
+                                                         NMSetting8021xCKFormat *out_format,
+                                                         GError **error);
+const char *        nm_setting_802_1x_get_password      (NMSetting8021x *setting);
+NMSettingSecretFlags nm_setting_802_1x_get_password_flags
                                                         (NMSetting8021x *setting);
-const char *        nm_setting_802_1x_get_phase2_subject_match
+const GByteArray *  nm_setting_802_1x_get_password_raw  (NMSetting8021x *setting);
+NMSettingSecretFlags nm_setting_802_1x_get_password_raw_flags
                                                         (NMSetting8021x *setting);
 const char *        nm_setting_802_1x_get_pin           (NMSetting8021x *setting);
 NMSettingSecretFlags nm_setting_802_1x_get_pin_flags    (NMSetting8021x *setting);
+NMSetting8021xCKScheme nm_setting_802_1x_get_private_key_scheme
+                                                        (NMSetting8021x *setting);
 const GByteArray *  nm_setting_802_1x_get_private_key_blob
                                                         (NMSetting8021x *setting);
-NMSetting8021xCKFormat nm_setting_802_1x_get_private_key_format
+const char *        nm_setting_802_1x_get_private_key_path
                                                         (NMSetting8021x *setting);
+gboolean            nm_setting_802_1x_set_private_key   (NMSetting8021x *setting,
+                                                         const char *key_path,
+                                                         const char *password,
+                                                         NMSetting8021xCKScheme scheme,
+                                                         NMSetting8021xCKFormat *out_format,
+                                                         GError **error);
 const char *        nm_setting_802_1x_get_private_key_password
                                                         (NMSetting8021x *setting);
 NMSettingSecretFlags nm_setting_802_1x_get_private_key_password_flags
                                                         (NMSetting8021x *setting);
-const char *        nm_setting_802_1x_get_private_key_path
+NMSetting8021xCKFormat nm_setting_802_1x_get_private_key_format
                                                         (NMSetting8021x *setting);
-NMSetting8021xCKScheme nm_setting_802_1x_get_private_key_scheme
+NMSetting8021xCKScheme nm_setting_802_1x_get_phase2_private_key_scheme
                                                         (NMSetting8021x *setting);
-const char *        nm_setting_802_1x_get_subject_match (NMSetting8021x *setting);
-gboolean            nm_setting_802_1x_get_system_ca_certs
+const GByteArray *  nm_setting_802_1x_get_phase2_private_key_blob
+                                                        (NMSetting8021x *setting);
+const char *        nm_setting_802_1x_get_phase2_private_key_path
                                                         (NMSetting8021x *setting);
-NMSetting *         nm_setting_802_1x_new               (void);
-void                nm_setting_802_1x_remove_altsubject_match
-                                                        (NMSetting8021x *setting,
-                                                         guint32 i);
-void                nm_setting_802_1x_remove_eap_method (NMSetting8021x *setting,
-                                                         guint32 i);
-void                nm_setting_802_1x_remove_phase2_altsubject_match
-                                                        (NMSetting8021x *setting,
-                                                         guint32 i);
-gboolean            nm_setting_802_1x_set_ca_cert       (NMSetting8021x *setting,
-                                                         const char *cert_path,
-                                                         NMSetting8021xCKScheme scheme,
-                                                         NMSetting8021xCKFormat *out_format,
-                                                         GError **error);
-gboolean            nm_setting_802_1x_set_client_cert   (NMSetting8021x *setting,
-                                                         const char *cert_path,
-                                                         NMSetting8021xCKScheme scheme,
-                                                         NMSetting8021xCKFormat *out_format,
-                                                         GError **error);
-gboolean            nm_setting_802_1x_set_phase2_ca_cert
-                                                        (NMSetting8021x *setting,
-                                                         const char *cert_path,
-                                                         NMSetting8021xCKScheme scheme,
-                                                         NMSetting8021xCKFormat *out_format,
-                                                         GError **error);
-gboolean            nm_setting_802_1x_set_phase2_client_cert
-                                                        (NMSetting8021x *setting,
-                                                         const char *cert_path,
-                                                         NMSetting8021xCKScheme scheme,
-                                                         NMSetting8021xCKFormat *out_format,
-                                                         GError **error);
 gboolean            nm_setting_802_1x_set_phase2_private_key
                                                         (NMSetting8021x *setting,
                                                          const char *key_path,
@@ -224,21 +224,16 @@ const char *        NMSetting8021xCKScheme scheme,
                                                          NMSetting8021xCKFormat *out_format,
                                                          GError **error);
-gboolean            nm_setting_802_1x_set_private_key   (NMSetting8021x *setting,
-                                                         const char *key_path,
-                                                         const char *password,
-                                                         NMSetting8021xCKScheme scheme,
-                                                         NMSetting8021xCKFormat *out_format,
-                                                         GError **error);
+const char *        nm_setting_802_1x_get_phase2_private_key_password
+                                                        (NMSetting8021x *setting);
+NMSettingSecretFlags nm_setting_802_1x_get_phase2_private_key_password_flags
+                                                        (NMSetting8021x *setting);
+NMSetting8021xCKFormat nm_setting_802_1x_get_phase2_private_key_format
+                                                        (NMSetting8021x *setting);
 

Object Hierarchy

-
-  GObject
-   +----NMSetting
-         +----NMSetting8021x
-
   GEnum
    +----NMSetting8021xCKFormat
@@ -251,6 +246,11 @@ const char *        
+  GObject
+   +----NMSetting
+         +----NMSetting8021x
+

Properties

@@ -280,6 +280,8 @@ const char * phase2-private-key-password" gchar* : Read / Write "phase2-private-key-password-flags" guint : Read / Write "phase2-subject-match" gchar* : Read / Write + "pin" gchar* : Read / Write + "pin-flags" guint : Read / Write "private-key" GArray_guchar_* : Read / Write "private-key-password" gchar* : Read / Write "private-key-password-flags" guint : Read / Write @@ -321,13 +323,6 @@ following books.

Details

-

NMSetting8021x

-
typedef struct _NMSetting8021x NMSetting8021x;
-

-

-
-
-

enum NMSetting8021xCKFormat

typedef enum {
  /*< underscore_name=nm_setting_802_1x_ck_format >*/
@@ -341,8 +336,11 @@ following books.
 NMSetting8021xCKFormat values indicate the general type of a certificate
 or private key
 

-
+
+++ @@ -384,8 +382,11 @@ and private key stored in the setting properties, either as a blob of the item's data, or as a path to a certificate or private key file on the filesystem

-

NM_SETTING_802_1X_CK_FORMAT_UNKNOWN

+
+++ @@ -410,16 +411,8 @@ to a file containing the certificate or key data
-

NMSetting8021xClass

-
typedef struct {
-	NMSettingClass parent;
-
-	/* Padding for future expansion */
-	void (*_reserved1) (void);
-	void (*_reserved2) (void);
-	void (*_reserved3) (void);
-	void (*_reserved4) (void);
-} NMSetting8021xClass;
+

NM_SETTING_802_1X_SETTING_NAME

+
#define NM_SETTING_802_1X_SETTING_NAME "802-1x"
 

@@ -434,8 +427,11 @@ to a file containing the certificate or key data NM_SETTING_802_1X_ERROR_MISSING_PROPERTY /*< nick=MissingProperty >*/ } NMSetting8021xError;
-

NM_SETTING_802_1X_CK_SCHEME_UNKNOWN

+
+++ @@ -458,104 +454,114 @@ required
-

NM_SETTING_802_1X_ALTSUBJECT_MATCHES

-
#define NM_SETTING_802_1X_ALTSUBJECT_MATCHES "altsubject-matches"
+

NM_SETTING_802_1X_ERROR

+
#define NM_SETTING_802_1X_ERROR nm_setting_802_1x_error_quark ()
 


-

NM_SETTING_802_1X_ANONYMOUS_IDENTITY

-
#define NM_SETTING_802_1X_ANONYMOUS_IDENTITY "anonymous-identity"
-
+

nm_setting_802_1x_error_quark ()

+
GQuark              nm_setting_802_1x_error_quark       (void);

+Registers an error quark for NMSetting8021x if necessary.

+

NM_SETTING_802_1X_ERROR_UNKNOWN

++++ + + + + +

Returns :

the error quark used for NMSetting8021x errors.

-

NM_SETTING_802_1X_CA_CERT

-
#define NM_SETTING_802_1X_CA_CERT "ca-cert"
+

NM_SETTING_802_1X_EAP

+
#define NM_SETTING_802_1X_EAP "eap"
 


-

NM_SETTING_802_1X_CA_PATH

-
#define NM_SETTING_802_1X_CA_PATH "ca-path"
+

NM_SETTING_802_1X_IDENTITY

+
#define NM_SETTING_802_1X_IDENTITY "identity"
 


-

NM_SETTING_802_1X_CLIENT_CERT

-
#define NM_SETTING_802_1X_CLIENT_CERT "client-cert"
+

NM_SETTING_802_1X_ANONYMOUS_IDENTITY

+
#define NM_SETTING_802_1X_ANONYMOUS_IDENTITY "anonymous-identity"
 


-

NM_SETTING_802_1X_EAP

-
#define NM_SETTING_802_1X_EAP "eap"
+

NM_SETTING_802_1X_PAC_FILE

+
#define NM_SETTING_802_1X_PAC_FILE "pac-file"
 


-

NM_SETTING_802_1X_ERROR

-
#define NM_SETTING_802_1X_ERROR nm_setting_802_1x_error_quark ()
+

NM_SETTING_802_1X_CA_CERT

+
#define NM_SETTING_802_1X_CA_CERT "ca-cert"
 


-

NM_SETTING_802_1X_IDENTITY

-
#define NM_SETTING_802_1X_IDENTITY "identity"
+

NM_SETTING_802_1X_CA_PATH

+
#define NM_SETTING_802_1X_CA_PATH "ca-path"
 


-

NM_SETTING_802_1X_PAC_FILE

-
#define NM_SETTING_802_1X_PAC_FILE "pac-file"
+

NM_SETTING_802_1X_SUBJECT_MATCH

+
#define NM_SETTING_802_1X_SUBJECT_MATCH "subject-match"
 


-

NM_SETTING_802_1X_PASSWORD

-
#define NM_SETTING_802_1X_PASSWORD "password"
+

NM_SETTING_802_1X_ALTSUBJECT_MATCHES

+
#define NM_SETTING_802_1X_ALTSUBJECT_MATCHES "altsubject-matches"
 


-

NM_SETTING_802_1X_PASSWORD_FLAGS

-
#define NM_SETTING_802_1X_PASSWORD_FLAGS "password-flags"
+

NM_SETTING_802_1X_CLIENT_CERT

+
#define NM_SETTING_802_1X_CLIENT_CERT "client-cert"
 


-

NM_SETTING_802_1X_PASSWORD_RAW

-
#define NM_SETTING_802_1X_PASSWORD_RAW "password-raw"
+

NM_SETTING_802_1X_PHASE1_PEAPVER

+
#define NM_SETTING_802_1X_PHASE1_PEAPVER "phase1-peapver"
 


-

NM_SETTING_802_1X_PASSWORD_RAW_FLAGS

-
#define NM_SETTING_802_1X_PASSWORD_RAW_FLAGS "password-raw-flags"
+

NM_SETTING_802_1X_PHASE1_PEAPLABEL

+
#define NM_SETTING_802_1X_PHASE1_PEAPLABEL "phase1-peaplabel"
 

@@ -570,152 +576,152 @@ required

-

NM_SETTING_802_1X_PHASE1_PEAPLABEL

-
#define NM_SETTING_802_1X_PHASE1_PEAPLABEL "phase1-peaplabel"
+

NM_SETTING_802_1X_PHASE2_AUTH

+
#define NM_SETTING_802_1X_PHASE2_AUTH "phase2-auth"
 


-

NM_SETTING_802_1X_PHASE1_PEAPVER

-
#define NM_SETTING_802_1X_PHASE1_PEAPVER "phase1-peapver"
+

NM_SETTING_802_1X_PHASE2_AUTHEAP

+
#define NM_SETTING_802_1X_PHASE2_AUTHEAP "phase2-autheap"
 


-

NM_SETTING_802_1X_PHASE2_ALTSUBJECT_MATCHES

-
#define NM_SETTING_802_1X_PHASE2_ALTSUBJECT_MATCHES "phase2-altsubject-matches"
+

NM_SETTING_802_1X_PHASE2_CA_CERT

+
#define NM_SETTING_802_1X_PHASE2_CA_CERT "phase2-ca-cert"
 


-

NM_SETTING_802_1X_PHASE2_AUTH

-
#define NM_SETTING_802_1X_PHASE2_AUTH "phase2-auth"
+

NM_SETTING_802_1X_PHASE2_CA_PATH

+
#define NM_SETTING_802_1X_PHASE2_CA_PATH "phase2-ca-path"
 


-

NM_SETTING_802_1X_PHASE2_AUTHEAP

-
#define NM_SETTING_802_1X_PHASE2_AUTHEAP "phase2-autheap"
+

NM_SETTING_802_1X_PHASE2_SUBJECT_MATCH

+
#define NM_SETTING_802_1X_PHASE2_SUBJECT_MATCH "phase2-subject-match"
 


-

NM_SETTING_802_1X_PHASE2_CA_CERT

-
#define NM_SETTING_802_1X_PHASE2_CA_CERT "phase2-ca-cert"
+

NM_SETTING_802_1X_PHASE2_ALTSUBJECT_MATCHES

+
#define NM_SETTING_802_1X_PHASE2_ALTSUBJECT_MATCHES "phase2-altsubject-matches"
 


-

NM_SETTING_802_1X_PHASE2_CA_PATH

-
#define NM_SETTING_802_1X_PHASE2_CA_PATH "phase2-ca-path"
+

NM_SETTING_802_1X_PHASE2_CLIENT_CERT

+
#define NM_SETTING_802_1X_PHASE2_CLIENT_CERT "phase2-client-cert"
 


-

NM_SETTING_802_1X_PHASE2_CLIENT_CERT

-
#define NM_SETTING_802_1X_PHASE2_CLIENT_CERT "phase2-client-cert"
+

NM_SETTING_802_1X_PASSWORD

+
#define NM_SETTING_802_1X_PASSWORD "password"
 


-

NM_SETTING_802_1X_PHASE2_PRIVATE_KEY

-
#define NM_SETTING_802_1X_PHASE2_PRIVATE_KEY "phase2-private-key"
+

NM_SETTING_802_1X_PASSWORD_FLAGS

+
#define NM_SETTING_802_1X_PASSWORD_FLAGS "password-flags"
 


-

NM_SETTING_802_1X_PHASE2_PRIVATE_KEY_PASSWORD

-
#define NM_SETTING_802_1X_PHASE2_PRIVATE_KEY_PASSWORD "phase2-private-key-password"
+

NM_SETTING_802_1X_PASSWORD_RAW

+
#define NM_SETTING_802_1X_PASSWORD_RAW "password-raw"
 


-

NM_SETTING_802_1X_PHASE2_PRIVATE_KEY_PASSWORD_FLAGS

-
#define NM_SETTING_802_1X_PHASE2_PRIVATE_KEY_PASSWORD_FLAGS "phase2-private-key-password-flags"
+

NM_SETTING_802_1X_PASSWORD_RAW_FLAGS

+
#define NM_SETTING_802_1X_PASSWORD_RAW_FLAGS "password-raw-flags"
 


-

NM_SETTING_802_1X_PHASE2_SUBJECT_MATCH

-
#define NM_SETTING_802_1X_PHASE2_SUBJECT_MATCH "phase2-subject-match"
+

NM_SETTING_802_1X_PRIVATE_KEY

+
#define NM_SETTING_802_1X_PRIVATE_KEY "private-key"
 


-

NM_SETTING_802_1X_PIN

-
#define NM_SETTING_802_1X_PIN "pin"
+

NM_SETTING_802_1X_PRIVATE_KEY_PASSWORD

+
#define NM_SETTING_802_1X_PRIVATE_KEY_PASSWORD "private-key-password"
 


-

NM_SETTING_802_1X_PIN_FLAGS

-
#define NM_SETTING_802_1X_PIN_FLAGS "pin-flags"
+

NM_SETTING_802_1X_PRIVATE_KEY_PASSWORD_FLAGS

+
#define NM_SETTING_802_1X_PRIVATE_KEY_PASSWORD_FLAGS "private-key-password-flags"
 


-

NM_SETTING_802_1X_PRIVATE_KEY

-
#define NM_SETTING_802_1X_PRIVATE_KEY "private-key"
+

NM_SETTING_802_1X_PHASE2_PRIVATE_KEY

+
#define NM_SETTING_802_1X_PHASE2_PRIVATE_KEY "phase2-private-key"
 


-

NM_SETTING_802_1X_PRIVATE_KEY_PASSWORD

-
#define NM_SETTING_802_1X_PRIVATE_KEY_PASSWORD "private-key-password"
+

NM_SETTING_802_1X_PHASE2_PRIVATE_KEY_PASSWORD

+
#define NM_SETTING_802_1X_PHASE2_PRIVATE_KEY_PASSWORD "phase2-private-key-password"
 


-

NM_SETTING_802_1X_PRIVATE_KEY_PASSWORD_FLAGS

-
#define NM_SETTING_802_1X_PRIVATE_KEY_PASSWORD_FLAGS "private-key-password-flags"
+

NM_SETTING_802_1X_PHASE2_PRIVATE_KEY_PASSWORD_FLAGS

+
#define NM_SETTING_802_1X_PHASE2_PRIVATE_KEY_PASSWORD_FLAGS "phase2-private-key-password-flags"
 


-

NM_SETTING_802_1X_SETTING_NAME

-
#define NM_SETTING_802_1X_SETTING_NAME "802-1x"
+

NM_SETTING_802_1X_PIN

+
#define NM_SETTING_802_1X_PIN "pin"
 


-

NM_SETTING_802_1X_SUBJECT_MATCH

-
#define NM_SETTING_802_1X_SUBJECT_MATCH "subject-match"
+

NM_SETTING_802_1X_PIN_FLAGS

+
#define NM_SETTING_802_1X_PIN_FLAGS "pin-flags"
 

@@ -730,17 +736,62 @@ required

-

nm_setting_802_1x_add_altsubject_match ()

-
gboolean            nm_setting_802_1x_add_altsubject_match
-                                                        (NMSetting8021x *setting,
-                                                         const char *altsubject_match);
+

NMSetting8021x

+
typedef struct _NMSetting8021x NMSetting8021x;
+

+

+
+
+
+

NMSetting8021xClass

+
typedef struct {
+	NMSettingClass parent;
+
+	/* Padding for future expansion */
+	void (*_reserved1) (void);
+	void (*_reserved2) (void);
+	void (*_reserved3) (void);
+	void (*_reserved4) (void);
+} NMSetting8021xClass;
+

-Adds an allowed alternate subject name match. Until at least one -match is added, the altSubjectName of the remote authentication -server is not verified.

-
+ +
+
+

nm_setting_802_1x_new ()

+
NMSetting *         nm_setting_802_1x_new               (void);
+

+Creates a new NMSetting8021x object with default values. +

+
++++ + + + + +

Returns :

the new empty NMSetting8021x object
+
+
+
+

nm_setting_802_1x_get_num_eap_methods ()

+
guint32             nm_setting_802_1x_get_num_eap_methods
+                                                        (NMSetting8021x *setting);
+

+Returns the number of eap methods allowed for use when connecting to the +network. Generally only one EAP method is used. Use the functions +nm_setting_802_1x_get_eap_method(), nm_setting_802_1x_add_eap_method(), +and nm_setting_802_1x_remove_eap_method() for adding, removing, and retrieving +allowed EAP methods. +

+
+++ @@ -748,13 +799,39 @@ server is not verified. - - + + + + +

setting :

altsubject_match :

the altSubjectName to allow for this connection

Returns :

the number of allowed EAP methods
+
+
+
+

nm_setting_802_1x_get_eap_method ()

+
const char *        nm_setting_802_1x_get_eap_method    (NMSetting8021x *setting,
+                                                         guint32 i);
+

+Returns the name of the allowed EAP method at index i. +

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

setting :

the NMSetting8021x +

i :

the index of the EAP method name to return

Returns :

TRUE if the alternative subject name match was -successfully added, FALSE if it was already allowed.the name of the allowed EAP method at index i +
@@ -769,8 +846,11 @@ Adds an allowed EAP method. The setting is not valid until at least one EAP method has been added. See "eap" property for a list of allowed EAP methods.

-
+
+++ @@ -791,17 +871,17 @@ not a valid method or if it was already allowed.
-

nm_setting_802_1x_add_phase2_altsubject_match ()

-
gboolean            nm_setting_802_1x_add_phase2_altsubject_match
-                                                        (NMSetting8021x *setting,
-                                                         const char *phase2_altsubject_match);
+

nm_setting_802_1x_remove_eap_method ()

+
void                nm_setting_802_1x_remove_eap_method (NMSetting8021x *setting,
+                                                         guint32 i);

-Adds an allowed alternate subject name match for "phase 2". Until -at least one match is added, the altSubjectName of the "phase 2" -remote authentication server is not verified. +Removes the allowed EAP method at the specified index.

-

setting :

+
+++ @@ -809,28 +889,24 @@ remote authentication server is not verified. - - - - - - + +

setting :

phase2_altsubject_match :

the "phase 2" altSubjectName to allow for this -connection

Returns :

TRUE if the "phase 2" alternative subject name match was -successfully added, FALSE if it was already allowed.

i :

the index of the EAP method to remove

-

nm_setting_802_1x_clear_altsubject_matches ()

-
void                nm_setting_802_1x_clear_altsubject_matches
-                                                        (NMSetting8021x *setting);
+

nm_setting_802_1x_clear_eap_methods ()

+
void                nm_setting_802_1x_clear_eap_methods (NMSetting8021x *setting);

-Clears all altSubjectName matches. +Clears all allowed EAP methods.

-
+
+++

nm_setting_802_1x_get_phase1_peaplabel ()

const char *        nm_setting_802_1x_get_phase1_peaplabel
                                                         (NMSetting8021x *setting);
-

setting :

the NMSetting8021x @@ -840,77 +916,26 @@ Clears all altSubjectName matches.
-

nm_setting_802_1x_clear_eap_methods ()

-
void                nm_setting_802_1x_clear_eap_methods (NMSetting8021x *setting);
+

nm_setting_802_1x_get_identity ()

+
const char *        nm_setting_802_1x_get_identity      (NMSetting8021x *setting);

-Clears all allowed EAP methods. +Returns the identifier used by some EAP methods (like TLS) to +authenticate the user. Often this is a username or login name.

-
+
+- ++ + + - -

setting :

the NMSetting8021x
-
-
-
-

nm_setting_802_1x_clear_phase2_altsubject_matches ()

-
void                nm_setting_802_1x_clear_phase2_altsubject_matches
-                                                        (NMSetting8021x *setting);
-

-Clears all "phase 2" altSubjectName matches. -

-
-- - - - -

setting :

the NMSetting8021x -
-
-
-
-

nm_setting_802_1x_error_quark ()

-
GQuark              nm_setting_802_1x_error_quark       (void);
-

-Registers an error quark for NMSetting8021x if necessary. -

-
-- - - - -

Returns :

the error quark used for NMSetting8021x errors.
-
-
-
-

nm_setting_802_1x_get_altsubject_match ()

-
const char *        nm_setting_802_1x_get_altsubject_match
-                                                        (NMSetting8021x *setting,
-                                                         guint32 i);
-

-Returns the altSubjectName match at index i. -

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

setting :

the NMSettingConnection -

i :

the zero-based index of the array of altSubjectName matches

Returns :

the altSubjectName match at index i -the user identifier
@@ -926,8 +951,11 @@ authenticate the user in the outer unencrypted "phase 1" authentication. The inner "phase 2" authentication will use the "identity" in a secure form, if applicable for that EAP method.

-
+
+++ @@ -943,18 +971,16 @@ a secure form, if applicable for that EAP method.
-

nm_setting_802_1x_get_ca_cert_blob ()

-
const GByteArray *  nm_setting_802_1x_get_ca_cert_blob  (NMSetting8021x *setting);
+

nm_setting_802_1x_get_pac_file ()

+
const char *        nm_setting_802_1x_get_pac_file      (NMSetting8021x *setting);

-Returns the CA certificate blob if the CA certificate is stored using the -NM_SETTING_802_1X_CK_SCHEME_BLOB scheme. Not all EAP methods use a -CA certificate (LEAP for example), and those that can take advantage of the -CA certificate allow it to be unset. Note that lack of a CA certificate -reduces security by allowing man-in-the-middle attacks, because the identity -of the network cannot be confirmed by the client. +Returns the file containing PAC credentials used by EAP-FAST method.

-

setting :

+
+++ @@ -963,25 +989,29 @@ of the network cannot be confirmed by the client. - +

setting :

Returns :

the CA certificate datathe PAC file

-

nm_setting_802_1x_get_ca_cert_path ()

-
const char *        nm_setting_802_1x_get_ca_cert_path  (NMSetting8021x *setting);
+

nm_setting_802_1x_get_system_ca_certs ()

+
gboolean            nm_setting_802_1x_get_system_ca_certs
+                                                        (NMSetting8021x *setting);

-Returns the CA certificate path if the CA certificate is stored using the -NM_SETTING_802_1X_CK_SCHEME_PATH scheme. Not all EAP methods use a -CA certificate (LEAP for example), and those that can take advantage of the -CA certificate allow it to be unset. Note that lack of a CA certificate -reduces security by allowing man-in-the-middle attacks, because the identity -of the network cannot be confirmed by the client. +Sets the "system-ca-certs" property. The +"ca-path" and "phase2-ca-path" +properties are ignored if the "system-ca-certs" property is +TRUE, in which case a system-wide CA certificate directory specified at +compile time (using the --system-ca-path configure option) is used in place +of these properties.

-
+
+++ @@ -990,23 +1020,27 @@ of the network cannot be confirmed by the client. - +

setting :

Returns :

path to the CA certificate fileTRUE if a system CA certificate path should be used, FALSE if not

-

nm_setting_802_1x_get_ca_cert_scheme ()

-
NMSetting8021xCKScheme nm_setting_802_1x_get_ca_cert_scheme
-                                                        (NMSetting8021x *setting);
+

nm_setting_802_1x_get_ca_path ()

+
const char *        nm_setting_802_1x_get_ca_path       (NMSetting8021x *setting);

-Returns the scheme used to store the CA certificate. If the returned scheme -is NM_SETTING_802_1X_CK_SCHEME_BLOB, use nm_setting_802_1x_get_ca_cert_blob(); -if NM_SETTING_802_1X_CK_SCHEME_PATH, use nm_setting_802_1x_get_ca_cert_path(). +Returns the path of the CA certificate directory if previously set. Systems +will often have a directory that contains multiple individual CA certificates +which the supplicant can then add to the verification chain. This may be +used in addition to the "ca-cert" property to add more CA +certificates for verifying the network to client.

-
+
+++ @@ -1015,24 +1049,28 @@ if Returns :

-
+

setting :

scheme used to store the CA certificate (blob or path)the CA certificate directory path

-

nm_setting_802_1x_get_ca_path ()

-
const char *        nm_setting_802_1x_get_ca_path       (NMSetting8021x *setting);
+

nm_setting_802_1x_get_phase2_ca_path ()

+
const char *        nm_setting_802_1x_get_phase2_ca_path
+                                                        (NMSetting8021x *setting);

-Returns the path of the CA certificate directory if previously set. Systems -will often have a directory that contains multiple individual CA certificates -which the supplicant can then add to the verification chain. This may be -used in addition to the "ca-cert" property to add more CA -certificates for verifying the network to client. +Returns the path of the "phase 2" CA certificate directory if previously set. +Systems will often have a directory that contains multiple individual CA +certificates which the supplicant can then add to the verification chain. +This may be used in addition to the "phase2-ca-cert" property +to add more CA certificates for verifying the network to client.

-
+
+++ @@ -1041,23 +1079,26 @@ certificates for verifying the network to client. - +

setting :

Returns :

the CA certificate directory paththe "phase 2" CA certificate directory path

-

nm_setting_802_1x_get_client_cert_blob ()

-
const GByteArray *  nm_setting_802_1x_get_client_cert_blob
+

nm_setting_802_1x_get_ca_cert_scheme ()

+
NMSetting8021xCKScheme nm_setting_802_1x_get_ca_cert_scheme
                                                         (NMSetting8021x *setting);

-Client certificates are used to identify the connecting client to the network -when EAP-TLS is used as either the "phase 1" or "phase 2" 802.1x -authentication method. +Returns the scheme used to store the CA certificate. If the returned scheme +is NM_SETTING_802_1X_CK_SCHEME_BLOB, use nm_setting_802_1x_get_ca_cert_blob(); +if NM_SETTING_802_1X_CK_SCHEME_PATH, use nm_setting_802_1x_get_ca_cert_path().

-
+
+++ @@ -1066,23 +1107,28 @@ authentication method. - +

setting :

Returns :

the client certificate datascheme used to store the CA certificate (blob or path)

-

nm_setting_802_1x_get_client_cert_path ()

-
const char *        nm_setting_802_1x_get_client_cert_path
-                                                        (NMSetting8021x *setting);
+

nm_setting_802_1x_get_ca_cert_blob ()

+
const GByteArray *  nm_setting_802_1x_get_ca_cert_blob  (NMSetting8021x *setting);

-Client certificates are used to identify the connecting client to the network -when EAP-TLS is used as either the "phase 1" or "phase 2" 802.1x -authentication method. +Returns the CA certificate blob if the CA certificate is stored using the +NM_SETTING_802_1X_CK_SCHEME_BLOB scheme. Not all EAP methods use a +CA certificate (LEAP for example), and those that can take advantage of the +CA certificate allow it to be unset. Note that lack of a CA certificate +reduces security by allowing man-in-the-middle attacks, because the identity +of the network cannot be confirmed by the client.

-
+
+++ @@ -1091,23 +1137,28 @@ authentication method. - +

setting :

Returns :

path to the client certificate filethe CA certificate data

-

nm_setting_802_1x_get_client_cert_scheme ()

-
NMSetting8021xCKScheme nm_setting_802_1x_get_client_cert_scheme
-                                                        (NMSetting8021x *setting);
+

nm_setting_802_1x_get_ca_cert_path ()

+
const char *        nm_setting_802_1x_get_ca_cert_path  (NMSetting8021x *setting);

-Returns the scheme used to store the client certificate. If the returned scheme -is NM_SETTING_802_1X_CK_SCHEME_BLOB, use nm_setting_802_1x_get_client_cert_blob(); -if NM_SETTING_802_1X_CK_SCHEME_PATH, use nm_setting_802_1x_get_client_cert_path(). +Returns the CA certificate path if the CA certificate is stored using the +NM_SETTING_802_1X_CK_SCHEME_PATH scheme. Not all EAP methods use a +CA certificate (LEAP for example), and those that can take advantage of the +CA certificate allow it to be unset. Note that lack of a CA certificate +reduces security by allowing man-in-the-middle attacks, because the identity +of the network cannot be confirmed by the client.

-
+
+++ @@ -1116,21 +1167,30 @@ if Returns :

-
+

setting :

scheme used to store the client certificate (blob or path)path to the CA certificate file

-

nm_setting_802_1x_get_eap_method ()

-
const char *        nm_setting_802_1x_get_eap_method    (NMSetting8021x *setting,
-                                                         guint32 i);
+

nm_setting_802_1x_set_ca_cert ()

+
gboolean            nm_setting_802_1x_set_ca_cert       (NMSetting8021x *setting,
+                                                         const char *cert_path,
+                                                         NMSetting8021xCKScheme scheme,
+                                                         NMSetting8021xCKFormat *out_format,
+                                                         GError **error);

-Returns the name of the allowed EAP method at index i. +Reads a certificate from disk and sets the "ca-cert" property +with the raw certificate data if using the NM_SETTING_802_1X_CK_SCHEME_BLOB +scheme, or with the path to the certificate file if using the +NM_SETTING_802_1X_CK_SCHEME_PATH scheme.

-
+
+++ @@ -1138,27 +1198,41 @@ Returns the name of the allowed EAP method at index - - + + + + + + + + + + + + + + - +

setting :

i :

the index of the EAP method name to return

cert_path :

when scheme is set to either NM_SETTING_802_1X_CK_SCHEME_PATH +or NM_SETTING_802_1X_CK_SCHEME_BLOB, pass the path of the CA certificate +file (PEM or DER format). The path must be UTF-8 encoded; use +g_filename_to_utf8() to convert if needed. Passing NULL with any scheme +clears the CA certificate.

scheme :

desired storage scheme for the certificate

out_format :

on successful return, the type of the certificate added

error :

on unsuccessful return, an error

Returns :

the name of the allowed EAP method at index i -TRUE if the operation succeeded, FALSE if it was unsuccessful

-

nm_setting_802_1x_get_identity ()

-
const char *        nm_setting_802_1x_get_identity      (NMSetting8021x *setting);
-

-Returns the identifier used by some EAP methods (like TLS) to -authenticate the user. Often this is a username or login name. -

-
+

nm_setting_802_1x_get_subject_match ()

+
const char *        nm_setting_802_1x_get_subject_match (NMSetting8021x *setting);
+
+++ @@ -1167,7 +1241,10 @@ authenticate the user. Often this is a username or login name. - +

setting :

Returns :

the user identifierthe "subject-match" property. This is the +substring to be matched against the subject of the authentication +server certificate, or NULL no subject verification is to be +performed.
@@ -1181,8 +1258,11 @@ authenticate the user. Often this is a username or login name. Returns the number of entries in the "altsubject-matches" property of this setting.

-
+
+++ @@ -1198,42 +1278,52 @@ Returns the number of entries in the
-

nm_setting_802_1x_get_num_eap_methods ()

-
guint32             nm_setting_802_1x_get_num_eap_methods
-                                                        (NMSetting8021x *setting);
+

nm_setting_802_1x_get_altsubject_match ()

+
const char *        nm_setting_802_1x_get_altsubject_match
+                                                        (NMSetting8021x *setting,
+                                                         guint32 i);

-Returns the number of eap methods allowed for use when connecting to the -network. Generally only one EAP method is used. Use the functions -nm_setting_802_1x_get_eap_method(), nm_setting_802_1x_add_eap_method(), -and nm_setting_802_1x_remove_eap_method() for adding, removing, and retrieving -allowed EAP methods. +Returns the altSubjectName match at index i.

-

setting :

+
+++ - + + + + - +

setting :

the NMSetting8021x +the NMSettingConnection

i :

the zero-based index of the array of altSubjectName matches

Returns :

the number of allowed EAP methodsthe altSubjectName match at index i +

-

nm_setting_802_1x_get_num_phase2_altsubject_matches ()

-
guint32             nm_setting_802_1x_get_num_phase2_altsubject_matches
-                                                        (NMSetting8021x *setting);
+

nm_setting_802_1x_add_altsubject_match ()

+
gboolean            nm_setting_802_1x_add_altsubject_match
+                                                        (NMSetting8021x *setting,
+                                                         const char *altsubject_match);

-Returns the number of entries in the -"phase2-altsubject-matches" property of this setting. +Adds an allowed alternate subject name match. Until at least one +match is added, the altSubjectName of the remote authentication +server is not verified.

-
+
+++ @@ -1241,21 +1331,31 @@ Returns the number of entries in the + + + + - +

setting :

altsubject_match :

the altSubjectName to allow for this connection

Returns :

the number of phase2-altsubject-matches entries.TRUE if the alternative subject name match was +successfully added, FALSE if it was already allowed.

-

nm_setting_802_1x_get_pac_file ()

-
const char *        nm_setting_802_1x_get_pac_file      (NMSetting8021x *setting);
-

-Returns the file containing PAC credentials used by EAP-FAST method. -

-
+

nm_setting_802_1x_remove_altsubject_match ()

+
void                nm_setting_802_1x_remove_altsubject_match
+                                                        (NMSetting8021x *setting,
+                                                         guint32 i);
+

+Removes the allowed altSubjectName at the specified index. +

+
+++ @@ -1263,18 +1363,47 @@ Returns the file containing PAC credentials used by EAP-FAST method. - - + +

setting :

Returns :

the PAC file

i :

the index of the altSubjectName match to remove

-

nm_setting_802_1x_get_password ()

-
const char *        nm_setting_802_1x_get_password      (NMSetting8021x *setting);
-
+

nm_setting_802_1x_clear_altsubject_matches ()

+
void                nm_setting_802_1x_clear_altsubject_matches
+                                                        (NMSetting8021x *setting);
+

+Clears all altSubjectName matches. +

+
++++ + + + + +

setting :

the NMSetting8021x +
+
+
+
+

nm_setting_802_1x_get_client_cert_scheme ()

+
NMSetting8021xCKScheme nm_setting_802_1x_get_client_cert_scheme
+                                                        (NMSetting8021x *setting);
+

+Returns the scheme used to store the client certificate. If the returned scheme +is NM_SETTING_802_1X_CK_SCHEME_BLOB, use nm_setting_802_1x_get_client_cert_blob(); +if NM_SETTING_802_1X_CK_SCHEME_PATH, use nm_setting_802_1x_get_client_cert_path(). +

+
+++ @@ -1283,19 +1412,26 @@ Returns the file containing PAC credentials used by EAP-FAST method. - +

setting :

Returns :

the password used by the authentication method, if any, as specified -by the "password" propertyscheme used to store the client certificate (blob or path)

-

nm_setting_802_1x_get_password_flags ()

-
NMSettingSecretFlags nm_setting_802_1x_get_password_flags
+

nm_setting_802_1x_get_client_cert_blob ()

+
const GByteArray *  nm_setting_802_1x_get_client_cert_blob
                                                         (NMSetting8021x *setting);
-
+

+Client certificates are used to identify the connecting client to the network +when EAP-TLS is used as either the "phase 1" or "phase 2" 802.1x +authentication method. +

+
+++ @@ -1304,18 +1440,26 @@ by the - +

setting :

Returns :

the NMSettingSecretFlags pertaining to the "password" -the client certificate data

-

nm_setting_802_1x_get_password_raw ()

-
const GByteArray *  nm_setting_802_1x_get_password_raw  (NMSetting8021x *setting);
-
+

nm_setting_802_1x_get_client_cert_path ()

+
const char *        nm_setting_802_1x_get_client_cert_path
+                                                        (NMSetting8021x *setting);
+

+Client certificates are used to identify the connecting client to the network +when EAP-TLS is used as either the "phase 1" or "phase 2" 802.1x +authentication method. +

+
+++ @@ -1324,20 +1468,35 @@ by the - +

setting :

Returns :

the password used by the authentication method as a -UTF-8-encoded array of bytes, as specified by the -"password-raw" propertypath to the client certificate file

-

nm_setting_802_1x_get_password_raw_flags ()

-
NMSettingSecretFlags nm_setting_802_1x_get_password_raw_flags
-                                                        (NMSetting8021x *setting);
-
+

nm_setting_802_1x_set_client_cert ()

+
gboolean            nm_setting_802_1x_set_client_cert   (NMSetting8021x *setting,
+                                                         const char *cert_path,
+                                                         NMSetting8021xCKScheme scheme,
+                                                         NMSetting8021xCKFormat *out_format,
+                                                         GError **error);
+

+Reads a certificate from disk and sets the "client-cert" +property with the raw certificate data if using the +NM_SETTING_802_1X_CK_SCHEME_BLOB scheme, or with the path to the certificate +file if using the NM_SETTING_802_1X_CK_SCHEME_PATH scheme. +

+

+Client certificates are used to identify the connecting client to the network +when EAP-TLS is used as either the "phase 1" or "phase 2" 802.1x +authentication method. +

+
+++ @@ -1345,21 +1504,42 @@ UTF-8-encoded array of bytes, as specified by the + + + + + + + + + + + + + + + + - +

setting :

cert_path :

when scheme is set to either NM_SETTING_802_1X_CK_SCHEME_PATH +or NM_SETTING_802_1X_CK_SCHEME_BLOB, pass the path of the client +certificate file (PEM, DER, or PKCS12 format). The path must be UTF-8 +encoded; use g_filename_to_utf8() to convert if needed. Passing NULL with +any scheme clears the client certificate.

scheme :

desired storage scheme for the certificate

out_format :

on successful return, the type of the certificate added

error :

on unsuccessful return, an error

Returns :

the NMSettingSecretFlags pertaining to the -"password-raw" -TRUE if the operation succeeded, FALSE if it was unsuccessful

-

nm_setting_802_1x_get_phase1_fast_provisioning ()

-
const char *        nm_setting_802_1x_get_phase1_fast_provisioning
+

nm_setting_802_1x_get_phase1_peapver ()

+
const char *        nm_setting_802_1x_get_phase1_peapver
                                                         (NMSetting8021x *setting);
-
+
+++ @@ -1368,9 +1548,9 @@ UTF-8-encoded array of bytes, as specified by the - +

setting :

Returns :

whether "phase 1" PEAP fast provisioning should be used, as specified -by the "phase1-fast-provisioning" property. See the -wpa_supplicant documentation for more details.the "phase 1" PEAP version to be used when authenticating with +EAP-PEAP as contained in the "phase1-peapver" property. Valid +values are NULL (unset), "0" (PEAP version 0), and "1" (PEAP version 1).
@@ -1380,8 +1560,11 @@ wpa_supplicant documentation for more details.
+
+++ @@ -1392,7 +1575,7 @@ wpa_supplicant documentation for more details. @@ -1401,11 +1584,14 @@ wpa_supplicant documentation for more details.
-

nm_setting_802_1x_get_phase1_peapver ()

-
const char *        nm_setting_802_1x_get_phase1_peapver
+

nm_setting_802_1x_get_phase1_fast_provisioning ()

+
const char *        nm_setting_802_1x_get_phase1_fast_provisioning
                                                         (NMSetting8021x *setting);
-

setting :

Returns :

whether the "phase 1" PEAP label is new-style or old-style, to be used when authenticating with EAP-PEAP, as contained in the -"phase1-peaplabel" property. Valid values are NULL (unset), +"phase1-peaplabel" property. Valid values are NULL (unset), "0" (use old-style label), and "1" (use new-style label). See the wpa_supplicant documentation for more details.
+
+++ @@ -1414,48 +1600,46 @@ wpa_supplicant documentation for more details. - +

setting :

Returns :

the "phase 1" PEAP version to be used when authenticating with -EAP-PEAP as contained in the "phase1-peapver" property. Valid -values are NULL (unset), "0" (PEAP version 0), and "1" (PEAP version 1).whether "phase 1" PEAP fast provisioning should be used, as specified +by the "phase1-fast-provisioning" property. See the +wpa_supplicant documentation for more details.

-

nm_setting_802_1x_get_phase2_altsubject_match ()

-
const char *        nm_setting_802_1x_get_phase2_altsubject_match
-                                                        (NMSetting8021x *setting,
-                                                         guint32 i);
-

-Returns the "phase 2" altSubjectName match at index i. -

-
+

nm_setting_802_1x_get_phase2_auth ()

+
const char *        nm_setting_802_1x_get_phase2_auth   (NMSetting8021x *setting);
+
+++ - - - - - - +

setting :

the NMSettingConnection +the NMSetting8021x

i :

the zero-based index of the array of "phase 2" altSubjectName matches

Returns :

the "phase 2" altSubjectName match at index i -the "phase 2" non-EAP (ex MD5) allowed authentication method as +specified by the "phase2-auth" property.

-

nm_setting_802_1x_get_phase2_auth ()

-
const char *        nm_setting_802_1x_get_phase2_auth   (NMSetting8021x *setting);
-
+

nm_setting_802_1x_get_phase2_autheap ()

+
const char *        nm_setting_802_1x_get_phase2_autheap
+                                                        (NMSetting8021x *setting);
+
+++ @@ -1464,19 +1648,28 @@ Returns the "phase 2" altSubjectName match at index - +

setting :

Returns :

the "phase 2" non-EAP (ex MD5) allowed authentication method as -specified by the "phase2-auth" property.the "phase 2" EAP-based (ex TLS) allowed authentication method as +specified by the "phase2-autheap" property.

-

nm_setting_802_1x_get_phase2_autheap ()

-
const char *        nm_setting_802_1x_get_phase2_autheap
+

nm_setting_802_1x_get_phase2_ca_cert_scheme ()

+
NMSetting8021xCKScheme nm_setting_802_1x_get_phase2_ca_cert_scheme
                                                         (NMSetting8021x *setting);
-
+

+Returns the scheme used to store the "phase 2" CA certificate. If the +returned scheme is NM_SETTING_802_1X_CK_SCHEME_BLOB, use +nm_setting_802_1x_get_ca_cert_blob(); if NM_SETTING_802_1X_CK_SCHEME_PATH, +use nm_setting_802_1x_get_ca_cert_path(). +

+
+++ @@ -1485,8 +1678,7 @@ specified by the Returns :

-
+

setting :

the "phase 2" EAP-based (ex TLS) allowed authentication method as -specified by the "phase2-autheap" property.scheme used to store the "phase 2" CA certificate (blob or path)
@@ -1504,8 +1696,11 @@ CA certificate allow it to be unset. Note that lack of a CA certificate reduces security by allowing man-in-the-middle attacks, because the identity of the network cannot be confirmed by the client.

-
+
+++ @@ -1532,8 +1727,11 @@ CA certificate allow it to be unset. Note that lack of a CA certificate reduces security by allowing man-in-the-middle attacks, because the identity of the network cannot be confirmed by the client.

-

setting :

+
+++ @@ -1549,17 +1747,24 @@ of the network cannot be confirmed by the client.
-

nm_setting_802_1x_get_phase2_ca_cert_scheme ()

-
NMSetting8021xCKScheme nm_setting_802_1x_get_phase2_ca_cert_scheme
-                                                        (NMSetting8021x *setting);
+

nm_setting_802_1x_set_phase2_ca_cert ()

+
gboolean            nm_setting_802_1x_set_phase2_ca_cert
+                                                        (NMSetting8021x *setting,
+                                                         const char *cert_path,
+                                                         NMSetting8021xCKScheme scheme,
+                                                         NMSetting8021xCKFormat *out_format,
+                                                         GError **error);

-Returns the scheme used to store the "phase 2" CA certificate. If the -returned scheme is NM_SETTING_802_1X_CK_SCHEME_BLOB, use -nm_setting_802_1x_get_ca_cert_blob(); if NM_SETTING_802_1X_CK_SCHEME_PATH, -use nm_setting_802_1x_get_ca_cert_path(). +Reads a certificate from disk and sets the "phase2-ca-cert" +property with the raw certificate data if using the +NM_SETTING_802_1X_CK_SCHEME_BLOB scheme, or with the path to the certificate +file if using the NM_SETTING_802_1X_CK_SCHEME_PATH scheme.

-

setting :

+
+++ @@ -1567,26 +1772,42 @@ use cert_path :

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

setting :

when scheme is set to either NM_SETTING_802_1X_CK_SCHEME_PATH +or NM_SETTING_802_1X_CK_SCHEME_BLOB, pass the path of the "phase2" CA +certificate file (PEM or DER format). The path must be UTF-8 encoded; use +g_filename_to_utf8() to convert if needed. Passing NULL with any scheme +clears the "phase2" CA certificate.

scheme :

desired storage scheme for the certificate

out_format :

on successful return, the type of the certificate added

error :

on unsuccessful return, an error

Returns :

scheme used to store the "phase 2" CA certificate (blob or path)TRUE if the operation succeeded, FALSE if it was unsuccessful

-

nm_setting_802_1x_get_phase2_ca_path ()

-
const char *        nm_setting_802_1x_get_phase2_ca_path
+

nm_setting_802_1x_get_phase2_subject_match ()

+
const char *        nm_setting_802_1x_get_phase2_subject_match
                                                         (NMSetting8021x *setting);
-

-Returns the path of the "phase 2" CA certificate directory if previously set. -Systems will often have a directory that contains multiple individual CA -certificates which the supplicant can then add to the verification chain. -This may be used in addition to the "phase2-ca-cert" property -to add more CA certificates for verifying the network to client. -

-
+
+++ @@ -1595,23 +1816,28 @@ to add more CA certificates for verifying the network to client. - +

setting :

Returns :

the "phase 2" CA certificate directory paththe "phase2-subject-match" property. This is +the substring to be matched against the subject of the "phase 2" +authentication server certificate, or NULL no subject verification +is to be performed.

-

nm_setting_802_1x_get_phase2_client_cert_blob ()

-
const GByteArray *  nm_setting_802_1x_get_phase2_client_cert_blob
+

nm_setting_802_1x_get_num_phase2_altsubject_matches ()

+
guint32             nm_setting_802_1x_get_num_phase2_altsubject_matches
                                                         (NMSetting8021x *setting);

-Client certificates are used to identify the connecting client to the network -when EAP-TLS is used as either the "phase 1" or "phase 2" 802.1x -authentication method. +Returns the number of entries in the +"phase2-altsubject-matches" property of this setting.

-
+
+++ @@ -1620,50 +1846,59 @@ authentication method. - +

setting :

Returns :

the "phase 2" client certificate datathe number of phase2-altsubject-matches entries.

-

nm_setting_802_1x_get_phase2_client_cert_path ()

-
const char *        nm_setting_802_1x_get_phase2_client_cert_path
-                                                        (NMSetting8021x *setting);
+

nm_setting_802_1x_get_phase2_altsubject_match ()

+
const char *        nm_setting_802_1x_get_phase2_altsubject_match
+                                                        (NMSetting8021x *setting,
+                                                         guint32 i);

-Client certificates are used to identify the connecting client to the network -when EAP-TLS is used as either the "phase 1" or "phase 2" 802.1x -authentication method. +Returns the "phase 2" altSubjectName match at index i.

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

setting :

the NMSetting8021x +the NMSettingConnection

i :

the zero-based index of the array of "phase 2" altSubjectName matches

Returns :

path to the "phase 2" client certificate filethe "phase 2" altSubjectName match at index i +

-

nm_setting_802_1x_get_phase2_client_cert_scheme ()

-
NMSetting8021xCKScheme nm_setting_802_1x_get_phase2_client_cert_scheme
-                                                        (NMSetting8021x *setting);
+

nm_setting_802_1x_add_phase2_altsubject_match ()

+
gboolean            nm_setting_802_1x_add_phase2_altsubject_match
+                                                        (NMSetting8021x *setting,
+                                                         const char *phase2_altsubject_match);

-Returns the scheme used to store the "phase 2" client certificate. If the -returned scheme is NM_SETTING_802_1X_CK_SCHEME_BLOB, use -nm_setting_802_1x_get_client_cert_blob(); if -NM_SETTING_802_1X_CK_SCHEME_PATH, use -nm_setting_802_1x_get_client_cert_path(). +Adds an allowed alternate subject name match for "phase 2". Until +at least one match is added, the altSubjectName of the "phase 2" +remote authentication server is not verified.

-
+
+++ @@ -1671,29 +1906,32 @@ returned scheme is phase2_altsubject_match :

+
+ + - +

setting :

the "phase 2" altSubjectName to allow for this +connection

Returns :

scheme used to store the "phase 2" client certificate (blob or path)TRUE if the "phase 2" alternative subject name match was +successfully added, FALSE if it was already allowed.

-

nm_setting_802_1x_get_phase2_private_key_blob ()

-
const GByteArray *  nm_setting_802_1x_get_phase2_private_key_blob
-                                                        (NMSetting8021x *setting);
-

-Private keys are used to authenticate the connecting client to the network -when EAP-TLS is used as either the "phase 1" or "phase 2" 802.1x -authentication method. -

+

nm_setting_802_1x_remove_phase2_altsubject_match ()

+
void                nm_setting_802_1x_remove_phase2_altsubject_match
+                                                        (NMSetting8021x *setting,
+                                                         guint32 i);

-WARNING: the phase2 private key property is not a "secret" property, and thus -unencrypted private key data may be readable by unprivileged users. Private -keys should always be encrypted with a private key password. +Removes the allowed "phase 2" altSubjectName at the specified index.

-
+
+++ @@ -1701,40 +1939,49 @@ keys should always be encrypted with a private key password. - - + +

setting :

Returns :

the "phase 2" private key data

i :

the index of the "phase 2" altSubjectName match to remove

-

nm_setting_802_1x_get_phase2_private_key_format ()

-
NMSetting8021xCKFormat nm_setting_802_1x_get_phase2_private_key_format
+

nm_setting_802_1x_clear_phase2_altsubject_matches ()

+
void                nm_setting_802_1x_clear_phase2_altsubject_matches
                                                         (NMSetting8021x *setting);
-
+

+Clears all "phase 2" altSubjectName matches. +

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

setting :

the NMSetting8021x

Returns :

the data format of the "phase 2" private key data stored in the -"phase2-private-key" property

-

nm_setting_802_1x_get_phase2_private_key_password ()

-
const char *        nm_setting_802_1x_get_phase2_private_key_password
+

nm_setting_802_1x_get_phase2_client_cert_scheme ()

+
NMSetting8021xCKScheme nm_setting_802_1x_get_phase2_client_cert_scheme
                                                         (NMSetting8021x *setting);
-
+

+Returns the scheme used to store the "phase 2" client certificate. If the +returned scheme is NM_SETTING_802_1X_CK_SCHEME_BLOB, use +nm_setting_802_1x_get_client_cert_blob(); if +NM_SETTING_802_1X_CK_SCHEME_PATH, use +nm_setting_802_1x_get_client_cert_path(). +

+
+++ @@ -1743,20 +1990,26 @@ keys should always be encrypted with a private key password. - +

setting :

Returns :

the private key password used to decrypt the private key if -previously set with nm_setting_802_1x_set_phase2_private_key() or the -"phase2-private-key-password" property.scheme used to store the "phase 2" client certificate (blob or path)

-

nm_setting_802_1x_get_phase2_private_key_password_flags ()

-
NMSettingSecretFlags nm_setting_802_1x_get_phase2_private_key_password_flags
+

nm_setting_802_1x_get_phase2_client_cert_blob ()

+
const GByteArray *  nm_setting_802_1x_get_phase2_client_cert_blob
                                                         (NMSetting8021x *setting);
-
+

+Client certificates are used to identify the connecting client to the network +when EAP-TLS is used as either the "phase 1" or "phase 2" 802.1x +authentication method. +

+
+++ @@ -1765,25 +2018,26 @@ previously set with Returns :

-
+

setting :

the NMSettingSecretFlags pertaining to the -"phase2-private-key-password" -the "phase 2" client certificate data

-

nm_setting_802_1x_get_phase2_private_key_path ()

-
const char *        nm_setting_802_1x_get_phase2_private_key_path
+

nm_setting_802_1x_get_phase2_client_cert_path ()

+
const char *        nm_setting_802_1x_get_phase2_client_cert_path
                                                         (NMSetting8021x *setting);

-Private keys are used to authenticate the connecting client to the network +Client certificates are used to identify the connecting client to the network when EAP-TLS is used as either the "phase 1" or "phase 2" 802.1x authentication method.

-
+
+++ @@ -1792,25 +2046,36 @@ authentication method. - +

setting :

Returns :

path to the "phase 2" private key filepath to the "phase 2" client certificate file

-

nm_setting_802_1x_get_phase2_private_key_scheme ()

-
NMSetting8021xCKScheme nm_setting_802_1x_get_phase2_private_key_scheme
-                                                        (NMSetting8021x *setting);
+

nm_setting_802_1x_set_phase2_client_cert ()

+
gboolean            nm_setting_802_1x_set_phase2_client_cert
+                                                        (NMSetting8021x *setting,
+                                                         const char *cert_path,
+                                                         NMSetting8021xCKScheme scheme,
+                                                         NMSetting8021xCKFormat *out_format,
+                                                         GError **error);

-Returns the scheme used to store the "phase 2" private key. If the returned -scheme is NM_SETTING_802_1X_CK_SCHEME_BLOB, use -nm_setting_802_1x_get_client_cert_blob(); if -NM_SETTING_802_1X_CK_SCHEME_PATH, use -nm_setting_802_1x_get_client_cert_path(). +Reads a certificate from disk and sets the "phase2-client-cert" +property with the raw certificate data if using the +NM_SETTING_802_1X_CK_SCHEME_BLOB scheme, or with the path to the certificate +file if using the NM_SETTING_802_1X_CK_SCHEME_PATH scheme. +

+

+Client certificates are used to identify the connecting client to the network +when EAP-TLS is used as either the "phase 1" or "phase 2" 802.1x +authentication method.

-
+
+++ @@ -1818,61 +2083,41 @@ scheme is Returns :

-
+ + - -

setting :

scheme used to store the "phase 2" private key (blob or path)

cert_path :

when scheme is set to either NM_SETTING_802_1X_CK_SCHEME_PATH +or NM_SETTING_802_1X_CK_SCHEME_BLOB, pass the path of the "phase2" client +certificate file (PEM, DER, or PKCS12 format). The path must be UTF-8 +encoded; use g_filename_to_utf8() to convert if needed. Passing NULL with +any scheme clears the "phase2" client certificate.
-
-
-
-

nm_setting_802_1x_get_phase2_subject_match ()

-
const char *        nm_setting_802_1x_get_phase2_subject_match
-                                                        (NMSetting8021x *setting);
-
-- - - + + - - + + - -

setting :

the NMSetting8021x -

scheme :

desired storage scheme for the certificate

Returns :

the "phase2-subject-match" property. This is -the substring to be matched against the subject of the "phase 2" -authentication server certificate, or NULL no subject verification -is to be performed.

out_format :

on successful return, the type of the certificate added
-
-
-
-

nm_setting_802_1x_get_pin ()

-
const char *        nm_setting_802_1x_get_pin           (NMSetting8021x *setting);
-
-- - - + + - +

setting :

the NMSetting8021x -

error :

on unsuccessful return, an error

Returns :

the PIN used by the authentication method, if any, as specified -by the "pin" propertyTRUE if the operation succeeded, FALSE if it was unsuccessful

-

nm_setting_802_1x_get_pin_flags ()

-
NMSettingSecretFlags nm_setting_802_1x_get_pin_flags    (NMSetting8021x *setting);
-
+

nm_setting_802_1x_get_password ()

+
const char *        nm_setting_802_1x_get_password      (NMSetting8021x *setting);
+
+++ @@ -1881,30 +2126,22 @@ by the "pin" property - +

setting :

Returns :

the NMSettingSecretFlags pertaining to the -"pin" -the password used by the authentication method, if any, as specified +by the "password" property

-

nm_setting_802_1x_get_private_key_blob ()

-
const GByteArray *  nm_setting_802_1x_get_private_key_blob
+

nm_setting_802_1x_get_password_flags ()

+
NMSettingSecretFlags nm_setting_802_1x_get_password_flags
                                                         (NMSetting8021x *setting);
-

-Private keys are used to authenticate the connecting client to the network -when EAP-TLS is used as either the "phase 1" or "phase 2" 802.1x -authentication method. -

-

-WARNING: the private key property is not a "secret" property, and thus -unencrypted private key data may be readable by unprivileged users. Private -keys should always be encrypted with a private key password. -

-
+
+++ @@ -1913,18 +2150,21 @@ keys should always be encrypted with a private key password. - +

setting :

Returns :

the private key datathe NMSettingSecretFlags pertaining to the "password" +

-

nm_setting_802_1x_get_private_key_format ()

-
NMSetting8021xCKFormat nm_setting_802_1x_get_private_key_format
-                                                        (NMSetting8021x *setting);
-
+

nm_setting_802_1x_get_password_raw ()

+
const GByteArray *  nm_setting_802_1x_get_password_raw  (NMSetting8021x *setting);
+
+++ @@ -1933,19 +2173,23 @@ keys should always be encrypted with a private key password. - +

setting :

Returns :

the data format of the private key data stored in the -"private-key" propertythe password used by the authentication method as a +UTF-8-encoded array of bytes, as specified by the +"password-raw" property

-

nm_setting_802_1x_get_private_key_password ()

-
const char *        nm_setting_802_1x_get_private_key_password
+

nm_setting_802_1x_get_password_raw_flags ()

+
NMSettingSecretFlags nm_setting_802_1x_get_password_raw_flags
                                                         (NMSetting8021x *setting);
-
+
+++ @@ -1954,20 +2198,22 @@ keys should always be encrypted with a private key password. - +

setting :

Returns :

the private key password used to decrypt the private key if -previously set with nm_setting_802_1x_set_private_key(), or the -"private-key-password" property.the NMSettingSecretFlags pertaining to the +"password-raw" +

-

nm_setting_802_1x_get_private_key_password_flags ()

-
NMSettingSecretFlags nm_setting_802_1x_get_private_key_password_flags
-                                                        (NMSetting8021x *setting);
-
+

nm_setting_802_1x_get_pin ()

+
const char *        nm_setting_802_1x_get_pin           (NMSetting8021x *setting);
+
+++ @@ -1976,25 +2222,21 @@ previously set with Returns :

-
+

setting :

the NMSettingSecretFlags pertaining to the -"private-key-password" -the PIN used by the authentication method, if any, as specified +by the "pin" property

-

nm_setting_802_1x_get_private_key_path ()

-
const char *        nm_setting_802_1x_get_private_key_path
-                                                        (NMSetting8021x *setting);
-

-Private keys are used to authenticate the connecting client to the network -when EAP-TLS is used as either the "phase 1" or "phase 2" 802.1x -authentication method. -

-
+

nm_setting_802_1x_get_pin_flags ()

+
NMSettingSecretFlags nm_setting_802_1x_get_pin_flags    (NMSetting8021x *setting);
+
+++ @@ -2003,7 +2245,9 @@ authentication method. - +

setting :

Returns :

path to the private key filethe NMSettingSecretFlags pertaining to the +"pin" +
@@ -2020,8 +2264,11 @@ Returns the scheme used to store the private key. If the returned scheme is NM_SETTING_802_1X_CK_SCHEME_PATH, use nm_setting_802_1x_get_client_cert_path().

-
+
+++ @@ -2037,103 +2284,24 @@ Returns the scheme used to store the private key. If the returned scheme is
-

nm_setting_802_1x_get_subject_match ()

-
const char *        nm_setting_802_1x_get_subject_match (NMSetting8021x *setting);
-

setting :

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

setting :

the NMSetting8021x -

Returns :

the "subject-match" property. This is the -substring to be matched against the subject of the authentication -server certificate, or NULL no subject verification is to be -performed.
-
-
-
-

nm_setting_802_1x_get_system_ca_certs ()

-
gboolean            nm_setting_802_1x_get_system_ca_certs
+

nm_setting_802_1x_get_private_key_blob ()

+
const GByteArray *  nm_setting_802_1x_get_private_key_blob
                                                         (NMSetting8021x *setting);

-Sets the "system-ca-certs" property. The -"ca-path" and "phase2-ca-path" -properties are ignored if the "system-ca-certs" property is -TRUE, in which case a system-wide CA certificate directory specified at -compile time (using the --system-ca-path configure option) is used in place -of these properties. -

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

setting :

the NMSetting8021x -

Returns :

TRUE if a system CA certificate path should be used, FALSE if not
-
-
-
-

nm_setting_802_1x_new ()

-
NMSetting *         nm_setting_802_1x_new               (void);
-

-Creates a new NMSetting8021x object with default values. -

-
-- - - - -

Returns :

the new empty NMSetting8021x object
-
-
-
-

nm_setting_802_1x_remove_altsubject_match ()

-
void                nm_setting_802_1x_remove_altsubject_match
-                                                        (NMSetting8021x *setting,
-                                                         guint32 i);
-

-Removes the allowed altSubjectName at the specified index. +Private keys are used to authenticate the connecting client to the network +when EAP-TLS is used as either the "phase 1" or "phase 2" 802.1x +authentication method.

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

setting :

the NMSetting8021x -

i :

the index of the altSubjectName match to remove
-
-
-
-

nm_setting_802_1x_remove_eap_method ()

-
void                nm_setting_802_1x_remove_eap_method (NMSetting8021x *setting,
-                                                         guint32 i);

-Removes the allowed EAP method at the specified index. +WARNING: the private key property is not a "secret" property, and thus +unencrypted private key data may be readable by unprivileged users. Private +keys should always be encrypted with a private key password.

-
+
+++ @@ -2141,23 +2309,27 @@ Removes the allowed EAP method at the specified index. - - + +

setting :

i :

the index of the EAP method to remove

Returns :

the private key data

-

nm_setting_802_1x_remove_phase2_altsubject_match ()

-
void                nm_setting_802_1x_remove_phase2_altsubject_match
-                                                        (NMSetting8021x *setting,
-                                                         guint32 i);
+

nm_setting_802_1x_get_private_key_path ()

+
const char *        nm_setting_802_1x_get_private_key_path
+                                                        (NMSetting8021x *setting);

-Removes the allowed "phase 2" altSubjectName at the specified index. +Private keys are used to authenticate the connecting client to the network +when EAP-TLS is used as either the "phase 1" or "phase 2" 802.1x +authentication method.

-
+
+++ @@ -2165,82 +2337,52 @@ Removes the allowed "phase 2" altSubjectName at the specified index. - - + +

setting :

i :

the index of the "phase 2" altSubjectName match to remove

Returns :

path to the private key file

-

nm_setting_802_1x_set_ca_cert ()

-
gboolean            nm_setting_802_1x_set_ca_cert       (NMSetting8021x *setting,
-                                                         const char *cert_path,
+

nm_setting_802_1x_set_private_key ()

+
gboolean            nm_setting_802_1x_set_private_key   (NMSetting8021x *setting,
+                                                         const char *key_path,
+                                                         const char *password,
                                                          NMSetting8021xCKScheme scheme,
                                                          NMSetting8021xCKFormat *out_format,
                                                          GError **error);

-Reads a certificate from disk and sets the "ca-cert" property -with the raw certificate data if using the NM_SETTING_802_1X_CK_SCHEME_BLOB -scheme, or with the path to the certificate file if using the -NM_SETTING_802_1X_CK_SCHEME_PATH scheme. +Private keys are used to authenticate the connecting client to the network +when EAP-TLS is used as either the "phase 1" or "phase 2" 802.1x +authentication method.

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

setting :

the NMSetting8021x -

cert_path :

when scheme is set to either NM_SETTING_802_1X_CK_SCHEME_PATH -or NM_SETTING_802_1X_CK_SCHEME_BLOB, pass the path of the CA certificate -file (PEM or DER format). The path must be UTF-8 encoded; use -g_filename_to_utf8() to convert if needed. Passing NULL with any scheme -clears the CA certificate.

scheme :

desired storage scheme for the certificate

out_format :

on successful return, the type of the certificate added

error :

on unsuccessful return, an error

Returns :

TRUE if the operation succeeded, FALSE if it was unsuccessful
-
-
-
-

nm_setting_802_1x_set_client_cert ()

-
gboolean            nm_setting_802_1x_set_client_cert   (NMSetting8021x *setting,
-                                                         const char *cert_path,
-                                                         NMSetting8021xCKScheme scheme,
-                                                         NMSetting8021xCKFormat *out_format,
-                                                         GError **error);

-Reads a certificate from disk and sets the "client-cert" -property with the raw certificate data if using the -NM_SETTING_802_1X_CK_SCHEME_BLOB scheme, or with the path to the certificate -file if using the NM_SETTING_802_1X_CK_SCHEME_PATH scheme. +This function reads a private key from disk and sets the +"private-key" property with the private key file data if using +the NM_SETTING_802_1X_CK_SCHEME_BLOB scheme, or with the path to the private +key file if using the NM_SETTING_802_1X_CK_SCHEME_PATH scheme.

-Client certificates are used to identify the connecting client to the network -when EAP-TLS is used as either the "phase 1" or "phase 2" 802.1x -authentication method. +If password is given, this function attempts to decrypt the private key to +verify that password is correct, and if it is, updates the +"private-key-password" property with the given password. If +the decryption is unsuccessful, FALSE is returned, error is set, and no +internal data is changed. If no password is given, the private key is +assumed to be valid, no decryption is performed, and the password may be set +at a later time. +

+

+WARNING: the private key property is not a "secret" property, and thus +unencrypted private key data using the BLOB scheme may be readable by +unprivileged users. Private keys should always be encrypted with a private +key password to prevent unauthorized access to unencrypted private key data.

-
+
+++ @@ -2248,20 +2390,26 @@ authentication method. - - + + + + + + - + - + @@ -2276,21 +2424,14 @@ any scheme clears the client certificate
-

nm_setting_802_1x_set_phase2_ca_cert ()

-
gboolean            nm_setting_802_1x_set_phase2_ca_cert
-                                                        (NMSetting8021x *setting,
-                                                         const char *cert_path,
-                                                         NMSetting8021xCKScheme scheme,
-                                                         NMSetting8021xCKFormat *out_format,
-                                                         GError **error);
-

-Reads a certificate from disk and sets the "phase2-ca-cert" -property with the raw certificate data if using the -NM_SETTING_802_1X_CK_SCHEME_BLOB scheme, or with the path to the certificate -file if using the NM_SETTING_802_1X_CK_SCHEME_PATH scheme. -

-

setting :

cert_path :

when scheme is set to either NM_SETTING_802_1X_CK_SCHEME_PATH -or NM_SETTING_802_1X_CK_SCHEME_BLOB, pass the path of the client -certificate file (PEM, DER, or PKCS12 format). The path must be UTF-8 -encoded; use g_filename_to_utf8() to convert if needed. Passing NULL with -any scheme clears the client certificate.

key_path :

when scheme is set to either NM_SETTING_802_1X_CK_SCHEME_PATH or +NM_SETTING_802_1X_CK_SCHEME_BLOB, pass the path of the private key file +(PEM, DER, or PKCS12 format). The path must be UTF-8 encoded; use +g_filename_to_utf8() to convert if needed. Passing NULL with any scheme +clears the private key.

password :

password used to decrypt the private key, or NULL if the password +is unknown. If the password is given but fails to decrypt the private key, +an error is returned.

scheme :

desired storage scheme for the certificatedesired storage scheme for the private key

out_format :

on successful return, the type of the certificate addedon successful return, the type of the private key added

error :

+

nm_setting_802_1x_get_private_key_password ()

+
const char *        nm_setting_802_1x_get_private_key_password
+                                                        (NMSetting8021x *setting);
+
+++ @@ -2298,54 +2439,80 @@ file if using the cert_path :

-
+ + + +

setting :

when scheme is set to either NM_SETTING_802_1X_CK_SCHEME_PATH -or NM_SETTING_802_1X_CK_SCHEME_BLOB, pass the path of the "phase2" CA -certificate file (PEM or DER format). The path must be UTF-8 encoded; use -g_filename_to_utf8() to convert if needed. Passing NULL with any scheme -clears the "phase2" CA certificate.

Returns :

the private key password used to decrypt the private key if +previously set with nm_setting_802_1x_set_private_key(), or the +"private-key-password" property.
+
+
+
+

nm_setting_802_1x_get_private_key_password_flags ()

+
NMSettingSecretFlags nm_setting_802_1x_get_private_key_password_flags
+                                                        (NMSetting8021x *setting);
+
++++ + - - + + - - + + + +

scheme :

desired storage scheme for the certificate

setting :

the NMSetting8021x +

out_format :

on successful return, the type of the certificate added

Returns :

the NMSettingSecretFlags pertaining to the +"private-key-password" +
+
+
+
+

nm_setting_802_1x_get_private_key_format ()

+
NMSetting8021xCKFormat nm_setting_802_1x_get_private_key_format
+                                                        (NMSetting8021x *setting);
+
++++ + - - + + - +

error :

on unsuccessful return, an error

setting :

the NMSetting8021x +

Returns :

TRUE if the operation succeeded, FALSE if it was unsuccessfulthe data format of the private key data stored in the +"private-key" property

-

nm_setting_802_1x_set_phase2_client_cert ()

-
gboolean            nm_setting_802_1x_set_phase2_client_cert
-                                                        (NMSetting8021x *setting,
-                                                         const char *cert_path,
-                                                         NMSetting8021xCKScheme scheme,
-                                                         NMSetting8021xCKFormat *out_format,
-                                                         GError **error);
-

-Reads a certificate from disk and sets the "phase2-client-cert" -property with the raw certificate data if using the -NM_SETTING_802_1X_CK_SCHEME_BLOB scheme, or with the path to the certificate -file if using the NM_SETTING_802_1X_CK_SCHEME_PATH scheme. -

+

nm_setting_802_1x_get_phase2_private_key_scheme ()

+
NMSetting8021xCKScheme nm_setting_802_1x_get_phase2_private_key_scheme
+                                                        (NMSetting8021x *setting);

-Client certificates are used to identify the connecting client to the network -when EAP-TLS is used as either the "phase 1" or "phase 2" 802.1x -authentication method. +Returns the scheme used to store the "phase 2" private key. If the returned +scheme is NM_SETTING_802_1X_CK_SCHEME_BLOB, use +nm_setting_802_1x_get_client_cert_blob(); if +NM_SETTING_802_1X_CK_SCHEME_PATH, use +nm_setting_802_1x_get_client_cert_path().

-
+
+++ @@ -2353,28 +2520,69 @@ authentication method. - - + + + +

setting :

cert_path :

when scheme is set to either NM_SETTING_802_1X_CK_SCHEME_PATH -or NM_SETTING_802_1X_CK_SCHEME_BLOB, pass the path of the "phase2" client -certificate file (PEM, DER, or PKCS12 format). The path must be UTF-8 -encoded; use g_filename_to_utf8() to convert if needed. Passing NULL with -any scheme clears the "phase2" client certificate.

Returns :

scheme used to store the "phase 2" private key (blob or path)
+
+
+
+

nm_setting_802_1x_get_phase2_private_key_blob ()

+
const GByteArray *  nm_setting_802_1x_get_phase2_private_key_blob
+                                                        (NMSetting8021x *setting);
+

+Private keys are used to authenticate the connecting client to the network +when EAP-TLS is used as either the "phase 1" or "phase 2" 802.1x +authentication method. +

+

+WARNING: the phase2 private key property is not a "secret" property, and thus +unencrypted private key data may be readable by unprivileged users. Private +keys should always be encrypted with a private key password. +

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

scheme :

desired storage scheme for the certificate

setting :

the NMSetting8021x +

out_format :

on successful return, the type of the certificate added

Returns :

the "phase 2" private key data
+
+
+
+

nm_setting_802_1x_get_phase2_private_key_path ()

+
const char *        nm_setting_802_1x_get_phase2_private_key_path
+                                                        (NMSetting8021x *setting);
+

+Private keys are used to authenticate the connecting client to the network +when EAP-TLS is used as either the "phase 1" or "phase 2" 802.1x +authentication method. +

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

error :

on unsuccessful return, an error

setting :

the NMSetting8021x +

Returns :

TRUE if the operation succeeded, FALSE if it was unsuccessfulpath to the "phase 2" private key file
@@ -2415,8 +2623,11 @@ thus unencrypted private key data using the BLOB scheme may be readable by unprivileged users. Private keys should always be encrypted with a private key password to prevent unauthorized access to unencrypted private key data.

-
+
+++ @@ -2428,12 +2639,12 @@ key password to prevent unauthorized access to unencrypted private key data. - @@ -2458,41 +2669,14 @@ an error is returned.
-

nm_setting_802_1x_set_private_key ()

-
gboolean            nm_setting_802_1x_set_private_key   (NMSetting8021x *setting,
-                                                         const char *key_path,
-                                                         const char *password,
-                                                         NMSetting8021xCKScheme scheme,
-                                                         NMSetting8021xCKFormat *out_format,
-                                                         GError **error);
-

-Private keys are used to authenticate the connecting client to the network -when EAP-TLS is used as either the "phase 1" or "phase 2" 802.1x -authentication method. -

-

-This function reads a private key from disk and sets the -"private-key" property with the private key file data if using -the NM_SETTING_802_1X_CK_SCHEME_BLOB scheme, or with the path to the private -key file if using the NM_SETTING_802_1X_CK_SCHEME_PATH scheme. -

-

-If password is given, this function attempts to decrypt the private key to -verify that password is correct, and if it is, updates the -"private-key-password" property with the given password. If -the decryption is unsuccessful, FALSE is returned, error is set, and no -internal data is changed. If no password is given, the private key is -assumed to be valid, no decryption is performed, and the password may be set -at a later time. -

-

-WARNING: the private key property is not a "secret" property, and thus -unencrypted private key data using the BLOB scheme may be readable by -unprivileged users. Private keys should always be encrypted with a private -key password to prevent unauthorized access to unencrypted private key data. -

-

setting :

when scheme is set to either NM_SETTING_802_1X_CK_SCHEME_PATH or NM_SETTING_802_1X_CK_SCHEME_BLOB, pass the path of the "phase2" private key file (PEM, DER, or PKCS12 format). The path must be UTF-8 encoded; -use g_filename_to_utf8() to convert if needed. Passing NULL with any +use g_filename_to_utf8() to convert if needed. Passing NULL with any scheme clears the private key.

password :

password used to decrypt the private key, or NULL if the password +password used to decrypt the private key, or NULL if the password is unknown. If the password is given but fails to decrypt the private key, an error is returned.
+

nm_setting_802_1x_get_phase2_private_key_password ()

+
const char *        nm_setting_802_1x_get_phase2_private_key_password
+                                                        (NMSetting8021x *setting);
+
+++ @@ -2500,34 +2684,59 @@ key password to prevent unauthorized access to unencrypted private key data. - - - - - - + + + +

setting :

key_path :

when scheme is set to either NM_SETTING_802_1X_CK_SCHEME_PATH or -NM_SETTING_802_1X_CK_SCHEME_BLOB, pass the path of the private key file -(PEM, DER, or PKCS12 format). The path must be UTF-8 encoded; use -g_filename_to_utf8() to convert if needed. Passing NULL with any scheme -clears the private key.

password :

password used to decrypt the private key, or NULL if the password -is unknown. If the password is given but fails to decrypt the private key, -an error is returned.

Returns :

the private key password used to decrypt the private key if +previously set with nm_setting_802_1x_set_phase2_private_key() or the +"phase2-private-key-password" property.
+
+
+
+

nm_setting_802_1x_get_phase2_private_key_password_flags ()

+
NMSettingSecretFlags nm_setting_802_1x_get_phase2_private_key_password_flags
+                                                        (NMSetting8021x *setting);
+
++++ + - - + + - - + + + +

scheme :

desired storage scheme for the private key

setting :

the NMSetting8021x +

out_format :

on successful return, the type of the private key added

Returns :

the NMSettingSecretFlags pertaining to the +"phase2-private-key-password" +
+
+
+
+

nm_setting_802_1x_get_phase2_private_key_format ()

+
NMSetting8021xCKFormat nm_setting_802_1x_get_phase2_private_key_format
+                                                        (NMSetting8021x *setting);
+
++++ + - - + + - +

error :

on unsuccessful return, an error

setting :

the NMSetting8021x +

Returns :

TRUE if the operation succeeded, FALSE if it was unsuccessfulthe data format of the "phase 2" private key data stored in the +"phase2-private-key" property
@@ -2825,6 +3034,25 @@ authentication server certificate's subject is performed.

+

The "pin" property

+
  "pin"                      gchar*                : Read / Write
+

+PIN used for EAP authentication methods. +

+

Default value: NULL

+
+
+
+

The "pin-flags" property

+
  "pin-flags"                guint                 : Read / Write
+

+Flags indicating how to handle "pin":. +

+

Allowed values: <= 7

+

Default value: 0

+
+
+

The "private-key" property

  "private-key"              GArray_guchar_*       : Read / Write

@@ -2894,6 +3122,6 @@ and

+ Generated by GTK-Doc V1.19
\ No newline at end of file diff --git a/docs/libnm-util/html/NMSettingAdsl.html b/docs/libnm-util/html/NMSettingAdsl.html index c7289a0a..761094b9 100644 --- a/docs/libnm-util/html/NMSettingAdsl.html +++ b/docs/libnm-util/html/NMSettingAdsl.html @@ -3,12 +3,12 @@ NMSettingAdsl - + - + @@ -44,45 +44,45 @@
 #include <nm-setting-adsl.h>
 
-                    NMSettingAdsl;
-                    NMSettingAdslClass;
+#define             NM_SETTING_ADSL_SETTING_NAME
 enum                NMSettingAdslError;
-#define             NM_SETTING_ADSL_ENCAPSULATION
-#define             NM_SETTING_ADSL_ENCAPSULATION_LLC
-#define             NM_SETTING_ADSL_ENCAPSULATION_VCMUX
 #define             NM_SETTING_ADSL_ERROR
+GQuark              nm_setting_adsl_error_quark         (void);
+#define             NM_SETTING_ADSL_USERNAME
 #define             NM_SETTING_ADSL_PASSWORD
 #define             NM_SETTING_ADSL_PASSWORD_FLAGS
 #define             NM_SETTING_ADSL_PROTOCOL
-#define             NM_SETTING_ADSL_PROTOCOL_IPOATM
+#define             NM_SETTING_ADSL_ENCAPSULATION
+#define             NM_SETTING_ADSL_VPI
+#define             NM_SETTING_ADSL_VCI
 #define             NM_SETTING_ADSL_PROTOCOL_PPPOA
 #define             NM_SETTING_ADSL_PROTOCOL_PPPOE
-#define             NM_SETTING_ADSL_SETTING_NAME
-#define             NM_SETTING_ADSL_USERNAME
-#define             NM_SETTING_ADSL_VCI
-#define             NM_SETTING_ADSL_VPI
-GQuark              nm_setting_adsl_error_quark         (void);
-const char *        nm_setting_adsl_get_encapsulation   (NMSettingAdsl *setting);
+#define             NM_SETTING_ADSL_PROTOCOL_IPOATM
+#define             NM_SETTING_ADSL_ENCAPSULATION_VCMUX
+#define             NM_SETTING_ADSL_ENCAPSULATION_LLC
+                    NMSettingAdsl;
+                    NMSettingAdslClass;
+NMSetting *         nm_setting_adsl_new                 (void);
+const char *        nm_setting_adsl_get_username        (NMSettingAdsl *setting);
 const char *        nm_setting_adsl_get_password        (NMSettingAdsl *setting);
-NMSettingSecretFlags nm_setting_adsl_get_password_flags (NMSettingAdsl *setting);
 const char *        nm_setting_adsl_get_protocol        (NMSettingAdsl *setting);
-const char *        nm_setting_adsl_get_username        (NMSettingAdsl *setting);
-guint32             nm_setting_adsl_get_vci             (NMSettingAdsl *setting);
+const char *        nm_setting_adsl_get_encapsulation   (NMSettingAdsl *setting);
 guint32             nm_setting_adsl_get_vpi             (NMSettingAdsl *setting);
-NMSetting *         nm_setting_adsl_new                 (void);
+guint32             nm_setting_adsl_get_vci             (NMSettingAdsl *setting);
+NMSettingSecretFlags nm_setting_adsl_get_password_flags (NMSettingAdsl *setting);
 

Object Hierarchy

+
+  GEnum
+   +----NMSettingAdslError
+
   GObject
    +----NMSetting
          +----NMSettingAdsl
 
-
-  GEnum
-   +----NMSettingAdslError
-

Properties

@@ -106,23 +106,8 @@ properties of ADSL connections.

Details

-

NMSettingAdsl

-
typedef struct _NMSettingAdsl NMSettingAdsl;
-

-

-
-
-
-

NMSettingAdslClass

-
typedef struct {
-	NMSettingClass parent;
-
-	/* Padding for future expansion */
-	void (*_reserved1) (void);
-	void (*_reserved2) (void);
-	void (*_reserved3) (void);
-	void (*_reserved4) (void);
-} NMSettingAdslClass;
+

NM_SETTING_ADSL_SETTING_NAME

+
#define NM_SETTING_ADSL_SETTING_NAME "adsl"
 

@@ -136,8 +121,11 @@ properties of ADSL connections. NM_SETTING_ADSL_ERROR_MISSING_PROPERTY /*< nick=MissingProperty >*/ } NMSettingAdslError;
-
+
+++ @@ -160,64 +148,82 @@ required
-

NM_SETTING_ADSL_ENCAPSULATION

-
#define NM_SETTING_ADSL_ENCAPSULATION       "encapsulation"
+

NM_SETTING_ADSL_ERROR

+
#define NM_SETTING_ADSL_ERROR nm_setting_adsl_error_quark ()
 


-

NM_SETTING_ADSL_ENCAPSULATION_LLC

-
#define NM_SETTING_ADSL_ENCAPSULATION_LLC   "llc"
+

nm_setting_adsl_error_quark ()

+
GQuark              nm_setting_adsl_error_quark         (void);
+

+Registers an error quark for NMSettingAdsl if necessary. +

+

NM_SETTING_ADSL_ERROR_UNKNOWN

++++ + + + + +

Returns :

the error quark used for NMSettingAdsl errors.
+
+
+
+

NM_SETTING_ADSL_USERNAME

+
#define NM_SETTING_ADSL_USERNAME            "username"
 


-

NM_SETTING_ADSL_ENCAPSULATION_VCMUX

-
#define NM_SETTING_ADSL_ENCAPSULATION_VCMUX "vcmux"
+

NM_SETTING_ADSL_PASSWORD

+
#define NM_SETTING_ADSL_PASSWORD            "password"
 


-

NM_SETTING_ADSL_ERROR

-
#define NM_SETTING_ADSL_ERROR nm_setting_adsl_error_quark ()
+

NM_SETTING_ADSL_PASSWORD_FLAGS

+
#define NM_SETTING_ADSL_PASSWORD_FLAGS      "password-flags"
 


-

NM_SETTING_ADSL_PASSWORD

-
#define NM_SETTING_ADSL_PASSWORD            "password"
+

NM_SETTING_ADSL_PROTOCOL

+
#define NM_SETTING_ADSL_PROTOCOL            "protocol"
 


-

NM_SETTING_ADSL_PASSWORD_FLAGS

-
#define NM_SETTING_ADSL_PASSWORD_FLAGS      "password-flags"
+

NM_SETTING_ADSL_ENCAPSULATION

+
#define NM_SETTING_ADSL_ENCAPSULATION       "encapsulation"
 


-

NM_SETTING_ADSL_PROTOCOL

-
#define NM_SETTING_ADSL_PROTOCOL            "protocol"
+

NM_SETTING_ADSL_VPI

+
#define NM_SETTING_ADSL_VPI                 "vpi"
 


-

NM_SETTING_ADSL_PROTOCOL_IPOATM

-
#define NM_SETTING_ADSL_PROTOCOL_IPOATM     "ipoatm"
+

NM_SETTING_ADSL_VCI

+
#define NM_SETTING_ADSL_VCI                 "vci"
 

@@ -240,57 +246,78 @@ required

-

NM_SETTING_ADSL_SETTING_NAME

-
#define NM_SETTING_ADSL_SETTING_NAME "adsl"
+

NM_SETTING_ADSL_PROTOCOL_IPOATM

+
#define NM_SETTING_ADSL_PROTOCOL_IPOATM     "ipoatm"
 


-

NM_SETTING_ADSL_USERNAME

-
#define NM_SETTING_ADSL_USERNAME            "username"
+

NM_SETTING_ADSL_ENCAPSULATION_VCMUX

+
#define NM_SETTING_ADSL_ENCAPSULATION_VCMUX "vcmux"
 


-

NM_SETTING_ADSL_VCI

-
#define NM_SETTING_ADSL_VCI                 "vci"
+

NM_SETTING_ADSL_ENCAPSULATION_LLC

+
#define NM_SETTING_ADSL_ENCAPSULATION_LLC   "llc"
 


-

NM_SETTING_ADSL_VPI

-
#define NM_SETTING_ADSL_VPI                 "vpi"
+

NMSettingAdsl

+
typedef struct _NMSettingAdsl NMSettingAdsl;
+

+

+
+
+
+

NMSettingAdslClass

+
typedef struct {
+	NMSettingClass parent;
+
+	/* Padding for future expansion */
+	void (*_reserved1) (void);
+	void (*_reserved2) (void);
+	void (*_reserved3) (void);
+	void (*_reserved4) (void);
+} NMSettingAdslClass;
 


-

nm_setting_adsl_error_quark ()

-
GQuark              nm_setting_adsl_error_quark         (void);
+

nm_setting_adsl_new ()

+
NMSetting *         nm_setting_adsl_new                 (void);

-Registers an error quark for NMSettingAdsl if necessary. +Creates a new NMSettingAdsl object with default values.

-
+
+++ - +

Returns :

the error quark used for NMSettingAdsl errors.the new empty NMSettingAdsl object

-

nm_setting_adsl_get_encapsulation ()

-
const char *        nm_setting_adsl_get_encapsulation   (NMSettingAdsl *setting);
-
+

nm_setting_adsl_get_username ()

+
const char *        nm_setting_adsl_get_username        (NMSettingAdsl *setting);
+
+++ @@ -299,7 +326,7 @@ Registers an error quark for Returns :

-
+

setting :

the "encapsulation" property of the settingthe "username" property of the setting
@@ -308,8 +335,11 @@ Registers an error quark for

nm_setting_adsl_get_password ()

const char *        nm_setting_adsl_get_password        (NMSettingAdsl *setting);
-
+
+++ @@ -325,10 +355,13 @@ Registers an error quark for -

nm_setting_adsl_get_password_flags ()

-
NMSettingSecretFlags nm_setting_adsl_get_password_flags (NMSettingAdsl *setting);
-

setting :

+

nm_setting_adsl_get_protocol ()

+
const char *        nm_setting_adsl_get_protocol        (NMSettingAdsl *setting);
+
+++ @@ -337,18 +370,20 @@ Registers an error quark for Returns :

-
+

setting :

the NMSettingSecretFlags pertaining to the "password" -the "protocol" property of the setting

-

nm_setting_adsl_get_protocol ()

-
const char *        nm_setting_adsl_get_protocol        (NMSettingAdsl *setting);
-
+

nm_setting_adsl_get_encapsulation ()

+
const char *        nm_setting_adsl_get_encapsulation   (NMSettingAdsl *setting);
+
+++ @@ -357,17 +392,20 @@ Registers an error quark for Returns :

-
+

setting :

the "protocol" property of the settingthe "encapsulation" property of the setting

-

nm_setting_adsl_get_username ()

-
const char *        nm_setting_adsl_get_username        (NMSettingAdsl *setting);
-
+

nm_setting_adsl_get_vpi ()

+
guint32             nm_setting_adsl_get_vpi             (NMSettingAdsl *setting);
+
+++ @@ -376,7 +414,7 @@ Registers an error quark for Returns :

-
+

setting :

the "username" property of the settingthe "vpi" property of the setting
@@ -385,8 +423,11 @@ Registers an error quark for

nm_setting_adsl_get_vci ()

guint32             nm_setting_adsl_get_vci             (NMSettingAdsl *setting);
-
+
+++ @@ -402,10 +443,13 @@ Registers an error quark for -

nm_setting_adsl_get_vpi ()

-
guint32             nm_setting_adsl_get_vpi             (NMSettingAdsl *setting);
-

setting :

+

nm_setting_adsl_get_password_flags ()

+
NMSettingSecretFlags nm_setting_adsl_get_password_flags (NMSettingAdsl *setting);
+
+++ @@ -414,26 +458,12 @@ Registers an error quark for Returns :

-
+

setting :

the "vpi" property of the settingthe NMSettingSecretFlags pertaining to the "password" +
-
-
-

nm_setting_adsl_new ()

-
NMSetting *         nm_setting_adsl_new                 (void);
-

-Creates a new NMSettingAdsl object with default values. -

-
-- - - - -

Returns :

the new empty NMSettingAdsl object
-

Property Details

@@ -506,6 +536,6 @@ ADSL connection vpi.
+ Generated by GTK-Doc V1.19
\ No newline at end of file diff --git a/docs/libnm-util/html/NMSettingBluetooth.html b/docs/libnm-util/html/NMSettingBluetooth.html index e2f39011..388ae5e7 100644 --- a/docs/libnm-util/html/NMSettingBluetooth.html +++ b/docs/libnm-util/html/NMSettingBluetooth.html @@ -3,12 +3,12 @@ NMSettingBluetooth - + - + @@ -44,33 +44,33 @@
 #include <nm-setting-bluetooth.h>
 
-                    NMSettingBluetooth;
-                    NMSettingBluetoothClass;
+#define             NM_SETTING_BLUETOOTH_SETTING_NAME
 enum                NMSettingBluetoothError;
-#define             NM_SETTING_BLUETOOTH_BDADDR
 #define             NM_SETTING_BLUETOOTH_ERROR
-#define             NM_SETTING_BLUETOOTH_SETTING_NAME
+GQuark              nm_setting_bluetooth_error_quark    (void);
+#define             NM_SETTING_BLUETOOTH_BDADDR
 #define             NM_SETTING_BLUETOOTH_TYPE
 #define             NM_SETTING_BLUETOOTH_TYPE_DUN
 #define             NM_SETTING_BLUETOOTH_TYPE_PANU
-GQuark              nm_setting_bluetooth_error_quark    (void);
+                    NMSettingBluetooth;
+                    NMSettingBluetoothClass;
+NMSetting *         nm_setting_bluetooth_new            (void);
 const GByteArray *  nm_setting_bluetooth_get_bdaddr     (NMSettingBluetooth *setting);
 const char *        nm_setting_bluetooth_get_connection_type
                                                         (NMSettingBluetooth *setting);
-NMSetting *         nm_setting_bluetooth_new            (void);
 

Object Hierarchy

+
+  GEnum
+   +----NMSettingBluetoothError
+
   GObject
    +----NMSetting
          +----NMSettingBluetooth
 
-
-  GEnum
-   +----NMSettingBluetoothError
-

Properties

@@ -91,23 +91,8 @@ Point (NAP) profiles.

Details

-

NMSettingBluetooth

-
typedef struct _NMSettingBluetooth NMSettingBluetooth;
-

-

-
-
-
-

NMSettingBluetoothClass

-
typedef struct {
-	NMSettingClass parent;
-
-	/* Padding for future expansion */
-	void (*_reserved1) (void);
-	void (*_reserved2) (void);
-	void (*_reserved3) (void);
-	void (*_reserved4) (void);
-} NMSettingBluetoothClass;
+

NM_SETTING_BLUETOOTH_SETTING_NAME

+
#define NM_SETTING_BLUETOOTH_SETTING_NAME "bluetooth"
 

@@ -122,8 +107,11 @@ Point (NAP) profiles. NM_SETTING_BLUETOOTH_ERROR_TYPE_SETTING_NOT_FOUND, /*< nick=TypeSettingNotFound >*/ } NMSettingBluetoothError;
-
+
+++ @@ -153,24 +141,34 @@ must also contain an -

NM_SETTING_BLUETOOTH_BDADDR

-
#define NM_SETTING_BLUETOOTH_BDADDR    "bdaddr"
+

NM_SETTING_BLUETOOTH_ERROR

+
#define NM_SETTING_BLUETOOTH_ERROR nm_setting_bluetooth_error_quark ()
 


-

NM_SETTING_BLUETOOTH_ERROR

-
#define NM_SETTING_BLUETOOTH_ERROR nm_setting_bluetooth_error_quark ()
-
+

nm_setting_bluetooth_error_quark ()

+
GQuark              nm_setting_bluetooth_error_quark    (void);

+Registers an error quark for NMSettingBluetooth if necessary.

+

NM_SETTING_BLUETOOTH_ERROR_UNKNOWN

++++ + + + + +

Returns :

the error quark used for NMSettingBluetooth errors.

-

NM_SETTING_BLUETOOTH_SETTING_NAME

-
#define NM_SETTING_BLUETOOTH_SETTING_NAME "bluetooth"
+

NM_SETTING_BLUETOOTH_BDADDR

+
#define NM_SETTING_BLUETOOTH_BDADDR    "bdaddr"
 

@@ -205,16 +203,43 @@ NAP (Network Access Point) protocol, which accepts connections via PANU.

-

nm_setting_bluetooth_error_quark ()

-
GQuark              nm_setting_bluetooth_error_quark    (void);
+

NMSettingBluetooth

+
typedef struct _NMSettingBluetooth NMSettingBluetooth;
+

+

+
+
+
+

NMSettingBluetoothClass

+
typedef struct {
+	NMSettingClass parent;
+
+	/* Padding for future expansion */
+	void (*_reserved1) (void);
+	void (*_reserved2) (void);
+	void (*_reserved3) (void);
+	void (*_reserved4) (void);
+} NMSettingBluetoothClass;
+

-Registers an error quark for NMSettingBluetooth if necessary.

-
+ +
+
+

nm_setting_bluetooth_new ()

+
NMSetting *         nm_setting_bluetooth_new            (void);
+

+Creates a new NMSettingBluetooth object with default values. +

+
+++ - +

Returns :

the error quark used for NMSettingBluetooth errors.the new empty NMSettingBluetooth object. [transfer full] +
@@ -226,8 +251,11 @@ Registers an error quark for -
+
+++ @@ -250,8 +278,11 @@ describes a connection to. Returns the connection method for communicating with the remote device (i.e. either DUN to a DUN-capable device or PANU to a NAP-capable device).

-

setting :

+
+++ @@ -266,22 +297,6 @@ either DUN to a DUN-capable device or PANU to a NAP-capable device).

setting :

-
-
-

nm_setting_bluetooth_new ()

-
NMSetting *         nm_setting_bluetooth_new            (void);
-

-Creates a new NMSettingBluetooth object with default values. -

-
-- - - - -

Returns :

the new empty NMSettingBluetooth object. [transfer full] -
-

Property Details

@@ -306,6 +321,6 @@ Area Networking connections to devices supporting the NAP profile.
+ Generated by GTK-Doc V1.19
\ No newline at end of file diff --git a/docs/libnm-util/html/NMSettingBond.html b/docs/libnm-util/html/NMSettingBond.html index ff77e102..89c6fe25 100644 --- a/docs/libnm-util/html/NMSettingBond.html +++ b/docs/libnm-util/html/NMSettingBond.html @@ -3,12 +3,12 @@ NMSettingBond - + - + @@ -44,23 +44,21 @@
 #include <nm-setting-bond.h>
 
-                    NMSettingBond;
-                    NMSettingBondClass;
+#define             NM_SETTING_BOND_SETTING_NAME
 enum                NMSettingBondError;
 #define             NM_SETTING_BOND_ERROR
+GQuark              nm_setting_bond_error_quark         (void);
 #define             NM_SETTING_BOND_INTERFACE_NAME
 #define             NM_SETTING_BOND_OPTIONS
-#define             NM_SETTING_BOND_OPTION_ARP_INTERVAL
-#define             NM_SETTING_BOND_OPTION_ARP_IP_TARGET
-#define             NM_SETTING_BOND_OPTION_DOWNDELAY
-#define             NM_SETTING_BOND_OPTION_MIIMON
 #define             NM_SETTING_BOND_OPTION_MODE
+#define             NM_SETTING_BOND_OPTION_MIIMON
+#define             NM_SETTING_BOND_OPTION_DOWNDELAY
 #define             NM_SETTING_BOND_OPTION_UPDELAY
-#define             NM_SETTING_BOND_SETTING_NAME
-gboolean            nm_setting_bond_add_option          (NMSettingBond *setting,
-                                                         const char *name,
-                                                         const char *value);
-GQuark              nm_setting_bond_error_quark         (void);
+#define             NM_SETTING_BOND_OPTION_ARP_INTERVAL
+#define             NM_SETTING_BOND_OPTION_ARP_IP_TARGET
+                    NMSettingBond;
+                    NMSettingBondClass;
+NMSetting *         nm_setting_bond_new                 (void);
 const char *        nm_setting_bond_get_interface_name  (NMSettingBond *setting);
 guint32             nm_setting_bond_get_num_options     (NMSettingBond *setting);
 gboolean            nm_setting_bond_get_option          (NMSettingBond *setting,
@@ -69,25 +67,27 @@ const char *        const char **out_value);
 const char *        nm_setting_bond_get_option_by_name  (NMSettingBond *setting,
                                                          const char *name);
-const char *        nm_setting_bond_get_option_default  (NMSettingBond *setting,
+gboolean            nm_setting_bond_add_option          (NMSettingBond *setting,
+                                                         const char *name,
+                                                         const char *value);
+gboolean            nm_setting_bond_remove_option       (NMSettingBond *setting,
                                                          const char *name);
 const char **       nm_setting_bond_get_valid_options   (NMSettingBond *setting);
-NMSetting *         nm_setting_bond_new                 (void);
-gboolean            nm_setting_bond_remove_option       (NMSettingBond *setting,
+const char *        nm_setting_bond_get_option_default  (NMSettingBond *setting,
                                                          const char *name);
 

Object Hierarchy

+
+  GEnum
+   +----NMSettingBondError
+
   GObject
    +----NMSetting
          +----NMSettingBond
 
-
-  GEnum
-   +----NMSettingBondError
-

Properties

@@ -106,23 +106,8 @@ necessary for bond connections.

Details

-

NMSettingBond

-
typedef struct _NMSettingBond NMSettingBond;
-

-

-
-
-
-

NMSettingBondClass

-
typedef struct {
-	NMSettingClass parent;
-
-	/* Padding for future expansion */
-	void (*_reserved1) (void);
-	void (*_reserved2) (void);
-	void (*_reserved3) (void);
-	void (*_reserved4) (void);
-} NMSettingBondClass;
+

NM_SETTING_BOND_SETTING_NAME

+
#define NM_SETTING_BOND_SETTING_NAME "bond"
 

@@ -138,8 +123,11 @@ necessary for bond connections. NM_SETTING_BOND_ERROR_MISSING_OPTION, /*< nick=MissingOption >*/ } NMSettingBondError;
-
+
+++ @@ -180,6 +168,24 @@ required
+

nm_setting_bond_error_quark ()

+
GQuark              nm_setting_bond_error_quark         (void);
+

+Registers an error quark for NMSettingBond if necessary. +

+

NM_SETTING_BOND_ERROR_UNKNOWN

++++ + + + + +

Returns :

the error quark used for NMSettingBond errors.
+
+
+

NM_SETTING_BOND_INTERFACE_NAME

#define NM_SETTING_BOND_INTERFACE_NAME "interface-name"
 
@@ -196,16 +202,16 @@ required

-

NM_SETTING_BOND_OPTION_ARP_INTERVAL

-
#define NM_SETTING_BOND_OPTION_ARP_INTERVAL  "arp_interval"
+

NM_SETTING_BOND_OPTION_MODE

+
#define NM_SETTING_BOND_OPTION_MODE          "mode"
 


-

NM_SETTING_BOND_OPTION_ARP_IP_TARGET

-
#define NM_SETTING_BOND_OPTION_ARP_IP_TARGET "arp_ip_target"
+

NM_SETTING_BOND_OPTION_MIIMON

+
#define NM_SETTING_BOND_OPTION_MIIMON        "miimon"
 

@@ -220,85 +226,67 @@ required

-

NM_SETTING_BOND_OPTION_MIIMON

-
#define NM_SETTING_BOND_OPTION_MIIMON        "miimon"
+

NM_SETTING_BOND_OPTION_UPDELAY

+
#define NM_SETTING_BOND_OPTION_UPDELAY       "updelay"
 


-

NM_SETTING_BOND_OPTION_MODE

-
#define NM_SETTING_BOND_OPTION_MODE          "mode"
+

NM_SETTING_BOND_OPTION_ARP_INTERVAL

+
#define NM_SETTING_BOND_OPTION_ARP_INTERVAL  "arp_interval"
 


-

NM_SETTING_BOND_OPTION_UPDELAY

-
#define NM_SETTING_BOND_OPTION_UPDELAY       "updelay"
+

NM_SETTING_BOND_OPTION_ARP_IP_TARGET

+
#define NM_SETTING_BOND_OPTION_ARP_IP_TARGET "arp_ip_target"
 


-

NM_SETTING_BOND_SETTING_NAME

-
#define NM_SETTING_BOND_SETTING_NAME "bond"
-
+

NMSettingBond

+
typedef struct _NMSettingBond NMSettingBond;


-

nm_setting_bond_add_option ()

-
gboolean            nm_setting_bond_add_option          (NMSettingBond *setting,
-                                                         const char *name,
-                                                         const char *value);
+

NMSettingBondClass

+
typedef struct {
+	NMSettingClass parent;
+
+	/* Padding for future expansion */
+	void (*_reserved1) (void);
+	void (*_reserved2) (void);
+	void (*_reserved3) (void);
+	void (*_reserved4) (void);
+} NMSettingBondClass;
+

-Add an option to the table. The option is compared to an internal list -of allowed options. Option names may contain only alphanumeric characters -(ie [a-zA-Z0-9]). Adding a new name replaces any existing name/value pair -that may already exist.

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

setting :

the NMSettingBond -

name :

name for the option

value :

value for the option

Returns :

-TRUE if the option was valid and was added to the internal option -list, FALSE if it was not.

-

nm_setting_bond_error_quark ()

-
GQuark              nm_setting_bond_error_quark         (void);
+

nm_setting_bond_new ()

+
NMSetting *         nm_setting_bond_new                 (void);

-Registers an error quark for NMSettingBond if necessary. +Creates a new NMSettingBond object with default values.

-
+
+++ - +

Returns :

the error quark used for NMSettingBond errors.the new empty NMSettingBond object. [transfer full] +
@@ -306,8 +294,11 @@ Registers an error quark for

nm_setting_bond_get_interface_name ()

const char *        nm_setting_bond_get_interface_name  (NMSettingBond *setting);
-
+
+++ @@ -330,8 +321,11 @@ Returns the number of options that should be set for this bond when it is activated. This can be used to retrieve each option individually using nm_setting_bond_get_option().

-

setting :

+
+++ @@ -359,8 +353,11 @@ are *not* guaranteed to be static across modifications to options done by and should not be used to refer to options except for short periods of time such as during option iteration.

-

setting :

+
+++ @@ -403,8 +400,11 @@ currently held by the setting) Returns the value associated with the bonding option specified by name, if it exists.

-

setting :

+
+++ @@ -417,7 +417,7 @@ Returns the value associated with the bonding option specified by - @@ -425,11 +425,21 @@ setting; the value is owned by the setting and must not be modified
-

nm_setting_bond_get_option_default ()

-
const char *        nm_setting_bond_get_option_default  (NMSettingBond *setting,
-                                                         const char *name);
-

setting :

Returns :

the value, or NULL if the key/value pair was never added to the +the value, or NULL if the key/value pair was never added to the setting; the value is owned by the setting and must not be modified
+

nm_setting_bond_add_option ()

+
gboolean            nm_setting_bond_add_option          (NMSettingBond *setting,
+                                                         const char *name,
+                                                         const char *value);
+

+Add an option to the table. The option is compared to an internal list +of allowed options. Option names may contain only alphanumeric characters +(ie [a-zA-Z0-9]). Adding a new name replaces any existing name/value pair +that may already exist. +

+
+++ @@ -438,25 +448,35 @@ setting; the value is owned by the setting and must not be modified - + + + + + - +

setting :

name :

the name of the optionname for the option

value :

value for the option

Returns :

the value of the bond option if not overridden by an entry in -the "options" property. +TRUE if the option was valid and was added to the internal option +list, FALSE if it was not.

-

nm_setting_bond_get_valid_options ()

-
const char **       nm_setting_bond_get_valid_options   (NMSettingBond *setting);
+

nm_setting_bond_remove_option ()

+
gboolean            nm_setting_bond_remove_option       (NMSettingBond *setting,
+                                                         const char *name);

-Returns a list of valid bond options. +Remove the bonding option referenced by name from the internal option +list.

-
+
+++ @@ -464,40 +484,54 @@ Returns a list of valid bond options. + + + + - +

setting :

name :

name of the option to remove

Returns :

a NULL-terminated array of strings of valid bond options. [transfer none] - +TRUE if the option was found and removed from the internal option +list, FALSE if it was not.

-

nm_setting_bond_new ()

-
NMSetting *         nm_setting_bond_new                 (void);
+

nm_setting_bond_get_valid_options ()

+
const char **       nm_setting_bond_get_valid_options   (NMSettingBond *setting);

-Creates a new NMSettingBond object with default values. +Returns a list of valid bond options.

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

setting :

the NMSettingBond +

Returns :

the new empty NMSettingBond object. [transfer full] +a NULL-terminated array of strings of valid bond options. [transfer none]

-

nm_setting_bond_remove_option ()

-
gboolean            nm_setting_bond_remove_option       (NMSettingBond *setting,
+

nm_setting_bond_get_option_default ()

+
const char *        nm_setting_bond_get_option_default  (NMSettingBond *setting,
                                                          const char *name);
-

-Remove the bonding option referenced by name from the internal option -list. -

-
+
+++ @@ -506,13 +540,12 @@ list. - + - +

setting :

name :

name of the option to removethe name of the option

Returns :

-TRUE if the option was found and removed from the internal option -list, FALSE if it was not.the value of the bond option if not overridden by an entry in +the "options" property.
@@ -542,6 +575,6 @@ alphanumeric characters (ie, [a-zA-Z0-9]).
+ Generated by GTK-Doc V1.19
\ No newline at end of file diff --git a/docs/libnm-util/html/NMSettingBridge.html b/docs/libnm-util/html/NMSettingBridge.html index e7d071be..b5a9742c 100644 --- a/docs/libnm-util/html/NMSettingBridge.html +++ b/docs/libnm-util/html/NMSettingBridge.html @@ -3,12 +3,12 @@ NMSettingBridge - + - + @@ -44,41 +44,41 @@
 #include <nm-setting-bridge.h>
 
-                    NMSettingBridge;
-                    NMSettingBridgeClass;
+#define             NM_SETTING_BRIDGE_SETTING_NAME
 enum                NMSettingBridgeError;
-#define             NM_SETTING_BRIDGE_AGEING_TIME
 #define             NM_SETTING_BRIDGE_ERROR
+GQuark              nm_setting_bridge_error_quark       (void);
+#define             NM_SETTING_BRIDGE_INTERFACE_NAME
+#define             NM_SETTING_BRIDGE_STP
+#define             NM_SETTING_BRIDGE_PRIORITY
 #define             NM_SETTING_BRIDGE_FORWARD_DELAY
 #define             NM_SETTING_BRIDGE_HELLO_TIME
-#define             NM_SETTING_BRIDGE_INTERFACE_NAME
 #define             NM_SETTING_BRIDGE_MAX_AGE
-#define             NM_SETTING_BRIDGE_PRIORITY
-#define             NM_SETTING_BRIDGE_SETTING_NAME
-#define             NM_SETTING_BRIDGE_STP
-GQuark              nm_setting_bridge_error_quark       (void);
-guint32             nm_setting_bridge_get_ageing_time   (NMSettingBridge *setting);
-guint16             nm_setting_bridge_get_forward_delay (NMSettingBridge *setting);
-guint16             nm_setting_bridge_get_hello_time    (NMSettingBridge *setting);
+#define             NM_SETTING_BRIDGE_AGEING_TIME
+                    NMSettingBridge;
+                    NMSettingBridgeClass;
+NMSetting *         nm_setting_bridge_new               (void);
 const char *        nm_setting_bridge_get_interface_name
                                                         (NMSettingBridge *setting);
-guint16             nm_setting_bridge_get_max_age       (NMSettingBridge *setting);
-guint16             nm_setting_bridge_get_priority      (NMSettingBridge *setting);
 gboolean            nm_setting_bridge_get_stp           (NMSettingBridge *setting);
-NMSetting *         nm_setting_bridge_new               (void);
+guint16             nm_setting_bridge_get_priority      (NMSettingBridge *setting);
+guint16             nm_setting_bridge_get_forward_delay (NMSettingBridge *setting);
+guint16             nm_setting_bridge_get_hello_time    (NMSettingBridge *setting);
+guint16             nm_setting_bridge_get_max_age       (NMSettingBridge *setting);
+guint32             nm_setting_bridge_get_ageing_time   (NMSettingBridge *setting);
 

Object Hierarchy

+
+  GEnum
+   +----NMSettingBridgeError
+
   GObject
    +----NMSetting
          +----NMSettingBridge
 
-
-  GEnum
-   +----NMSettingBridgeError
-

Properties

@@ -102,23 +102,8 @@ necessary for bridging connections.

Details

-

NMSettingBridge

-
typedef struct _NMSettingBridge NMSettingBridge;
-

-

-
-
-
-

NMSettingBridgeClass

-
typedef struct {
-	NMSettingClass parent;
-
-	/* Padding for future expansion */
-	void (*_reserved1) (void);
-	void (*_reserved2) (void);
-	void (*_reserved3) (void);
-	void (*_reserved4) (void);
-} NMSettingBridgeClass;
+

NM_SETTING_BRIDGE_SETTING_NAME

+
#define NM_SETTING_BRIDGE_SETTING_NAME "bridge"
 

@@ -132,8 +117,11 @@ necessary for bridging connections. NM_SETTING_BRIDGE_ERROR_MISSING_PROPERTY, /*< nick=MissingProperty >*/ } NMSettingBridgeError;
-
+
+++ @@ -157,40 +145,67 @@ required
-

NM_SETTING_BRIDGE_AGEING_TIME

-
#define NM_SETTING_BRIDGE_AGEING_TIME    "ageing-time"
+

NM_SETTING_BRIDGE_ERROR

+
#define NM_SETTING_BRIDGE_ERROR nm_setting_bridge_error_quark ()
 


-

NM_SETTING_BRIDGE_ERROR

-
#define NM_SETTING_BRIDGE_ERROR nm_setting_bridge_error_quark ()
+

nm_setting_bridge_error_quark ()

+
GQuark              nm_setting_bridge_error_quark       (void);
+

+Registers an error quark for NMSettingBridge if necessary. +

+

NM_SETTING_BRIDGE_ERROR_UNKNOWN

++++ + + + + +

Returns :

the error quark used for NMSettingBridge errors.
+

Since 0.9.8

+
+
+
+

NM_SETTING_BRIDGE_INTERFACE_NAME

+
#define NM_SETTING_BRIDGE_INTERFACE_NAME "interface-name"
 


-

NM_SETTING_BRIDGE_FORWARD_DELAY

-
#define NM_SETTING_BRIDGE_FORWARD_DELAY  "forward-delay"
+

NM_SETTING_BRIDGE_STP

+
#define NM_SETTING_BRIDGE_STP            "stp"
 


-

NM_SETTING_BRIDGE_HELLO_TIME

-
#define NM_SETTING_BRIDGE_HELLO_TIME     "hello-time"
+

NM_SETTING_BRIDGE_PRIORITY

+
#define NM_SETTING_BRIDGE_PRIORITY       "priority"
 


-

NM_SETTING_BRIDGE_INTERFACE_NAME

-
#define NM_SETTING_BRIDGE_INTERFACE_NAME "interface-name"
+

NM_SETTING_BRIDGE_FORWARD_DELAY

+
#define NM_SETTING_BRIDGE_FORWARD_DELAY  "forward-delay"
+
+

+

+
+
+
+

NM_SETTING_BRIDGE_HELLO_TIME

+
#define NM_SETTING_BRIDGE_HELLO_TIME     "hello-time"
 

@@ -205,50 +220,65 @@ required

-

NM_SETTING_BRIDGE_PRIORITY

-
#define NM_SETTING_BRIDGE_PRIORITY       "priority"
+

NM_SETTING_BRIDGE_AGEING_TIME

+
#define NM_SETTING_BRIDGE_AGEING_TIME    "ageing-time"
 


-

NM_SETTING_BRIDGE_SETTING_NAME

-
#define NM_SETTING_BRIDGE_SETTING_NAME "bridge"
-
+

NMSettingBridge

+
typedef struct _NMSettingBridge NMSettingBridge;


-

NM_SETTING_BRIDGE_STP

-
#define NM_SETTING_BRIDGE_STP            "stp"
+

NMSettingBridgeClass

+
typedef struct {
+	NMSettingClass parent;
+
+	/* Padding for future expansion */
+	void (*_reserved1) (void);
+	void (*_reserved2) (void);
+	void (*_reserved3) (void);
+	void (*_reserved4) (void);
+} NMSettingBridgeClass;
 


-

nm_setting_bridge_error_quark ()

-
GQuark              nm_setting_bridge_error_quark       (void);
+

nm_setting_bridge_new ()

+
NMSetting *         nm_setting_bridge_new               (void);

-Registers an error quark for NMSettingBridge if necessary. +Creates a new NMSettingBridge object with default values.

-
+
+++ - +

Returns :

the error quark used for NMSettingBridge errors.the new empty NMSettingBridge object. [transfer full] +

Since 0.9.8


-

nm_setting_bridge_get_ageing_time ()

-
guint32             nm_setting_bridge_get_ageing_time   (NMSettingBridge *setting);
-
+

nm_setting_bridge_get_interface_name ()

+
const char *        nm_setting_bridge_get_interface_name
+                                                        (NMSettingBridge *setting);
+
+++ @@ -257,7 +287,7 @@ Registers an error quark for Returns :

-
+

setting :

the "ageing-time" property of the settingthe "interface-name" property of the setting
@@ -265,10 +295,13 @@ Registers an error quark for -

nm_setting_bridge_get_forward_delay ()

-
guint16             nm_setting_bridge_get_forward_delay (NMSettingBridge *setting);
-
+

nm_setting_bridge_get_stp ()

+
gboolean            nm_setting_bridge_get_stp           (NMSettingBridge *setting);
+
+++ @@ -277,7 +310,7 @@ Registers an error quark for Returns :

-
+

setting :

the "forward-delay" property of the settingthe "stp" property of the setting
@@ -285,10 +318,13 @@ Registers an error quark for -

nm_setting_bridge_get_hello_time ()

-
guint16             nm_setting_bridge_get_hello_time    (NMSettingBridge *setting);
-
+

nm_setting_bridge_get_priority ()

+
guint16             nm_setting_bridge_get_priority      (NMSettingBridge *setting);
+
+++ @@ -297,7 +333,7 @@ Registers an error quark for Returns :

-
+

setting :

the "hello-time" property of the settingthe "priority" property of the setting
@@ -305,11 +341,13 @@ Registers an error quark for -

nm_setting_bridge_get_interface_name ()

-
const char *        nm_setting_bridge_get_interface_name
-                                                        (NMSettingBridge *setting);
-
+

nm_setting_bridge_get_forward_delay ()

+
guint16             nm_setting_bridge_get_forward_delay (NMSettingBridge *setting);
+
+++ @@ -318,7 +356,7 @@ Registers an error quark for Returns :

-
+

setting :

the "interface-name" property of the settingthe "forward-delay" property of the setting
@@ -326,10 +364,13 @@ Registers an error quark for -

nm_setting_bridge_get_max_age ()

-
guint16             nm_setting_bridge_get_max_age       (NMSettingBridge *setting);
-
+

nm_setting_bridge_get_hello_time ()

+
guint16             nm_setting_bridge_get_hello_time    (NMSettingBridge *setting);
+
+++ @@ -338,7 +379,7 @@ Registers an error quark for Returns :

-
+

setting :

the "max-age" property of the settingthe "hello-time" property of the setting
@@ -346,10 +387,13 @@ Registers an error quark for -

nm_setting_bridge_get_priority ()

-
guint16             nm_setting_bridge_get_priority      (NMSettingBridge *setting);
-
+

nm_setting_bridge_get_max_age ()

+
guint16             nm_setting_bridge_get_max_age       (NMSettingBridge *setting);
+
+++ @@ -358,7 +402,7 @@ Registers an error quark for Returns :

-
+

setting :

the "priority" property of the settingthe "max-age" property of the setting
@@ -366,10 +410,13 @@ Registers an error quark for -

nm_setting_bridge_get_stp ()

-
gboolean            nm_setting_bridge_get_stp           (NMSettingBridge *setting);
-
+

nm_setting_bridge_get_ageing_time ()

+
guint32             nm_setting_bridge_get_ageing_time   (NMSettingBridge *setting);
+
+++ @@ -378,29 +425,12 @@ Registers an error quark for Returns :

-
+

setting :

the "stp" property of the settingthe "ageing-time" property of the setting

Since 0.9.8

-
-
-

nm_setting_bridge_new ()

-
NMSetting *         nm_setting_bridge_new               (void);
-

-Creates a new NMSettingBridge object with default values. -

-
-- - - - -

Returns :

the new empty NMSettingBridge object. [transfer full] -
-

Since 0.9.8

-

Property Details

@@ -484,6 +514,6 @@ Controls whether Spanning Tree Protocol (STP) is enabled for this bridge.
+ Generated by GTK-Doc V1.19
\ No newline at end of file diff --git a/docs/libnm-util/html/NMSettingBridgePort.html b/docs/libnm-util/html/NMSettingBridgePort.html index c4dca496..bb2e37d0 100644 --- a/docs/libnm-util/html/NMSettingBridgePort.html +++ b/docs/libnm-util/html/NMSettingBridgePort.html @@ -3,12 +3,12 @@ NMSettingBridgePort - + - + @@ -44,34 +44,34 @@
 #include <nm-setting-bridge-port.h>
 
-                    NMSettingBridgePort;
-                    NMSettingBridgePortClass;
+#define             NM_SETTING_BRIDGE_PORT_SETTING_NAME
 enum                NMSettingBridgePortError;
 #define             NM_SETTING_BRIDGE_PORT_ERROR
-#define             NM_SETTING_BRIDGE_PORT_HAIRPIN_MODE
-#define             NM_SETTING_BRIDGE_PORT_PATH_COST
-#define             NM_SETTING_BRIDGE_PORT_PRIORITY
-#define             NM_SETTING_BRIDGE_PORT_SETTING_NAME
 GQuark              nm_setting_bridge_port_error_quark  (void);
-gboolean            nm_setting_bridge_port_get_hairpin_mode
-                                                        (NMSettingBridgePort *setting);
+#define             NM_SETTING_BRIDGE_PORT_PRIORITY
+#define             NM_SETTING_BRIDGE_PORT_PATH_COST
+#define             NM_SETTING_BRIDGE_PORT_HAIRPIN_MODE
+                    NMSettingBridgePort;
+                    NMSettingBridgePortClass;
+NMSetting *         nm_setting_bridge_port_new          (void);
+guint16             nm_setting_bridge_port_get_priority (NMSettingBridgePort *setting);
 guint16             nm_setting_bridge_port_get_path_cost
                                                         (NMSettingBridgePort *setting);
-guint16             nm_setting_bridge_port_get_priority (NMSettingBridgePort *setting);
-NMSetting *         nm_setting_bridge_port_new          (void);
+gboolean            nm_setting_bridge_port_get_hairpin_mode
+                                                        (NMSettingBridgePort *setting);
 

Object Hierarchy

+
+  GEnum
+   +----NMSettingBridgePortError
+
   GObject
    +----NMSetting
          +----NMSettingBridgePort
 
-
-  GEnum
-   +----NMSettingBridgePortError
-

Properties

@@ -91,23 +91,8 @@ optional properties that apply to bridge ports.

Details

-

NMSettingBridgePort

-
typedef struct _NMSettingBridgePort NMSettingBridgePort;
-

-

-
-
-
-

NMSettingBridgePortClass

-
typedef struct {
-	NMSettingClass parent;
-
-	/* Padding for future expansion */
-	void (*_reserved1) (void);
-	void (*_reserved2) (void);
-	void (*_reserved3) (void);
-	void (*_reserved4) (void);
-} NMSettingBridgePortClass;
+

NM_SETTING_BRIDGE_PORT_SETTING_NAME

+
#define NM_SETTING_BRIDGE_PORT_SETTING_NAME "bridge-port"
 

@@ -121,8 +106,11 @@ optional properties that apply to bridge ports. NM_SETTING_BRIDGE_PORT_ERROR_MISSING_PROPERTY, /*< nick=MissingProperty >*/ } NMSettingBridgePortError;
-
+
+++ @@ -154,8 +142,27 @@ is required
-

NM_SETTING_BRIDGE_PORT_HAIRPIN_MODE

-
#define NM_SETTING_BRIDGE_PORT_HAIRPIN_MODE "hairpin-mode"
+

nm_setting_bridge_port_error_quark ()

+
GQuark              nm_setting_bridge_port_error_quark  (void);
+

+Registers an error quark for NMSettingBridgePort if necessary. +

+

NM_SETTING_BRIDGE_PORT_ERROR_UNKNOWN

++++ + + + + +

Returns :

the error quark used for NMSettingBridgePort errors.
+

Since 0.9.8

+
+
+
+

NM_SETTING_BRIDGE_PORT_PRIORITY

+
#define NM_SETTING_BRIDGE_PORT_PRIORITY     "priority"
 

@@ -170,43 +177,64 @@ is required

-

NM_SETTING_BRIDGE_PORT_PRIORITY

-
#define NM_SETTING_BRIDGE_PORT_PRIORITY     "priority"
+

NM_SETTING_BRIDGE_PORT_HAIRPIN_MODE

+
#define NM_SETTING_BRIDGE_PORT_HAIRPIN_MODE "hairpin-mode"
 


-

NM_SETTING_BRIDGE_PORT_SETTING_NAME

-
#define NM_SETTING_BRIDGE_PORT_SETTING_NAME "bridge-port"
+

NMSettingBridgePort

+
typedef struct _NMSettingBridgePort NMSettingBridgePort;
+

+

+
+
+
+

NMSettingBridgePortClass

+
typedef struct {
+	NMSettingClass parent;
+
+	/* Padding for future expansion */
+	void (*_reserved1) (void);
+	void (*_reserved2) (void);
+	void (*_reserved3) (void);
+	void (*_reserved4) (void);
+} NMSettingBridgePortClass;
 


-

nm_setting_bridge_port_error_quark ()

-
GQuark              nm_setting_bridge_port_error_quark  (void);
+

nm_setting_bridge_port_new ()

+
NMSetting *         nm_setting_bridge_port_new          (void);

-Registers an error quark for NMSettingBridgePort if necessary. +Creates a new NMSettingBridgePort object with default values.

-
+
+++ - +

Returns :

the error quark used for NMSettingBridgePort errors.the new empty NMSettingBridgePort object. [transfer full] +

Since 0.9.8


-

nm_setting_bridge_port_get_hairpin_mode ()

-
gboolean            nm_setting_bridge_port_get_hairpin_mode
-                                                        (NMSettingBridgePort *setting);
-
+

nm_setting_bridge_port_get_priority ()

+
guint16             nm_setting_bridge_port_get_priority (NMSettingBridgePort *setting);
+
+++ @@ -215,7 +243,7 @@ Registers an error quark for - +

setting :

Returns :

the "hairpin-mode" property of the settingthe "priority" property of the setting
@@ -226,8 +254,11 @@ Registers an error quark for

nm_setting_bridge_port_get_path_cost ()

guint16             nm_setting_bridge_port_get_path_cost
                                                         (NMSettingBridgePort *setting);
-
+
+++ @@ -244,10 +275,14 @@ Registers an error quark for
-

nm_setting_bridge_port_get_priority ()

-
guint16             nm_setting_bridge_port_get_priority (NMSettingBridgePort *setting);
-

setting :

+

nm_setting_bridge_port_get_hairpin_mode ()

+
gboolean            nm_setting_bridge_port_get_hairpin_mode
+                                                        (NMSettingBridgePort *setting);
+
+++ @@ -256,29 +291,12 @@ Registers an error quark for - +

setting :

Returns :

the "priority" property of the settingthe "hairpin-mode" property of the setting

Since 0.9.8

-
-
-

nm_setting_bridge_port_new ()

-
NMSetting *         nm_setting_bridge_port_new          (void);
-

-Creates a new NMSettingBridgePort object with default values. -

-
-- - - - -

Returns :

the new empty NMSettingBridgePort object. [transfer full] -
-

Since 0.9.8

-

Property Details

@@ -318,6 +336,6 @@ The Spanning Tree Protocol (STP) priority of this bridge port.
+ Generated by GTK-Doc V1.19
\ No newline at end of file diff --git a/docs/libnm-util/html/NMSettingCdma.html b/docs/libnm-util/html/NMSettingCdma.html index ffb2f45b..0ce20d15 100644 --- a/docs/libnm-util/html/NMSettingCdma.html +++ b/docs/libnm-util/html/NMSettingCdma.html @@ -3,12 +3,12 @@ NMSettingCdma - + - + @@ -44,34 +44,34 @@
 #include <nm-setting-cdma.h>
 
-                    NMSettingCdma;
-                    NMSettingCdmaClass;
+#define             NM_SETTING_CDMA_SETTING_NAME
 enum                NMSettingCdmaError;
 #define             NM_SETTING_CDMA_ERROR
+GQuark              nm_setting_cdma_error_quark         (void);
 #define             NM_SETTING_CDMA_NUMBER
+#define             NM_SETTING_CDMA_USERNAME
 #define             NM_SETTING_CDMA_PASSWORD
 #define             NM_SETTING_CDMA_PASSWORD_FLAGS
-#define             NM_SETTING_CDMA_SETTING_NAME
-#define             NM_SETTING_CDMA_USERNAME
-GQuark              nm_setting_cdma_error_quark         (void);
+                    NMSettingCdma;
+                    NMSettingCdmaClass;
+NMSetting *         nm_setting_cdma_new                 (void);
 const char *        nm_setting_cdma_get_number          (NMSettingCdma *setting);
+const char *        nm_setting_cdma_get_username        (NMSettingCdma *setting);
 const char *        nm_setting_cdma_get_password        (NMSettingCdma *setting);
 NMSettingSecretFlags nm_setting_cdma_get_password_flags (NMSettingCdma *setting);
-const char *        nm_setting_cdma_get_username        (NMSettingCdma *setting);
-NMSetting *         nm_setting_cdma_new                 (void);
 

Object Hierarchy

+
+  GEnum
+   +----NMSettingCdmaError
+
   GObject
    +----NMSetting
          +----NMSettingCdma
 
-
-  GEnum
-   +----NMSettingCdmaError
-

Properties

@@ -93,23 +93,8 @@ networks, including those using CDMA2000/EVDO technology.

Details

-

NMSettingCdma

-
typedef struct _NMSettingCdma NMSettingCdma;
-

-

-
-
-
-

NMSettingCdmaClass

-
typedef struct {
-	NMSettingClass parent;
-
-	/* Padding for future expansion */
-	void (*_reserved1) (void);
-	void (*_reserved2) (void);
-	void (*_reserved3) (void);
-	void (*_reserved4) (void);
-} NMSettingCdmaClass;
+

NM_SETTING_CDMA_SETTING_NAME

+
#define NM_SETTING_CDMA_SETTING_NAME "cdma"
 

@@ -124,8 +109,11 @@ networks, including those using CDMA2000/EVDO technology. NM_SETTING_CDMA_ERROR_MISSING_SERIAL_SETTING /*< nick=MissingSerialSetting >*/ } NMSettingCdmaError;
-
+
+++ @@ -162,6 +150,24 @@ is missing in the connection
+

nm_setting_cdma_error_quark ()

+
GQuark              nm_setting_cdma_error_quark         (void);
+

+Registers an error quark for NMSettingCdma if necessary. +

+

NM_SETTING_CDMA_ERROR_UNKNOWN

++++ + + + + +

Returns :

the error quark used for NMSettingCdma errors.
+
+
+

NM_SETTING_CDMA_NUMBER

#define NM_SETTING_CDMA_NUMBER         "number"
 
@@ -170,6 +176,14 @@ is missing in the connection

+

NM_SETTING_CDMA_USERNAME

+
#define NM_SETTING_CDMA_USERNAME       "username"
+
+

+

+
+
+

NM_SETTING_CDMA_PASSWORD

#define NM_SETTING_CDMA_PASSWORD       "password"
 
@@ -186,32 +200,42 @@ is missing in the connection

-

NM_SETTING_CDMA_SETTING_NAME

-
#define NM_SETTING_CDMA_SETTING_NAME "cdma"
-
+

NMSettingCdma

+
typedef struct _NMSettingCdma NMSettingCdma;


-

NM_SETTING_CDMA_USERNAME

-
#define NM_SETTING_CDMA_USERNAME       "username"
+

NMSettingCdmaClass

+
typedef struct {
+	NMSettingClass parent;
+
+	/* Padding for future expansion */
+	void (*_reserved1) (void);
+	void (*_reserved2) (void);
+	void (*_reserved3) (void);
+	void (*_reserved4) (void);
+} NMSettingCdmaClass;
 


-

nm_setting_cdma_error_quark ()

-
GQuark              nm_setting_cdma_error_quark         (void);
+

nm_setting_cdma_new ()

+
NMSetting *         nm_setting_cdma_new                 (void);

-Registers an error quark for NMSettingCdma if necessary. +Creates a new NMSettingCdma object with default values.

-
+
+++ - +

Returns :

the error quark used for NMSettingCdma errors.the new empty NMSettingCdma object
@@ -219,8 +243,11 @@ Registers an error quark for

nm_setting_cdma_get_number ()

const char *        nm_setting_cdma_get_number          (NMSettingCdma *setting);
-
+
+++ @@ -236,10 +263,13 @@ Registers an error quark for -

nm_setting_cdma_get_password ()

-
const char *        nm_setting_cdma_get_password        (NMSettingCdma *setting);
-

setting :

+

nm_setting_cdma_get_username ()

+
const char *        nm_setting_cdma_get_username        (NMSettingCdma *setting);
+
+++ @@ -248,17 +278,20 @@ Registers an error quark for Returns :

-
+

setting :

the "password" property of the settingthe "username" property of the setting

-

nm_setting_cdma_get_password_flags ()

-
NMSettingSecretFlags nm_setting_cdma_get_password_flags (NMSettingCdma *setting);
-
+

nm_setting_cdma_get_password ()

+
const char *        nm_setting_cdma_get_password        (NMSettingCdma *setting);
+
+++ @@ -267,18 +300,20 @@ Registers an error quark for Returns :

-
+

setting :

the NMSettingSecretFlags pertaining to the "password" -the "password" property of the setting

-

nm_setting_cdma_get_username ()

-
const char *        nm_setting_cdma_get_username        (NMSettingCdma *setting);
-
+

nm_setting_cdma_get_password_flags ()

+
NMSettingSecretFlags nm_setting_cdma_get_password_flags (NMSettingCdma *setting);
+
+++ @@ -287,26 +322,12 @@ Registers an error quark for Returns :

-
+

setting :

the "username" property of the settingthe NMSettingSecretFlags pertaining to the "password" +
-
-
-

nm_setting_cdma_new ()

-
NMSetting *         nm_setting_cdma_new                 (void);
-

-Creates a new NMSettingCdma object with default values. -

-
-- - - - -

Returns :

the new empty NMSettingCdma object
-

Property Details

@@ -356,6 +377,6 @@ username is required, it is specified here.
+ Generated by GTK-Doc V1.19 \ No newline at end of file diff --git a/docs/libnm-util/html/NMSettingConnection.html b/docs/libnm-util/html/NMSettingConnection.html index 2fd64bf5..95b82888 100644 --- a/docs/libnm-util/html/NMSettingConnection.html +++ b/docs/libnm-util/html/NMSettingConnection.html @@ -3,12 +3,12 @@ NMSettingConnection - + - + @@ -44,39 +44,33 @@
 #include <nm-setting-connection.h>
 
-                    NMSettingConnection;
-                    NMSettingConnectionClass;
+#define             NM_SETTING_CONNECTION_SETTING_NAME
 enum                NMSettingConnectionError;
-#define             NM_SETTING_CONNECTION_AUTOCONNECT
 #define             NM_SETTING_CONNECTION_ERROR
+GQuark              nm_setting_connection_error_quark   (void);
 #define             NM_SETTING_CONNECTION_ID
-#define             NM_SETTING_CONNECTION_MASTER
-#define             NM_SETTING_CONNECTION_PERMISSIONS
-#define             NM_SETTING_CONNECTION_READ_ONLY
-#define             NM_SETTING_CONNECTION_SECONDARIES
-#define             NM_SETTING_CONNECTION_SETTING_NAME
-#define             NM_SETTING_CONNECTION_SLAVE_TYPE
-#define             NM_SETTING_CONNECTION_TIMESTAMP
-#define             NM_SETTING_CONNECTION_TYPE
 #define             NM_SETTING_CONNECTION_UUID
+#define             NM_SETTING_CONNECTION_TYPE
+#define             NM_SETTING_CONNECTION_AUTOCONNECT
+#define             NM_SETTING_CONNECTION_TIMESTAMP
+#define             NM_SETTING_CONNECTION_READ_ONLY
+#define             NM_SETTING_CONNECTION_PERMISSIONS
 #define             NM_SETTING_CONNECTION_ZONE
-gboolean            nm_setting_connection_add_permission
-                                                        (NMSettingConnection *setting,
-                                                         const char *ptype,
-                                                         const char *pitem,
-                                                         const char *detail);
-gboolean            nm_setting_connection_add_secondary (NMSettingConnection *setting,
-                                                         const char *sec_uuid);
-GQuark              nm_setting_connection_error_quark   (void);
-gboolean            nm_setting_connection_get_autoconnect
-                                                        (NMSettingConnection *setting);
+#define             NM_SETTING_CONNECTION_MASTER
+#define             NM_SETTING_CONNECTION_SLAVE_TYPE
+#define             NM_SETTING_CONNECTION_SECONDARIES
+                    NMSettingConnection;
+                    NMSettingConnectionClass;
+NMSetting *         nm_setting_connection_new           (void);
+const char *        nm_setting_connection_get_id        (NMSettingConnection *setting);
+const char *        nm_setting_connection_get_uuid      (NMSettingConnection *setting);
 const char *        nm_setting_connection_get_connection_type
                                                         (NMSettingConnection *setting);
-const char *        nm_setting_connection_get_id        (NMSettingConnection *setting);
-const char *        nm_setting_connection_get_master    (NMSettingConnection *setting);
-guint32             nm_setting_connection_get_num_permissions
+gboolean            nm_setting_connection_get_autoconnect
                                                         (NMSettingConnection *setting);
-guint32             nm_setting_connection_get_num_secondaries
+guint64             nm_setting_connection_get_timestamp (NMSettingConnection *setting);
+gboolean            nm_setting_connection_get_read_only (NMSettingConnection *setting);
+guint32             nm_setting_connection_get_num_permissions
                                                         (NMSettingConnection *setting);
 gboolean            nm_setting_connection_get_permission
                                                         (NMSettingConnection *setting,
@@ -84,23 +78,29 @@ const char *        const char **out_ptype,
                                                          const char **out_pitem,
                                                          const char **out_detail);
-gboolean            nm_setting_connection_get_read_only (NMSettingConnection *setting);
-const char *        nm_setting_connection_get_secondary (NMSettingConnection *setting,
-                                                         guint32 idx);
-const char *        nm_setting_connection_get_slave_type
-                                                        (NMSettingConnection *setting);
-guint64             nm_setting_connection_get_timestamp (NMSettingConnection *setting);
-const char *        nm_setting_connection_get_uuid      (NMSettingConnection *setting);
 const char *        nm_setting_connection_get_zone      (NMSettingConnection *setting);
-gboolean            nm_setting_connection_is_slave_type (NMSettingConnection *setting,
-                                                         const char *type);
-NMSetting *         nm_setting_connection_new           (void);
 gboolean            nm_setting_connection_permissions_user_allowed
                                                         (NMSettingConnection *setting,
                                                          const char *uname);
+gboolean            nm_setting_connection_add_permission
+                                                        (NMSettingConnection *setting,
+                                                         const char *ptype,
+                                                         const char *pitem,
+                                                         const char *detail);
 void                nm_setting_connection_remove_permission
                                                         (NMSettingConnection *setting,
                                                          guint32 idx);
+const char *        nm_setting_connection_get_master    (NMSettingConnection *setting);
+gboolean            nm_setting_connection_is_slave_type (NMSettingConnection *setting,
+                                                         const char *type);
+const char *        nm_setting_connection_get_slave_type
+                                                        (NMSettingConnection *setting);
+guint32             nm_setting_connection_get_num_secondaries
+                                                        (NMSettingConnection *setting);
+const char *        nm_setting_connection_get_secondary (NMSettingConnection *setting,
+                                                         guint32 idx);
+gboolean            nm_setting_connection_add_secondary (NMSettingConnection *setting,
+                                                         const char *sec_uuid);
 void                nm_setting_connection_remove_secondary
                                                         (NMSettingConnection *setting,
                                                          guint32 idx);
@@ -108,15 +108,15 @@ const char *        
 

Object Hierarchy

+
+  GEnum
+   +----NMSettingConnectionError
+
   GObject
    +----NMSetting
          +----NMSettingConnection
 
-
-  GEnum
-   +----NMSettingConnectionError
-

Properties

@@ -146,25 +146,8 @@ a

Details

-

NMSettingConnection

-
typedef struct _NMSettingConnection NMSettingConnection;
-

-The NMSettingConnection struct contains only private data. -It should only be accessed through the functions described below. -

-
-
-
-

NMSettingConnectionClass

-
typedef struct {
-	NMSettingClass parent;
-
-	/* Padding for future expansion */
-	void (*_reserved1) (void);
-	void (*_reserved2) (void);
-	void (*_reserved3) (void);
-	void (*_reserved4) (void);
-} NMSettingConnectionClass;
+

NM_SETTING_CONNECTION_SETTING_NAME

+
#define NM_SETTING_CONNECTION_SETTING_NAME "connection"
 

@@ -184,8 +167,11 @@ It should only be accessed through the functions described below. Describes errors that may result from operations involving a NMSettingConnection.

-
+
+++ @@ -222,19 +208,29 @@ Describes errors that may result from operations involving a
-

NM_SETTING_CONNECTION_AUTOCONNECT

-
#define NM_SETTING_CONNECTION_AUTOCONNECT "autoconnect"
+

NM_SETTING_CONNECTION_ERROR

+
#define NM_SETTING_CONNECTION_ERROR nm_setting_connection_error_quark ()
 


-

NM_SETTING_CONNECTION_ERROR

-
#define NM_SETTING_CONNECTION_ERROR nm_setting_connection_error_quark ()
-
+

nm_setting_connection_error_quark ()

+
GQuark              nm_setting_connection_error_quark   (void);

+Registers an error quark for NMSettingConnection if necessary.

+

NM_SETTING_CONNECTION_ERROR_UNKNOWN

++++ + + + + +

Returns :

the error quark used for NMSettingConnection errors.

@@ -246,16 +242,32 @@ Describes errors that may result from operations involving a

-

NM_SETTING_CONNECTION_MASTER

-
#define NM_SETTING_CONNECTION_MASTER      "master"
+

NM_SETTING_CONNECTION_UUID

+
#define NM_SETTING_CONNECTION_UUID        "uuid"
 


-

NM_SETTING_CONNECTION_PERMISSIONS

-
#define NM_SETTING_CONNECTION_PERMISSIONS "permissions"
+

NM_SETTING_CONNECTION_TYPE

+
#define NM_SETTING_CONNECTION_TYPE        "type"
+
+

+

+
+
+
+

NM_SETTING_CONNECTION_AUTOCONNECT

+
#define NM_SETTING_CONNECTION_AUTOCONNECT "autoconnect"
+
+

+

+
+
+
+

NM_SETTING_CONNECTION_TIMESTAMP

+
#define NM_SETTING_CONNECTION_TIMESTAMP   "timestamp"
 

@@ -270,114 +282,99 @@ Describes errors that may result from operations involving a

-

NM_SETTING_CONNECTION_SECONDARIES

-
#define NM_SETTING_CONNECTION_SECONDARIES "secondaries"
+

NM_SETTING_CONNECTION_PERMISSIONS

+
#define NM_SETTING_CONNECTION_PERMISSIONS "permissions"
 


-

NM_SETTING_CONNECTION_SETTING_NAME

-
#define NM_SETTING_CONNECTION_SETTING_NAME "connection"
+

NM_SETTING_CONNECTION_ZONE

+
#define NM_SETTING_CONNECTION_ZONE        "zone"
 


-

NM_SETTING_CONNECTION_SLAVE_TYPE

-
#define NM_SETTING_CONNECTION_SLAVE_TYPE  "slave-type"
+

NM_SETTING_CONNECTION_MASTER

+
#define NM_SETTING_CONNECTION_MASTER      "master"
 


-

NM_SETTING_CONNECTION_TIMESTAMP

-
#define NM_SETTING_CONNECTION_TIMESTAMP   "timestamp"
+

NM_SETTING_CONNECTION_SLAVE_TYPE

+
#define NM_SETTING_CONNECTION_SLAVE_TYPE  "slave-type"
 


-

NM_SETTING_CONNECTION_TYPE

-
#define NM_SETTING_CONNECTION_TYPE        "type"
+

NM_SETTING_CONNECTION_SECONDARIES

+
#define NM_SETTING_CONNECTION_SECONDARIES "secondaries"
 


-

NM_SETTING_CONNECTION_UUID

-
#define NM_SETTING_CONNECTION_UUID        "uuid"
-
+

NMSettingConnection

+
typedef struct _NMSettingConnection NMSettingConnection;

+The NMSettingConnection struct contains only private data. +It should only be accessed through the functions described below.


-

NM_SETTING_CONNECTION_ZONE

-
#define NM_SETTING_CONNECTION_ZONE        "zone"
+

NMSettingConnectionClass

+
typedef struct {
+	NMSettingClass parent;
+
+	/* Padding for future expansion */
+	void (*_reserved1) (void);
+	void (*_reserved2) (void);
+	void (*_reserved3) (void);
+	void (*_reserved4) (void);
+} NMSettingConnectionClass;
 


-

nm_setting_connection_add_permission ()

-
gboolean            nm_setting_connection_add_permission
-                                                        (NMSettingConnection *setting,
-                                                         const char *ptype,
-                                                         const char *pitem,
-                                                         const char *detail);
+

nm_setting_connection_new ()

+
NMSetting *         nm_setting_connection_new           (void);

-Adds a permission to the connection's permission list. At this time, only -the "user" permission type is supported, and pitem must be a username. See -"permissions": for more details. +Creates a new NMSettingConnection object with default values.

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

setting :

the NMSettingConnection -

ptype :

the permission type; at this time only "user" is supported

pitem :

the permission item formatted as required for ptype -

detail :

unused at this time; must be NULL. [allow-none] -

Returns :

TRUE if the permission was unique and was successfully added to the -list, FALSE if ptype or pitem was invalid or it the permission was already -present in the list
the new empty NMSettingConnection object

-

nm_setting_connection_add_secondary ()

-
gboolean            nm_setting_connection_add_secondary (NMSettingConnection *setting,
-                                                         const char *sec_uuid);
+

nm_setting_connection_get_id ()

+
const char *        nm_setting_connection_get_id        (NMSettingConnection *setting);

-Adds a new secondary connetion UUID to the setting. +Returns the "id" property of the connection.

-
+
+++ @@ -385,44 +382,24 @@ Adds a new secondary connetion UUID to the setting. - - - - - +

setting :

sec_uuid :

the secondary connection UUID to add

Returns :

-TRUE if the secondary connection UUID was added; FALSE if the UUID -was already presentthe connection ID
-

Since 0.9.8

-
-
-
-

nm_setting_connection_error_quark ()

-
GQuark              nm_setting_connection_error_quark   (void);
-

-Registers an error quark for NMSettingConnection if necessary. -

-
-- - - - -

Returns :

the error quark used for NMSettingConnection errors.

-

nm_setting_connection_get_autoconnect ()

-
gboolean            nm_setting_connection_get_autoconnect
-                                                        (NMSettingConnection *setting);
+

nm_setting_connection_get_uuid ()

+
const char *        nm_setting_connection_get_uuid      (NMSettingConnection *setting);

-Returns the "autoconnect" property of the connection. +Returns the "uuid" property of the connection.

-
+
+++ @@ -431,7 +408,7 @@ Returns the Returns :

-
+

setting :

the connection's autoconnect behaviorthe connection UUID
@@ -444,8 +421,11 @@ Returns the "type" property of the connection.

-
+
+++ @@ -461,13 +441,17 @@ Returns the -

nm_setting_connection_get_id ()

-
const char *        nm_setting_connection_get_id        (NMSettingConnection *setting);
+

nm_setting_connection_get_autoconnect ()

+
gboolean            nm_setting_connection_get_autoconnect
+                                                        (NMSettingConnection *setting);

-Returns the "id" property of the connection. +Returns the "autoconnect" property of the connection.

-

setting :

+
+++ @@ -476,20 +460,23 @@ Returns the Returns :

-
+

setting :

the connection IDthe connection's autoconnect behavior

-

nm_setting_connection_get_master ()

-
const char *        nm_setting_connection_get_master    (NMSettingConnection *setting);
+

nm_setting_connection_get_timestamp ()

+
guint64             nm_setting_connection_get_timestamp (NMSettingConnection *setting);

-Returns the "master" property of the connection. +Returns the "timestamp" property of the connection.

-
+
+++ @@ -498,23 +485,23 @@ Returns the Returns :

-
+

setting :

interface name of the master device or UUID of the master -connection.the connection's timestamp

-

nm_setting_connection_get_num_permissions ()

-
guint32             nm_setting_connection_get_num_permissions
-                                                        (NMSettingConnection *setting);
+

nm_setting_connection_get_read_only ()

+
gboolean            nm_setting_connection_get_read_only (NMSettingConnection *setting);

-Returns the number of entires in the "permissions" -property of this setting. +Returns the "read-only" property of the connection.

-
+
+++ @@ -523,18 +510,26 @@ property of this setting. - +

setting :

Returns :

the number of permissions entires +TRUE if the connection is read-only, FALSE if it is not

-

nm_setting_connection_get_num_secondaries ()

-
guint32             nm_setting_connection_get_num_secondaries
+

nm_setting_connection_get_num_permissions ()

+
guint32             nm_setting_connection_get_num_permissions
                                                         (NMSettingConnection *setting);
-
+

+Returns the number of entires in the "permissions" +property of this setting. +

+
+++ @@ -543,11 +538,10 @@ property of this setting. - +

setting :

Returns :

the number of configured secondary connection UUIDsthe number of permissions entires
-

Since 0.9.8


@@ -562,8 +556,11 @@ property of this setting. Retrieve one of the entries of the "permissions" property of this setting.

-
+
+++ @@ -585,7 +582,7 @@ of this setting. - + @@ -597,13 +594,16 @@ of this setting.
-

nm_setting_connection_get_read_only ()

-
gboolean            nm_setting_connection_get_read_only (NMSettingConnection *setting);
+

nm_setting_connection_get_zone ()

+
const char *        nm_setting_connection_get_zone      (NMSettingConnection *setting);

-Returns the "read-only" property of the connection. +Returns the "zone" property of the connection.

-

setting :

out_detail :

on return, the permission detail (at this time, always NULL)on return, the permission detail (at this time, always NULL)

Returns :

+
+++ @@ -612,19 +612,25 @@ Returns the Returns :

-
+

setting :

-TRUE if the connection is read-only, FALSE if it is notthe trust level of a connection

-

nm_setting_connection_get_secondary ()

-
const char *        nm_setting_connection_get_secondary (NMSettingConnection *setting,
-                                                         guint32 idx);
-
+

nm_setting_connection_permissions_user_allowed ()

+
gboolean            nm_setting_connection_permissions_user_allowed
+                                                        (NMSettingConnection *setting,
+                                                         const char *uname);
+

+Checks whether the given username is allowed to view/access this connection. +

+
+++ @@ -632,28 +638,36 @@ Returns the idx :

-
+ + - +

setting :

the zero-based index of the secondary connection UUID entry

uname :

the user name to check permissions for

Returns :

the secondary connection UUID at index idx - +TRUE if the requested user is allowed to view this connection, +FALSE if the given user is not allowed to view this connection
-

Since 0.9.8


-

nm_setting_connection_get_slave_type ()

-
const char *        nm_setting_connection_get_slave_type
-                                                        (NMSettingConnection *setting);
+

nm_setting_connection_add_permission ()

+
gboolean            nm_setting_connection_add_permission
+                                                        (NMSettingConnection *setting,
+                                                         const char *ptype,
+                                                         const char *pitem,
+                                                         const char *detail);

-Returns the "slave-type" property of the connection. +Adds a permission to the connection's permission list. At this time, only +the "user" permission type is supported, and pitem must be a username. See +"permissions": for more details.

-
+
+++ @@ -661,43 +675,42 @@ Returns the Returns :

-
+ + - -

setting :

the type of slave this connection is, if any

ptype :

the permission type; at this time only "user" is supported
-
-
-
-

nm_setting_connection_get_timestamp ()

-
guint64             nm_setting_connection_get_timestamp (NMSettingConnection *setting);
-

-Returns the "timestamp" property of the connection. -

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

setting :

the NMSettingConnection +

pitem :

the permission item formatted as required for ptype +

detail :

unused at this time; must be NULL. [allow-none]

Returns :

the connection's timestampTRUE if the permission was unique and was successfully added to the +list, FALSE if ptype or pitem was invalid or it the permission was already +present in the list

-

nm_setting_connection_get_uuid ()

-
const char *        nm_setting_connection_get_uuid      (NMSettingConnection *setting);
+

nm_setting_connection_remove_permission ()

+
void                nm_setting_connection_remove_permission
+                                                        (NMSettingConnection *setting,
+                                                         guint32 idx);

-Returns the "uuid" property of the connection. +Removes the permission at index idx from the connection.

-
+
+++ @@ -705,21 +718,24 @@ Returns the Returns :

-
+ +

setting :

the connection UUID

idx :

the zero-based index of the permission to remove

-

nm_setting_connection_get_zone ()

-
const char *        nm_setting_connection_get_zone      (NMSettingConnection *setting);
+

nm_setting_connection_get_master ()

+
const char *        nm_setting_connection_get_master    (NMSettingConnection *setting);

-Returns the "zone" property of the connection. +Returns the "master" property of the connection.

-
+
+++ @@ -728,7 +744,8 @@ Returns the Returns :

-
+

setting :

the trust level of a connectioninterface name of the master device or UUID of the master +connection.
@@ -738,8 +755,11 @@ Returns the

nm_setting_connection_is_slave_type ()

gboolean            nm_setting_connection_is_slave_type (NMSettingConnection *setting,
                                                          const char *type);
-
+
+++ @@ -761,30 +781,40 @@ against setting's slave type
-

nm_setting_connection_new ()

-
NMSetting *         nm_setting_connection_new           (void);
+

nm_setting_connection_get_slave_type ()

+
const char *        nm_setting_connection_get_slave_type
+                                                        (NMSettingConnection *setting);

-Creates a new NMSettingConnection object with default values. +Returns the "slave-type" property of the connection.

-

setting :

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

setting :

the NMSettingConnection +

Returns :

the new empty NMSettingConnection object
the type of slave this connection is, if any

-

nm_setting_connection_permissions_user_allowed ()

-
gboolean            nm_setting_connection_permissions_user_allowed
-                                                        (NMSettingConnection *setting,
-                                                         const char *uname);
-

-Checks whether the given username is allowed to view/access this connection. -

-
+

nm_setting_connection_get_num_secondaries ()

+
guint32             nm_setting_connection_get_num_secondaries
+                                                        (NMSettingConnection *setting);
+
+++ @@ -792,29 +822,55 @@ Checks whether the given username is allowed to view/access this connection. - - + + + + +

setting :

uname :

the user name to check permissions for

Returns :

the number of configured secondary connection UUIDs
+

Since 0.9.8

+
+
+
+

nm_setting_connection_get_secondary ()

+
const char *        nm_setting_connection_get_secondary (NMSettingConnection *setting,
+                                                         guint32 idx);
+
++++ + + + + + + + + - +

setting :

the NMSettingConnection +

idx :

the zero-based index of the secondary connection UUID entry

Returns :

-TRUE if the requested user is allowed to view this connection, -FALSE if the given user is not allowed to view this connectionthe secondary connection UUID at index idx +
+

Since 0.9.8


-

nm_setting_connection_remove_permission ()

-
void                nm_setting_connection_remove_permission
-                                                        (NMSettingConnection *setting,
-                                                         guint32 idx);
+

nm_setting_connection_add_secondary ()

+
gboolean            nm_setting_connection_add_secondary (NMSettingConnection *setting,
+                                                         const char *sec_uuid);

-Removes the permission at index idx from the connection. +Adds a new secondary connetion UUID to the setting.

-
+
+++ @@ -822,11 +878,18 @@ Removes the permission at index idx from - - + + + + + +

setting :

idx :

the zero-based index of the permission to remove

sec_uuid :

the secondary connection UUID to add

Returns :

+TRUE if the secondary connection UUID was added; FALSE if the UUID +was already present
+

Since 0.9.8


@@ -837,8 +900,11 @@ Removes the permission at index idx from

Removes the secondary coonnection UUID at index idx.

-
+
+++ @@ -998,6 +1064,6 @@ default zone as defined by the firewall. + Generated by GTK-Doc V1.19 \ No newline at end of file diff --git a/docs/libnm-util/html/NMSettingGsm.html b/docs/libnm-util/html/NMSettingGsm.html index d10521ac..653911bb 100644 --- a/docs/libnm-util/html/NMSettingGsm.html +++ b/docs/libnm-util/html/NMSettingGsm.html @@ -3,12 +3,12 @@ NMSettingGsm - + - + @@ -41,60 +41,60 @@

setting :

Synopsis

-
+
 #include <nm-setting-gsm.h>
 
-                    NMSettingGsm;
-                    NMSettingGsmClass;
+#define             NM_SETTING_GSM_SETTING_NAME
 enum                NMSettingGsmError;
-enum                NMSettingGsmNetworkBand;
-enum                NMSettingGsmNetworkType;
-#define             NM_SETTING_GSM_ALLOWED_BANDS
-#define             NM_SETTING_GSM_APN
 #define             NM_SETTING_GSM_ERROR
-#define             NM_SETTING_GSM_HOME_ONLY
-#define             NM_SETTING_GSM_NETWORK_ID
-#define             NM_SETTING_GSM_NETWORK_TYPE
+GQuark              nm_setting_gsm_error_quark          (void);
 #define             NM_SETTING_GSM_NUMBER
+#define             NM_SETTING_GSM_USERNAME
 #define             NM_SETTING_GSM_PASSWORD
 #define             NM_SETTING_GSM_PASSWORD_FLAGS
+#define             NM_SETTING_GSM_APN
+#define             NM_SETTING_GSM_NETWORK_ID
+#define             NM_SETTING_GSM_NETWORK_TYPE
+#define             NM_SETTING_GSM_ALLOWED_BANDS
 #define             NM_SETTING_GSM_PIN
 #define             NM_SETTING_GSM_PIN_FLAGS
-#define             NM_SETTING_GSM_SETTING_NAME
-#define             NM_SETTING_GSM_USERNAME
-GQuark              nm_setting_gsm_error_quark          (void);
-guint32             nm_setting_gsm_get_allowed_bands    (NMSettingGsm *setting);
+#define             NM_SETTING_GSM_HOME_ONLY
+enum                NMSettingGsmNetworkType;
+enum                NMSettingGsmNetworkBand;
+                    NMSettingGsm;
+                    NMSettingGsmClass;
+NMSetting *         nm_setting_gsm_new                  (void);
+const char *        nm_setting_gsm_get_number           (NMSettingGsm *setting);
+const char *        nm_setting_gsm_get_username         (NMSettingGsm *setting);
+const char *        nm_setting_gsm_get_password         (NMSettingGsm *setting);
 const char *        nm_setting_gsm_get_apn              (NMSettingGsm *setting);
-gboolean            nm_setting_gsm_get_home_only        (NMSettingGsm *setting);
 const char *        nm_setting_gsm_get_network_id       (NMSettingGsm *setting);
 int                 nm_setting_gsm_get_network_type     (NMSettingGsm *setting);
-const char *        nm_setting_gsm_get_number           (NMSettingGsm *setting);
-const char *        nm_setting_gsm_get_password         (NMSettingGsm *setting);
-NMSettingSecretFlags nm_setting_gsm_get_password_flags  (NMSettingGsm *setting);
+guint32             nm_setting_gsm_get_allowed_bands    (NMSettingGsm *setting);
 const char *        nm_setting_gsm_get_pin              (NMSettingGsm *setting);
+gboolean            nm_setting_gsm_get_home_only        (NMSettingGsm *setting);
 NMSettingSecretFlags nm_setting_gsm_get_pin_flags       (NMSettingGsm *setting);
-const char *        nm_setting_gsm_get_username         (NMSettingGsm *setting);
-NMSetting *         nm_setting_gsm_new                  (void);
+NMSettingSecretFlags nm_setting_gsm_get_password_flags  (NMSettingGsm *setting);
 

Object Hierarchy

-  GObject
-   +----NMSetting
-         +----NMSettingGsm
+  GEnum
+   +----NMSettingGsmError
 
   GEnum
-   +----NMSettingGsmError
+   +----NMSettingGsmNetworkType
 
   GEnum
    +----NMSettingGsmNetworkBand
 
-  GEnum
-   +----NMSettingGsmNetworkType
+  GObject
+   +----NMSetting
+         +----NMSettingGsm
 
@@ -124,23 +124,8 @@ networks, including those using GPRS/EDGE and UMTS/HSPA technology.

Details

-

NMSettingGsm

-
typedef struct _NMSettingGsm NMSettingGsm;
-

-

-
-
-
-

NMSettingGsmClass

-
typedef struct {
-	NMSettingClass parent;
-
-	/* Padding for future expansion */
-	void (*_reserved1) (void);
-	void (*_reserved2) (void);
-	void (*_reserved3) (void);
-	void (*_reserved4) (void);
-} NMSettingGsmClass;
+

NM_SETTING_GSM_SETTING_NAME

+
#define NM_SETTING_GSM_SETTING_NAME "gsm"
 

@@ -155,8 +140,11 @@ networks, including those using GPRS/EDGE and UMTS/HSPA technology. NM_SETTING_GSM_ERROR_MISSING_SERIAL_SETTING /*< nick=MissingSerialSetting >*/ } NMSettingGsmError;
-
+
+++ @@ -185,6 +173,187 @@ is missing in the connection
+

NM_SETTING_GSM_ERROR

+
#define NM_SETTING_GSM_ERROR nm_setting_gsm_error_quark ()
+
+

+

+
+
+
+

nm_setting_gsm_error_quark ()

+
GQuark              nm_setting_gsm_error_quark          (void);
+

+Registers an error quark for NMSettingGsm if necessary. +

+

NM_SETTING_GSM_ERROR_UNKNOWN

++++ + + + + +

Returns :

the error quark used for NMSettingGsm errors.
+
+
+
+

NM_SETTING_GSM_NUMBER

+
#define NM_SETTING_GSM_NUMBER         "number"
+
+

+

+
+
+
+

NM_SETTING_GSM_USERNAME

+
#define NM_SETTING_GSM_USERNAME       "username"
+
+

+

+
+
+
+

NM_SETTING_GSM_PASSWORD

+
#define NM_SETTING_GSM_PASSWORD       "password"
+
+

+

+
+
+
+

NM_SETTING_GSM_PASSWORD_FLAGS

+
#define NM_SETTING_GSM_PASSWORD_FLAGS "password-flags"
+
+

+

+
+
+
+

NM_SETTING_GSM_APN

+
#define NM_SETTING_GSM_APN            "apn"
+
+

+

+
+
+
+

NM_SETTING_GSM_NETWORK_ID

+
#define NM_SETTING_GSM_NETWORK_ID     "network-id"
+
+

+

+
+
+
+

NM_SETTING_GSM_NETWORK_TYPE

+
#define NM_SETTING_GSM_NETWORK_TYPE   "network-type"
+
+

+

+
+
+
+

NM_SETTING_GSM_ALLOWED_BANDS

+
#define NM_SETTING_GSM_ALLOWED_BANDS  "allowed-bands"
+
+

+

+
+
+
+

NM_SETTING_GSM_PIN

+
#define NM_SETTING_GSM_PIN            "pin"
+
+

+

+
+
+
+

NM_SETTING_GSM_PIN_FLAGS

+
#define NM_SETTING_GSM_PIN_FLAGS      "pin-flags"
+
+

+

+
+
+
+

NM_SETTING_GSM_HOME_ONLY

+
#define NM_SETTING_GSM_HOME_ONLY      "home-only"
+
+

+

+
+
+
+

enum NMSettingGsmNetworkType

+
typedef enum {
+	NM_SETTING_GSM_NETWORK_TYPE_ANY = -1,
+	NM_SETTING_GSM_NETWORK_TYPE_UMTS_HSPA = 0,
+	NM_SETTING_GSM_NETWORK_TYPE_GPRS_EDGE = 1,
+	NM_SETTING_GSM_NETWORK_TYPE_PREFER_UMTS_HSPA = 2,
+	NM_SETTING_GSM_NETWORK_TYPE_PREFER_GPRS_EDGE = 3,
+	NM_SETTING_GSM_NETWORK_TYPE_PREFER_4G = 4,
+	NM_SETTING_GSM_NETWORK_TYPE_4G = 5
+} NMSettingGsmNetworkType;
+
+

+NMSettingGsmNetworkType values indicate the allowed access technologies +the device may use when connecting to this network. +

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

NM_SETTING_GSM_NETWORK_TYPE_ANY

any access technology may be used +

NM_SETTING_GSM_NETWORK_TYPE_UMTS_HSPA

only 3G-type (UMTS and HSPA) +technologies may be used +

NM_SETTING_GSM_NETWORK_TYPE_GPRS_EDGE

only 2G-type (GPRS and EDGE) +technologies may be used +

NM_SETTING_GSM_NETWORK_TYPE_PREFER_UMTS_HSPA

3G-type technologies are +preferred but 2G-type technologies may be used as a fallback +

NM_SETTING_GSM_NETWORK_TYPE_PREFER_GPRS_EDGE

2G-type technologies are +preferred but 3G-type technologies may be used as a fallback +

NM_SETTING_GSM_NETWORK_TYPE_PREFER_4G

4G/LTE-type technologies are +preferred but 3G/2/-type technologies may be used as a fallback +

NM_SETTING_GSM_NETWORK_TYPE_4G

only 4G/LTE type +technologies may be used +
+
+
+

enum NMSettingGsmNetworkBand

typedef enum {
 	NM_SETTING_GSM_BAND_UNKNOWN      = 0x00000000,
@@ -208,8 +377,11 @@ is missing in the connection
 NMSettingGsmNetworkBand values indicate the allowed frequency bands
 the device may use when connecting to this network.
 

-
+
+++ @@ -291,193 +463,54 @@ the device may use when connecting to this network.
-

enum NMSettingGsmNetworkType

-
typedef enum {
-	NM_SETTING_GSM_NETWORK_TYPE_ANY = -1,
-	NM_SETTING_GSM_NETWORK_TYPE_UMTS_HSPA = 0,
-	NM_SETTING_GSM_NETWORK_TYPE_GPRS_EDGE = 1,
-	NM_SETTING_GSM_NETWORK_TYPE_PREFER_UMTS_HSPA = 2,
-	NM_SETTING_GSM_NETWORK_TYPE_PREFER_GPRS_EDGE = 3,
-	NM_SETTING_GSM_NETWORK_TYPE_PREFER_4G = 4,
-	NM_SETTING_GSM_NETWORK_TYPE_4G = 5
-} NMSettingGsmNetworkType;
-
-

-NMSettingGsmNetworkType values indicate the allowed access technologies -the device may use when connecting to this network. -

-

NM_SETTING_GSM_BAND_UNKNOWN

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

NM_SETTING_GSM_NETWORK_TYPE_ANY

any access technology may be used -

NM_SETTING_GSM_NETWORK_TYPE_UMTS_HSPA

only 3G-type (UMTS and HSPA) -technologies may be used -

NM_SETTING_GSM_NETWORK_TYPE_GPRS_EDGE

only 2G-type (GPRS and EDGE) -technologies may be used -

NM_SETTING_GSM_NETWORK_TYPE_PREFER_UMTS_HSPA

3G-type technologies are -preferred but 2G-type technologies may be used as a fallback -

NM_SETTING_GSM_NETWORK_TYPE_PREFER_GPRS_EDGE

2G-type technologies are -preferred but 3G-type technologies may be used as a fallback -

NM_SETTING_GSM_NETWORK_TYPE_PREFER_4G

4G/LTE-type technologies are -preferred but 3G/2/-type technologies may be used as a fallback -

NM_SETTING_GSM_NETWORK_TYPE_4G

only 4G/LTE type -technologies may be used -
-
-
-
-

NM_SETTING_GSM_ALLOWED_BANDS

-
#define NM_SETTING_GSM_ALLOWED_BANDS  "allowed-bands"
-
-

-

-
-
-
-

NM_SETTING_GSM_APN

-
#define NM_SETTING_GSM_APN            "apn"
-
-

-

-
-
-
-

NM_SETTING_GSM_ERROR

-
#define NM_SETTING_GSM_ERROR nm_setting_gsm_error_quark ()
-
-

-

-
-
-
-

NM_SETTING_GSM_HOME_ONLY

-
#define NM_SETTING_GSM_HOME_ONLY      "home-only"
-
-

-

-
-
-
-

NM_SETTING_GSM_NETWORK_ID

-
#define NM_SETTING_GSM_NETWORK_ID     "network-id"
-
-

-

-
-
-
-

NM_SETTING_GSM_NETWORK_TYPE

-
#define NM_SETTING_GSM_NETWORK_TYPE   "network-type"
-
-

-

-
-
-
-

NM_SETTING_GSM_NUMBER

-
#define NM_SETTING_GSM_NUMBER         "number"
-
-

-

-
-
-
-

NM_SETTING_GSM_PASSWORD

-
#define NM_SETTING_GSM_PASSWORD       "password"
-
-

-

-
-
-
-

NM_SETTING_GSM_PASSWORD_FLAGS

-
#define NM_SETTING_GSM_PASSWORD_FLAGS "password-flags"
-
-

-

-
-
-
-

NM_SETTING_GSM_PIN

-
#define NM_SETTING_GSM_PIN            "pin"
-
-

-

-
-
-
-

NM_SETTING_GSM_PIN_FLAGS

-
#define NM_SETTING_GSM_PIN_FLAGS      "pin-flags"
-
-

-

-
-
-
-

NM_SETTING_GSM_SETTING_NAME

-
#define NM_SETTING_GSM_SETTING_NAME "gsm"
-
+

NMSettingGsm

+
typedef struct _NMSettingGsm NMSettingGsm;


-

NM_SETTING_GSM_USERNAME

-
#define NM_SETTING_GSM_USERNAME       "username"
+

NMSettingGsmClass

+
typedef struct {
+	NMSettingClass parent;
+
+	/* Padding for future expansion */
+	void (*_reserved1) (void);
+	void (*_reserved2) (void);
+	void (*_reserved3) (void);
+	void (*_reserved4) (void);
+} NMSettingGsmClass;
 


-

nm_setting_gsm_error_quark ()

-
GQuark              nm_setting_gsm_error_quark          (void);
+

nm_setting_gsm_new ()

+
NMSetting *         nm_setting_gsm_new                  (void);

-Registers an error quark for NMSettingGsm if necessary. +Creates a new NMSettingGsm object with default values.

-
+
+++ - +

Returns :

the error quark used for NMSettingGsm errors.the new empty NMSettingGsm object

-

nm_setting_gsm_get_allowed_bands ()

-
guint32             nm_setting_gsm_get_allowed_bands    (NMSettingGsm *setting);
-
+

nm_setting_gsm_get_number ()

+
const char *        nm_setting_gsm_get_number           (NMSettingGsm *setting);
+
+++ @@ -486,17 +519,20 @@ Registers an error quark for Returns :

-
+

setting :

the "allowed-bands" property of the settingthe "number" property of the setting

-

nm_setting_gsm_get_apn ()

-
const char *        nm_setting_gsm_get_apn              (NMSettingGsm *setting);
-
+

nm_setting_gsm_get_username ()

+
const char *        nm_setting_gsm_get_username         (NMSettingGsm *setting);
+
+++ @@ -505,17 +541,20 @@ Registers an error quark for Returns :

-
+

setting :

the "apn" property of the settingthe "username" property of the setting

-

nm_setting_gsm_get_home_only ()

-
gboolean            nm_setting_gsm_get_home_only        (NMSettingGsm *setting);
-
+

nm_setting_gsm_get_password ()

+
const char *        nm_setting_gsm_get_password         (NMSettingGsm *setting);
+
+++ @@ -524,17 +563,20 @@ Registers an error quark for Returns :

-
+

setting :

the "home-only" property of the settingthe "password" property of the setting

-

nm_setting_gsm_get_network_id ()

-
const char *        nm_setting_gsm_get_network_id       (NMSettingGsm *setting);
-
+

nm_setting_gsm_get_apn ()

+
const char *        nm_setting_gsm_get_apn              (NMSettingGsm *setting);
+
+++ @@ -543,17 +585,20 @@ Registers an error quark for Returns :

-
+

setting :

the "network-id" property of the settingthe "apn" property of the setting

-

nm_setting_gsm_get_network_type ()

-
int                 nm_setting_gsm_get_network_type     (NMSettingGsm *setting);
-
+

nm_setting_gsm_get_network_id ()

+
const char *        nm_setting_gsm_get_network_id       (NMSettingGsm *setting);
+
+++ @@ -562,17 +607,20 @@ Registers an error quark for Returns :

-
+

setting :

the "network-type" property of the settingthe "network-id" property of the setting

-

nm_setting_gsm_get_number ()

-
const char *        nm_setting_gsm_get_number           (NMSettingGsm *setting);
-
+

nm_setting_gsm_get_network_type ()

+
int                 nm_setting_gsm_get_network_type     (NMSettingGsm *setting);
+
+++ @@ -581,17 +629,20 @@ Registers an error quark for Returns :

-
+

setting :

the "number" property of the settingthe "network-type" property of the setting

-

nm_setting_gsm_get_password ()

-
const char *        nm_setting_gsm_get_password         (NMSettingGsm *setting);
-
+

nm_setting_gsm_get_allowed_bands ()

+
guint32             nm_setting_gsm_get_allowed_bands    (NMSettingGsm *setting);
+
+++ @@ -600,17 +651,20 @@ Registers an error quark for Returns :

-
+

setting :

the "password" property of the settingthe "allowed-bands" property of the setting

-

nm_setting_gsm_get_password_flags ()

-
NMSettingSecretFlags nm_setting_gsm_get_password_flags  (NMSettingGsm *setting);
-
+

nm_setting_gsm_get_pin ()

+
const char *        nm_setting_gsm_get_pin              (NMSettingGsm *setting);
+
+++ @@ -619,18 +673,20 @@ Registers an error quark for Returns :

-
+

setting :

the NMSettingSecretFlags pertaining to the "password" -the "pin" property of the setting

-

nm_setting_gsm_get_pin ()

-
const char *        nm_setting_gsm_get_pin              (NMSettingGsm *setting);
-
+

nm_setting_gsm_get_home_only ()

+
gboolean            nm_setting_gsm_get_home_only        (NMSettingGsm *setting);
+
+++ @@ -639,7 +695,7 @@ Registers an error quark for Returns :

-
+

setting :

the "pin" property of the settingthe "home-only" property of the setting
@@ -648,8 +704,11 @@ Registers an error quark for

nm_setting_gsm_get_pin_flags ()

NMSettingSecretFlags nm_setting_gsm_get_pin_flags       (NMSettingGsm *setting);
-
+
+++ @@ -666,10 +725,13 @@ Registers an error quark for -

nm_setting_gsm_get_username ()

-
const char *        nm_setting_gsm_get_username         (NMSettingGsm *setting);
-

setting :

+

nm_setting_gsm_get_password_flags ()

+
NMSettingSecretFlags nm_setting_gsm_get_password_flags  (NMSettingGsm *setting);
+
+++ @@ -678,26 +740,12 @@ Registers an error quark for Returns :

-
+

setting :

the "username" property of the settingthe NMSettingSecretFlags pertaining to the "password" +
-
-
-

nm_setting_gsm_new ()

-
NMSetting *         nm_setting_gsm_new                  (void);
-

-Creates a new NMSettingGsm object with default values. -

-
-- - - - -

Returns :

the new empty NMSettingGsm object
-

Property Details

@@ -709,7 +757,7 @@ Bitfield of allowed frequency bands. Note that not all devices allow frequency band control. Permitted values are those specified by NMSettingGsmNetworkBand.

-

Allowed values: <= 1

+

Allowed values: <= 16383

Default value: 1


@@ -760,7 +808,7 @@ technologies. Permitted values are those specified by NMSettingGsmNetworkType. Note that not all devices allow network preference control.

-

Allowed values: [G_MAXULONG,5]

+

Allowed values: [-1,5]

Default value: -1


@@ -832,6 +880,6 @@ username is required, it is specified here.
+ Generated by GTK-Doc V1.19
\ No newline at end of file diff --git a/docs/libnm-util/html/NMSettingIP4Config.html b/docs/libnm-util/html/NMSettingIP4Config.html index df6762af..7e40149b 100644 --- a/docs/libnm-util/html/NMSettingIP4Config.html +++ b/docs/libnm-util/html/NMSettingIP4Config.html @@ -3,12 +3,12 @@ NMSettingIP4Config - + - + @@ -41,127 +41,131 @@

Synopsis

-
+
 #include <nm-setting-ip4-config.h>
 
-typedef             NMIP4Address;
-typedef             NMIP4Route;
-                    NMSettingIP4Config;
-                    NMSettingIP4ConfigClass;
+#define             NM_SETTING_IP4_CONFIG_SETTING_NAME
 enum                NMSettingIP4ConfigError;
-#define             NM_SETTING_IP4_CONFIG_ADDRESSES
-#define             NM_SETTING_IP4_CONFIG_DHCP_CLIENT_ID
-#define             NM_SETTING_IP4_CONFIG_DHCP_HOSTNAME
-#define             NM_SETTING_IP4_CONFIG_DHCP_SEND_HOSTNAME
+#define             NM_SETTING_IP4_CONFIG_ERROR
+GQuark              nm_setting_ip4_config_error_quark   (void);
+#define             NM_SETTING_IP4_CONFIG_METHOD
 #define             NM_SETTING_IP4_CONFIG_DNS
 #define             NM_SETTING_IP4_CONFIG_DNS_SEARCH
-#define             NM_SETTING_IP4_CONFIG_ERROR
-#define             NM_SETTING_IP4_CONFIG_IGNORE_AUTO_DNS
+#define             NM_SETTING_IP4_CONFIG_ADDRESSES
+#define             NM_SETTING_IP4_CONFIG_ROUTES
 #define             NM_SETTING_IP4_CONFIG_IGNORE_AUTO_ROUTES
+#define             NM_SETTING_IP4_CONFIG_IGNORE_AUTO_DNS
+#define             NM_SETTING_IP4_CONFIG_DHCP_CLIENT_ID
+#define             NM_SETTING_IP4_CONFIG_DHCP_SEND_HOSTNAME
+#define             NM_SETTING_IP4_CONFIG_DHCP_HOSTNAME
+#define             NM_SETTING_IP4_CONFIG_NEVER_DEFAULT
 #define             NM_SETTING_IP4_CONFIG_MAY_FAIL
-#define             NM_SETTING_IP4_CONFIG_METHOD
 #define             NM_SETTING_IP4_CONFIG_METHOD_AUTO
-#define             NM_SETTING_IP4_CONFIG_METHOD_DISABLED
 #define             NM_SETTING_IP4_CONFIG_METHOD_LINK_LOCAL
 #define             NM_SETTING_IP4_CONFIG_METHOD_MANUAL
 #define             NM_SETTING_IP4_CONFIG_METHOD_SHARED
-#define             NM_SETTING_IP4_CONFIG_NEVER_DEFAULT
-#define             NM_SETTING_IP4_CONFIG_ROUTES
-#define             NM_SETTING_IP4_CONFIG_SETTING_NAME
+#define             NM_SETTING_IP4_CONFIG_METHOD_DISABLED
+typedef             NMIP4Address;
+NMIP4Address *      nm_ip4_address_new                  (void);
+NMIP4Address *      nm_ip4_address_dup                  (NMIP4Address *source);
+void                nm_ip4_address_ref                  (NMIP4Address *address);
+void                nm_ip4_address_unref                (NMIP4Address *address);
 gboolean            nm_ip4_address_compare              (NMIP4Address *address,
                                                          NMIP4Address *other);
-NMIP4Address *      nm_ip4_address_dup                  (NMIP4Address *source);
 guint32             nm_ip4_address_get_address          (NMIP4Address *address);
-guint32             nm_ip4_address_get_gateway          (NMIP4Address *address);
-guint32             nm_ip4_address_get_prefix           (NMIP4Address *address);
-NMIP4Address *      nm_ip4_address_new                  (void);
-void                nm_ip4_address_ref                  (NMIP4Address *address);
 void                nm_ip4_address_set_address          (NMIP4Address *address,
                                                          guint32 addr);
-void                nm_ip4_address_set_gateway          (NMIP4Address *address,
-                                                         guint32 gateway);
+guint32             nm_ip4_address_get_prefix           (NMIP4Address *address);
 void                nm_ip4_address_set_prefix           (NMIP4Address *address,
                                                          guint32 prefix);
-void                nm_ip4_address_unref                (NMIP4Address *address);
+guint32             nm_ip4_address_get_gateway          (NMIP4Address *address);
+void                nm_ip4_address_set_gateway          (NMIP4Address *address,
+                                                         guint32 gateway);
+typedef             NMIP4Route;
+NMIP4Route *        nm_ip4_route_new                    (void);
+NMIP4Route *        nm_ip4_route_dup                    (NMIP4Route *source);
+void                nm_ip4_route_ref                    (NMIP4Route *route);
+void                nm_ip4_route_unref                  (NMIP4Route *route);
 gboolean            nm_ip4_route_compare                (NMIP4Route *route,
                                                          NMIP4Route *other);
-NMIP4Route *        nm_ip4_route_dup                    (NMIP4Route *source);
 guint32             nm_ip4_route_get_dest               (NMIP4Route *route);
-guint32             nm_ip4_route_get_metric             (NMIP4Route *route);
-guint32             nm_ip4_route_get_next_hop           (NMIP4Route *route);
-guint32             nm_ip4_route_get_prefix             (NMIP4Route *route);
-NMIP4Route *        nm_ip4_route_new                    (void);
-void                nm_ip4_route_ref                    (NMIP4Route *route);
 void                nm_ip4_route_set_dest               (NMIP4Route *route,
                                                          guint32 dest);
-void                nm_ip4_route_set_metric             (NMIP4Route *route,
-                                                         guint32 metric);
-void                nm_ip4_route_set_next_hop           (NMIP4Route *route,
-                                                         guint32 next_hop);
+guint32             nm_ip4_route_get_prefix             (NMIP4Route *route);
 void                nm_ip4_route_set_prefix             (NMIP4Route *route,
                                                          guint32 prefix);
-void                nm_ip4_route_unref                  (NMIP4Route *route);
-gboolean            nm_setting_ip4_config_add_address   (NMSettingIP4Config *setting,
-                                                         NMIP4Address *address);
+guint32             nm_ip4_route_get_next_hop           (NMIP4Route *route);
+void                nm_ip4_route_set_next_hop           (NMIP4Route *route,
+                                                         guint32 next_hop);
+guint32             nm_ip4_route_get_metric             (NMIP4Route *route);
+void                nm_ip4_route_set_metric             (NMIP4Route *route,
+                                                         guint32 metric);
+                    NMSettingIP4Config;
+                    NMSettingIP4ConfigClass;
+NMSetting *         nm_setting_ip4_config_new           (void);
+const char *        nm_setting_ip4_config_get_method    (NMSettingIP4Config *setting);
+guint32             nm_setting_ip4_config_get_num_dns   (NMSettingIP4Config *setting);
+guint32             nm_setting_ip4_config_get_dns       (NMSettingIP4Config *setting,
+                                                         guint32 i);
 gboolean            nm_setting_ip4_config_add_dns       (NMSettingIP4Config *setting,
                                                          guint32 dns);
+void                nm_setting_ip4_config_remove_dns    (NMSettingIP4Config *setting,
+                                                         guint32 i);
+void                nm_setting_ip4_config_clear_dns     (NMSettingIP4Config *setting);
+guint32             nm_setting_ip4_config_get_num_dns_searches
+                                                        (NMSettingIP4Config *setting);
+const char *        nm_setting_ip4_config_get_dns_search
+                                                        (NMSettingIP4Config *setting,
+                                                         guint32 i);
 gboolean            nm_setting_ip4_config_add_dns_search
                                                         (NMSettingIP4Config *setting,
                                                          const char *dns_search);
-gboolean            nm_setting_ip4_config_add_route     (NMSettingIP4Config *setting,
-                                                         NMIP4Route *route);
-void                nm_setting_ip4_config_clear_addresses
-                                                        (NMSettingIP4Config *setting);
-void                nm_setting_ip4_config_clear_dns     (NMSettingIP4Config *setting);
+void                nm_setting_ip4_config_remove_dns_search
+                                                        (NMSettingIP4Config *setting,
+                                                         guint32 i);
 void                nm_setting_ip4_config_clear_dns_searches
                                                         (NMSettingIP4Config *setting);
-void                nm_setting_ip4_config_clear_routes  (NMSettingIP4Config *setting);
-GQuark              nm_setting_ip4_config_error_quark   (void);
+guint32             nm_setting_ip4_config_get_num_addresses
+                                                        (NMSettingIP4Config *setting);
 NMIP4Address *      nm_setting_ip4_config_get_address   (NMSettingIP4Config *setting,
                                                          guint32 i);
-const char *        nm_setting_ip4_config_get_dhcp_client_id
-                                                        (NMSettingIP4Config *setting);
-const char *        nm_setting_ip4_config_get_dhcp_hostname
+gboolean            nm_setting_ip4_config_add_address   (NMSettingIP4Config *setting,
+                                                         NMIP4Address *address);
+void                nm_setting_ip4_config_remove_address
+                                                        (NMSettingIP4Config *setting,
+                                                         guint32 i);
+void                nm_setting_ip4_config_clear_addresses
                                                         (NMSettingIP4Config *setting);
-gboolean            nm_setting_ip4_config_get_dhcp_send_hostname
+guint32             nm_setting_ip4_config_get_num_routes
                                                         (NMSettingIP4Config *setting);
-guint32             nm_setting_ip4_config_get_dns       (NMSettingIP4Config *setting,
+NMIP4Route *        nm_setting_ip4_config_get_route     (NMSettingIP4Config *setting,
                                                          guint32 i);
-const char *        nm_setting_ip4_config_get_dns_search
-                                                        (NMSettingIP4Config *setting,
+gboolean            nm_setting_ip4_config_add_route     (NMSettingIP4Config *setting,
+                                                         NMIP4Route *route);
+void                nm_setting_ip4_config_remove_route  (NMSettingIP4Config *setting,
                                                          guint32 i);
-gboolean            nm_setting_ip4_config_get_ignore_auto_dns
-                                                        (NMSettingIP4Config *setting);
+void                nm_setting_ip4_config_clear_routes  (NMSettingIP4Config *setting);
 gboolean            nm_setting_ip4_config_get_ignore_auto_routes
                                                         (NMSettingIP4Config *setting);
-gboolean            nm_setting_ip4_config_get_may_fail  (NMSettingIP4Config *setting);
-const char *        nm_setting_ip4_config_get_method    (NMSettingIP4Config *setting);
-gboolean            nm_setting_ip4_config_get_never_default
+gboolean            nm_setting_ip4_config_get_ignore_auto_dns
                                                         (NMSettingIP4Config *setting);
-guint32             nm_setting_ip4_config_get_num_addresses
+const char *        nm_setting_ip4_config_get_dhcp_client_id
                                                         (NMSettingIP4Config *setting);
-guint32             nm_setting_ip4_config_get_num_dns   (NMSettingIP4Config *setting);
-guint32             nm_setting_ip4_config_get_num_dns_searches
+gboolean            nm_setting_ip4_config_get_dhcp_send_hostname
                                                         (NMSettingIP4Config *setting);
-guint32             nm_setting_ip4_config_get_num_routes
+const char *        nm_setting_ip4_config_get_dhcp_hostname
                                                         (NMSettingIP4Config *setting);
-NMIP4Route *        nm_setting_ip4_config_get_route     (NMSettingIP4Config *setting,
-                                                         guint32 i);
-NMSetting *         nm_setting_ip4_config_new           (void);
-void                nm_setting_ip4_config_remove_address
-                                                        (NMSettingIP4Config *setting,
-                                                         guint32 i);
-void                nm_setting_ip4_config_remove_dns    (NMSettingIP4Config *setting,
-                                                         guint32 i);
-void                nm_setting_ip4_config_remove_dns_search
-                                                        (NMSettingIP4Config *setting,
-                                                         guint32 i);
-void                nm_setting_ip4_config_remove_route  (NMSettingIP4Config *setting,
-                                                         guint32 i);
+gboolean            nm_setting_ip4_config_get_never_default
+                                                        (NMSettingIP4Config *setting);
+gboolean            nm_setting_ip4_config_get_may_fail  (NMSettingIP4Config *setting);
 

Object Hierarchy

+
+  GEnum
+   +----NMSettingIP4ConfigError
+
   GBoxed
    +----NMIP4Address
@@ -175,10 +179,6 @@ const char *        NMSetting
          +----NMSettingIP4Config
 
-
-  GEnum
-   +----NMSettingIP4ConfigError
-

Properties

@@ -207,39 +207,8 @@ properties related to IPv4 addressing, routing, and Domain Name Service

Details

-

NMIP4Address

-
typedef struct NMIP4Address NMIP4Address;
-
-

-

-
-
-
-

NMIP4Route

-
typedef struct NMIP4Route NMIP4Route;
-
-

-

-
-
-
-

NMSettingIP4Config

-
typedef struct _NMSettingIP4Config NMSettingIP4Config;
-

-

-
-
-
-

NMSettingIP4ConfigClass

-
typedef struct {
-	NMSettingClass parent;
-
-	/* Padding for future expansion */
-	void (*_reserved1) (void);
-	void (*_reserved2) (void);
-	void (*_reserved3) (void);
-	void (*_reserved4) (void);
-} NMSettingIP4ConfigClass;
+

NM_SETTING_IP4_CONFIG_SETTING_NAME

+
#define NM_SETTING_IP4_CONFIG_SETTING_NAME "ipv4"
 

@@ -254,8 +223,11 @@ properties related to IPv4 addressing, routing, and Domain Name Service NM_SETTING_IP4_CONFIG_ERROR_NOT_ALLOWED_FOR_METHOD /*< nick=NotAllowedForMethod >*/ } NMSettingIP4ConfigError;
-
+
+++ @@ -284,32 +256,34 @@ not valid with the given IP4 method
-

NM_SETTING_IP4_CONFIG_ADDRESSES

-
#define NM_SETTING_IP4_CONFIG_ADDRESSES          "addresses"
-
-

-

-
-
-
-

NM_SETTING_IP4_CONFIG_DHCP_CLIENT_ID

-
#define NM_SETTING_IP4_CONFIG_DHCP_CLIENT_ID     "dhcp-client-id"
+

NM_SETTING_IP4_CONFIG_ERROR

+
#define NM_SETTING_IP4_CONFIG_ERROR nm_setting_ip4_config_error_quark ()
 


-

NM_SETTING_IP4_CONFIG_DHCP_HOSTNAME

-
#define NM_SETTING_IP4_CONFIG_DHCP_HOSTNAME      "dhcp-hostname"
-
+

nm_setting_ip4_config_error_quark ()

+
GQuark              nm_setting_ip4_config_error_quark   (void);

+Registers an error quark for NMSettingIP4Config if necessary.

+

NM_SETTING_IP4_CONFIG_ERROR_UNKNOWN

++++ + + + + +

Returns :

the error quark used for NMSettingIP4Config errors.

-

NM_SETTING_IP4_CONFIG_DHCP_SEND_HOSTNAME

-
#define NM_SETTING_IP4_CONFIG_DHCP_SEND_HOSTNAME "dhcp-send-hostname"
+

NM_SETTING_IP4_CONFIG_METHOD

+
#define NM_SETTING_IP4_CONFIG_METHOD             "method"
 

@@ -332,16 +306,16 @@ not valid with the given IP4 method

-

NM_SETTING_IP4_CONFIG_ERROR

-
#define NM_SETTING_IP4_CONFIG_ERROR nm_setting_ip4_config_error_quark ()
+

NM_SETTING_IP4_CONFIG_ADDRESSES

+
#define NM_SETTING_IP4_CONFIG_ADDRESSES          "addresses"
 


-

NM_SETTING_IP4_CONFIG_IGNORE_AUTO_DNS

-
#define NM_SETTING_IP4_CONFIG_IGNORE_AUTO_DNS    "ignore-auto-dns"
+

NM_SETTING_IP4_CONFIG_ROUTES

+
#define NM_SETTING_IP4_CONFIG_ROUTES             "routes"
 

@@ -356,63 +330,86 @@ not valid with the given IP4 method

-

NM_SETTING_IP4_CONFIG_MAY_FAIL

-
#define NM_SETTING_IP4_CONFIG_MAY_FAIL           "may-fail"
+

NM_SETTING_IP4_CONFIG_IGNORE_AUTO_DNS

+
#define NM_SETTING_IP4_CONFIG_IGNORE_AUTO_DNS    "ignore-auto-dns"
 


-

NM_SETTING_IP4_CONFIG_METHOD

-
#define NM_SETTING_IP4_CONFIG_METHOD             "method"
+

NM_SETTING_IP4_CONFIG_DHCP_CLIENT_ID

+
#define NM_SETTING_IP4_CONFIG_DHCP_CLIENT_ID     "dhcp-client-id"
 


-

NM_SETTING_IP4_CONFIG_METHOD_AUTO

-
#define NM_SETTING_IP4_CONFIG_METHOD_AUTO       "auto"
+

NM_SETTING_IP4_CONFIG_DHCP_SEND_HOSTNAME

+
#define NM_SETTING_IP4_CONFIG_DHCP_SEND_HOSTNAME "dhcp-send-hostname"
 

-IPv4 configuration should be automatically determined via a method appropriate -for the hardware interface, ie DHCP or PPP or some other device-specific -manner.


-

NM_SETTING_IP4_CONFIG_METHOD_DISABLED

-
#define NM_SETTING_IP4_CONFIG_METHOD_DISABLED   "disabled"
+

NM_SETTING_IP4_CONFIG_DHCP_HOSTNAME

+
#define NM_SETTING_IP4_CONFIG_DHCP_HOSTNAME      "dhcp-hostname"
 

-This connection does not use or require IPv4 address and it should be disabled.


-

NM_SETTING_IP4_CONFIG_METHOD_LINK_LOCAL

-
#define NM_SETTING_IP4_CONFIG_METHOD_LINK_LOCAL "link-local"
+

NM_SETTING_IP4_CONFIG_NEVER_DEFAULT

+
#define NM_SETTING_IP4_CONFIG_NEVER_DEFAULT      "never-default"
 

-IPv4 configuration should be automatically configured for link-local-only -operation.


-

NM_SETTING_IP4_CONFIG_METHOD_MANUAL

-
#define NM_SETTING_IP4_CONFIG_METHOD_MANUAL     "manual"
+

NM_SETTING_IP4_CONFIG_MAY_FAIL

+
#define NM_SETTING_IP4_CONFIG_MAY_FAIL           "may-fail"
 

-All necessary IPv4 configuration (addresses, prefix, DNS, etc) is specified -in the setting's properties.


-

NM_SETTING_IP4_CONFIG_METHOD_SHARED

+

NM_SETTING_IP4_CONFIG_METHOD_AUTO

+
#define NM_SETTING_IP4_CONFIG_METHOD_AUTO       "auto"
+
+

+IPv4 configuration should be automatically determined via a method appropriate +for the hardware interface, ie DHCP or PPP or some other device-specific +manner. +

+
+
+
+

NM_SETTING_IP4_CONFIG_METHOD_LINK_LOCAL

+
#define NM_SETTING_IP4_CONFIG_METHOD_LINK_LOCAL "link-local"
+
+

+IPv4 configuration should be automatically configured for link-local-only +operation. +

+
+
+
+

NM_SETTING_IP4_CONFIG_METHOD_MANUAL

+
#define NM_SETTING_IP4_CONFIG_METHOD_MANUAL     "manual"
+
+

+All necessary IPv4 configuration (addresses, prefix, DNS, etc) is specified +in the setting's properties. +

+
+
+
+

NM_SETTING_IP4_CONFIG_METHOD_SHARED

#define NM_SETTING_IP4_CONFIG_METHOD_SHARED     "shared"
 

@@ -426,74 +423,131 @@ through that interface to the default network.


-

NM_SETTING_IP4_CONFIG_NEVER_DEFAULT

-
#define NM_SETTING_IP4_CONFIG_NEVER_DEFAULT      "never-default"
+

NM_SETTING_IP4_CONFIG_METHOD_DISABLED

+
#define NM_SETTING_IP4_CONFIG_METHOD_DISABLED   "disabled"
 

+This connection does not use or require IPv4 address and it should be disabled.


-

NM_SETTING_IP4_CONFIG_ROUTES

-
#define NM_SETTING_IP4_CONFIG_ROUTES             "routes"
+

NMIP4Address

+
typedef struct NMIP4Address NMIP4Address;
 


-

NM_SETTING_IP4_CONFIG_SETTING_NAME

-
#define NM_SETTING_IP4_CONFIG_SETTING_NAME "ipv4"
-
+

nm_ip4_address_new ()

+
NMIP4Address *      nm_ip4_address_new                  (void);

+Creates and returns a new NMIP4Address object.

+
++++ + + + + +

Returns :

the new empty NMIP4Address object. [transfer full] +

-

nm_ip4_address_compare ()

-
gboolean            nm_ip4_address_compare              (NMIP4Address *address,
-                                                         NMIP4Address *other);
+

nm_ip4_address_dup ()

+
NMIP4Address *      nm_ip4_address_dup                  (NMIP4Address *source);

-Determines if two NMIP4Address objects contain the same values. +Copies a given NMIP4Address object and returns the copy.

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

address :

the NMIP4Address -

other :

the NMIP4Address to compare address to.

source :

the NMIP4Address object to copy

Returns :

-TRUE if the objects contain the same values, FALSE if they do not.the copy of the given NMIP4Address copy. [transfer full] +

-

nm_ip4_address_dup ()

-
NMIP4Address *      nm_ip4_address_dup                  (NMIP4Address *source);
+

nm_ip4_address_ref ()

+
void                nm_ip4_address_ref                  (NMIP4Address *address);

-Copies a given NMIP4Address object and returns the copy. +Increases the reference count of the object. +

+
++++ + + + + +

address :

the NMIP4Address +
+
+
+
+

nm_ip4_address_unref ()

+
void                nm_ip4_address_unref                (NMIP4Address *address);
+

+Decreases the reference count of the object. If the reference count +reaches zero, the object will be destroyed.

-
+
+++ + + + + +

address :

the NMIP4Address +
+
+
+
+

nm_ip4_address_compare ()

+
gboolean            nm_ip4_address_compare              (NMIP4Address *address,
+                                                         NMIP4Address *other);
+

+Determines if two NMIP4Address objects contain the same values. +

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

source :

the NMIP4Address object to copy

address :

the NMIP4Address +

other :

the NMIP4Address to compare address to.

Returns :

the copy of the given NMIP4Address copy. [transfer full] - +TRUE if the objects contain the same values, FALSE if they do not.
@@ -505,8 +559,11 @@ Copies a given Gets the IPv4 address property of this address object.

-
+
+++ @@ -522,13 +579,17 @@ Gets the IPv4 address property of this address object.
-

nm_ip4_address_get_gateway ()

-
guint32             nm_ip4_address_get_gateway          (NMIP4Address *address);
+

nm_ip4_address_set_address ()

+
void                nm_ip4_address_set_address          (NMIP4Address *address,
+                                                         guint32 addr);

-Gets the IPv4 default gateway property of this address object. +Sets the IPv4 address property of this object.

-

address :

+
+++ @@ -536,8 +597,8 @@ Gets the IPv4 default gateway property of this address object. - - + +

address :

Returns :

the IPv4 gateway address in network byte order

addr :

the IPv4 address in network byte order
@@ -550,8 +611,11 @@ Gets the IPv4 default gateway property of this address object. Gets the IPv4 address prefix (ie "24" or "30" etc) property of this address object.

-
+
+++ @@ -567,46 +631,42 @@ object.
-

nm_ip4_address_new ()

-
NMIP4Address *      nm_ip4_address_new                  (void);
-

-Creates and returns a new NMIP4Address object. -

-

address :

-- - - - -

Returns :

the new empty NMIP4Address object. [transfer full] -
-
-
-
-

nm_ip4_address_ref ()

-
void                nm_ip4_address_ref                  (NMIP4Address *address);
+

nm_ip4_address_set_prefix ()

+
void                nm_ip4_address_set_prefix           (NMIP4Address *address,
+                                                         guint32 prefix);

-Increases the reference count of the object. +Sets the IPv4 address prefix.

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

address :

the NMIP4Address

prefix :

the address prefix, a number between 1 and 32 inclusive

-

nm_ip4_address_set_address ()

-
void                nm_ip4_address_set_address          (NMIP4Address *address,
-                                                         guint32 addr);
+

nm_ip4_address_get_gateway ()

+
guint32             nm_ip4_address_get_gateway          (NMIP4Address *address);

-Sets the IPv4 address property of this object. +Gets the IPv4 default gateway property of this address object.

-
+
+++ @@ -614,8 +674,8 @@ Sets the IPv4 address property of this object. - - + +

address :

addr :

the IPv4 address in network byte order

Returns :

the IPv4 gateway address in network byte order
@@ -628,8 +688,11 @@ Sets the IPv4 address property of this object.

Sets the IPv4 default gateway property of this address object.

-
+
+++ @@ -645,40 +708,91 @@ Sets the IPv4 default gateway property of this address object.
-

nm_ip4_address_set_prefix ()

-
void                nm_ip4_address_set_prefix           (NMIP4Address *address,
-                                                         guint32 prefix);
+

NMIP4Route

+
typedef struct NMIP4Route NMIP4Route;
+

-Sets the IPv4 address prefix.

-

address :

+ +
+
+

nm_ip4_route_new ()

+
NMIP4Route *        nm_ip4_route_new                    (void);
+

+Creates and returns a new NMIP4Route object. +

+
++++ + + + + +

Returns :

the new empty NMIP4Route object. [transfer full] +
+
+
+
+

nm_ip4_route_dup ()

+
NMIP4Route *        nm_ip4_route_dup                    (NMIP4Route *source);
+

+Copies a given NMIP4Route object and returns the copy. +

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

address :

the NMIP4Address -

source :

the NMIP4Route object to copy

prefix :

the address prefix, a number between 1 and 32 inclusive

Returns :

the copy of the given NMIP4Route copy. [transfer full] +

-

nm_ip4_address_unref ()

-
void                nm_ip4_address_unref                (NMIP4Address *address);
+

nm_ip4_route_ref ()

+
void                nm_ip4_route_ref                    (NMIP4Route *route);
+

+Increases the reference count of the object. +

+
++++ + + + + +

route :

the NMIP4Route +
+
+
+
+

nm_ip4_route_unref ()

+
void                nm_ip4_route_unref                  (NMIP4Route *route);

Decreases the reference count of the object. If the reference count reaches zero, the object will be destroyed.

-
+
+++ - - +

address :

the NMIP4Address +

route :

the NMIP4Route
@@ -691,8 +805,11 @@ reaches zero, the object will be destroyed.

Determines if two NMIP4Route objects contain the same values.

-
+
+++ @@ -713,35 +830,42 @@ Determines if two
-

nm_ip4_route_dup ()

-
NMIP4Route *        nm_ip4_route_dup                    (NMIP4Route *source);
+

nm_ip4_route_get_dest ()

+
guint32             nm_ip4_route_get_dest               (NMIP4Route *route);

-Copies a given NMIP4Route object and returns the copy. +Gets the IPv4 destination address property of this route object.

-

route :

+
+++ - - + + - +

source :

the NMIP4Route object to copy

route :

the NMIP4Route +

Returns :

the copy of the given NMIP4Route copy. [transfer full] -the IPv4 address in network byte order

-

nm_ip4_route_get_dest ()

-
guint32             nm_ip4_route_get_dest               (NMIP4Route *route);
+

nm_ip4_route_set_dest ()

+
void                nm_ip4_route_set_dest               (NMIP4Route *route,
+                                                         guint32 dest);

-Gets the IPv4 destination address property of this route object. +Sets the IPv4 destination address property of this route object.

-
+
+++ @@ -749,22 +873,24 @@ Gets the IPv4 destination address property of this route object. - - + +

route :

Returns :

the IPv4 address in network byte order

dest :

the destination address in network byte order

-

nm_ip4_route_get_metric ()

-
guint32             nm_ip4_route_get_metric             (NMIP4Route *route);
+

nm_ip4_route_get_prefix ()

+
guint32             nm_ip4_route_get_prefix             (NMIP4Route *route);

-Gets the route metric property of this route object; lower values indicate -"better" or more preferred routes. +Gets the IPv4 prefix (ie "24" or "30" etc) of this route.

-
+
+++ @@ -773,20 +899,24 @@ Gets the route metric property of this route object; lower values indicate - +

route :

Returns :

the route metricthe IPv4 prefix

-

nm_ip4_route_get_next_hop ()

-
guint32             nm_ip4_route_get_next_hop           (NMIP4Route *route);
+

nm_ip4_route_set_prefix ()

+
void                nm_ip4_route_set_prefix             (NMIP4Route *route,
+                                                         guint32 prefix);

-Gets the IPv4 address of the next hop of this route. +Sets the IPv4 prefix of this route.

-
+
+++ @@ -794,21 +924,24 @@ Gets the IPv4 address of the next hop of this route. - - + +

route :

Returns :

the IPv4 address in network byte order

prefix :

the prefix, a number between 1 and 32 inclusive

-

nm_ip4_route_get_prefix ()

-
guint32             nm_ip4_route_get_prefix             (NMIP4Route *route);
+

nm_ip4_route_get_next_hop ()

+
guint32             nm_ip4_route_get_next_hop           (NMIP4Route *route);

-Gets the IPv4 prefix (ie "24" or "30" etc) of this route. +Gets the IPv4 address of the next hop of this route.

-
+
+++ @@ -817,53 +950,50 @@ Gets the IPv4 prefix (ie "24" or "30" etc) of this route. - +

route :

Returns :

the IPv4 prefixthe IPv4 address in network byte order

-

nm_ip4_route_new ()

-
NMIP4Route *        nm_ip4_route_new                    (void);
-

-Creates and returns a new NMIP4Route object. -

-
-- - - - -

Returns :

the new empty NMIP4Route object. [transfer full] -
-
-
-
-

nm_ip4_route_ref ()

-
void                nm_ip4_route_ref                    (NMIP4Route *route);
+

nm_ip4_route_set_next_hop ()

+
void                nm_ip4_route_set_next_hop           (NMIP4Route *route,
+                                                         guint32 next_hop);

-Increases the reference count of the object. +Sets the IPv4 address of the next hop of this route.

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

route :

the NMIP4Route

next_hop :

the IPv4 address of the next hop in network byte order

-

nm_ip4_route_set_dest ()

-
void                nm_ip4_route_set_dest               (NMIP4Route *route,
-                                                         guint32 dest);
+

nm_ip4_route_get_metric ()

+
guint32             nm_ip4_route_get_metric             (NMIP4Route *route);

-Sets the IPv4 destination address property of this route object. +Gets the route metric property of this route object; lower values indicate +"better" or more preferred routes.

-
+
+++ @@ -871,8 +1001,8 @@ Sets the IPv4 destination address property of this route object. - - + +

route :

dest :

the destination address in network byte order

Returns :

the route metric
@@ -886,8 +1016,11 @@ Sets the IPv4 destination address property of this route object. Sets the route metric property of this route object; lower values indicate "better" or more preferred routes.

-
+
+++ @@ -903,78 +1036,55 @@ Sets the route metric property of this route object; lower values indicate
-

nm_ip4_route_set_next_hop ()

-
void                nm_ip4_route_set_next_hop           (NMIP4Route *route,
-                                                         guint32 next_hop);
+

NMSettingIP4Config

+
typedef struct _NMSettingIP4Config NMSettingIP4Config;

-Sets the IPv4 address of the next hop of this route.

-

route :

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

route :

the NMIP4Route -

next_hop :

the IPv4 address of the next hop in network byte order

-

nm_ip4_route_set_prefix ()

-
void                nm_ip4_route_set_prefix             (NMIP4Route *route,
-                                                         guint32 prefix);
+

NMSettingIP4ConfigClass

+
typedef struct {
+	NMSettingClass parent;
+
+	/* Padding for future expansion */
+	void (*_reserved1) (void);
+	void (*_reserved2) (void);
+	void (*_reserved3) (void);
+	void (*_reserved4) (void);
+} NMSettingIP4ConfigClass;
+

-Sets the IPv4 prefix of this route.

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

route :

the NMIP4Route -

prefix :

the prefix, a number between 1 and 32 inclusive

-

nm_ip4_route_unref ()

-
void                nm_ip4_route_unref                  (NMIP4Route *route);
+

nm_setting_ip4_config_new ()

+
NMSetting *         nm_setting_ip4_config_new           (void);

-Decreases the reference count of the object. If the reference count -reaches zero, the object will be destroyed. +Creates a new NMSettingIP4Config object with default values.

-
+
+++ - - +

route :

the NMIP4Route +

Returns :

the new empty NMSettingIP4Config object. [transfer full]

-

nm_setting_ip4_config_add_address ()

-
gboolean            nm_setting_ip4_config_add_address   (NMSettingIP4Config *setting,
-                                                         NMIP4Address *address);
-

-Adds a new IPv4 address and associated information to the setting. The -given address is duplicated internally and is not changed by this function. -

-
+

nm_setting_ip4_config_get_method ()

+
const char *        nm_setting_ip4_config_get_method    (NMSettingIP4Config *setting);
+
+++ @@ -982,28 +1092,21 @@ given address is duplicated internally and is not changed by this function. - - - - - +

setting :

address :

the new address to add

Returns :

-TRUE if the address was added; FALSE if the address was already -known.the "method" property of the setting

-

nm_setting_ip4_config_add_dns ()

-
gboolean            nm_setting_ip4_config_add_dns       (NMSettingIP4Config *setting,
-                                                         guint32 dns);
-

-Adds a new DNS server to the setting. -

-
+

nm_setting_ip4_config_get_num_dns ()

+
guint32             nm_setting_ip4_config_get_num_dns   (NMSettingIP4Config *setting);
+
+++ @@ -1011,29 +1114,22 @@ Adds a new DNS server to the setting. - - - - - +

setting :

dns :

the IPv4 address (network byte order) of the DNS server to add

Returns :

-TRUE if the DNS server was added; FALSE if the server was already -knownthe number of configured DNS servers

-

nm_setting_ip4_config_add_dns_search ()

-
gboolean            nm_setting_ip4_config_add_dns_search
-                                                        (NMSettingIP4Config *setting,
-                                                         const char *dns_search);
-

-Adds a new DNS search domain to the setting. -

-
+

nm_setting_ip4_config_get_dns ()

+
guint32             nm_setting_ip4_config_get_dns       (NMSettingIP4Config *setting,
+                                                         guint32 i);
+
+++ @@ -1041,29 +1137,31 @@ Adds a new DNS search domain to the setting. - - + + - +

setting :

dns_search :

the search domain to add

i :

index number of the DNS server to return

Returns :

-TRUE if the DNS search domain was added; FALSE if the search -domain was already knownthe IPv4 address (network byte order) of the DNS server at index +i +

-

nm_setting_ip4_config_add_route ()

-
gboolean            nm_setting_ip4_config_add_route     (NMSettingIP4Config *setting,
-                                                         NMIP4Route *route);
+

nm_setting_ip4_config_add_dns ()

+
gboolean            nm_setting_ip4_config_add_dns       (NMSettingIP4Config *setting,
+                                                         guint32 dns);

-Adds a new IPv4 route and associated information to the setting. The -given route is duplicated internally and is not changed by this function. +Adds a new DNS server to the setting.

-
+
+++ @@ -1071,32 +1169,42 @@ given route is duplicated internally and is not changed by this function. - - + + +TRUE if the DNS server was added; FALSE if the server was already +known

setting :

route :

the route to add

dns :

the IPv4 address (network byte order) of the DNS server to add

Returns :

-TRUE if the route was added; FALSE if the route was already known.

-

nm_setting_ip4_config_clear_addresses ()

-
void                nm_setting_ip4_config_clear_addresses
-                                                        (NMSettingIP4Config *setting);
+

nm_setting_ip4_config_remove_dns ()

+
void                nm_setting_ip4_config_remove_dns    (NMSettingIP4Config *setting,
+                                                         guint32 i);

-Removes all configured addresses. +Removes the DNS server at index i.

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

setting :

the NMSettingIP4Config

i :

index number of the DNS server to remove

@@ -1106,8 +1214,11 @@ Removes all configured addresses.

Removes all configured DNS servers.

-
+
+++

setting :

the NMSettingIP4Config @@ -1117,59 +1228,38 @@ Removes all configured DNS servers.
-

nm_setting_ip4_config_clear_dns_searches ()

-
void                nm_setting_ip4_config_clear_dns_searches
+

nm_setting_ip4_config_get_num_dns_searches ()

+
guint32             nm_setting_ip4_config_get_num_dns_searches
                                                         (NMSettingIP4Config *setting);
-

-Removes all configured DNS search domains. -

-
+
+- - - - -

setting :

the NMSettingIP4Config -
-
-
-
-

nm_setting_ip4_config_clear_routes ()

-
void                nm_setting_ip4_config_clear_routes  (NMSettingIP4Config *setting);
-

-Removes all configured routes. -

-
-- ++ + + - -

setting :

the NMSettingIP4Config
-
-
-
-

nm_setting_ip4_config_error_quark ()

-
GQuark              nm_setting_ip4_config_error_quark   (void);
-

-Registers an error quark for NMSettingIP4Config if necessary. -

-
-- + + - - + + +

Returns :

the error quark used for NMSettingIP4Config errors.
the number of configured DNS search domains

-

nm_setting_ip4_config_get_address ()

-
NMIP4Address *      nm_setting_ip4_config_get_address   (NMSettingIP4Config *setting,
+

nm_setting_ip4_config_get_dns_search ()

+
const char *        nm_setting_ip4_config_get_dns_search
+                                                        (NMSettingIP4Config *setting,
                                                          guint32 i);
-
+
+++ @@ -1178,11 +1268,11 @@ Registers an error quark for - + - @@ -1190,15 +1280,18 @@ Registers an error quark for
-

nm_setting_ip4_config_get_dhcp_client_id ()

-
const char *        nm_setting_ip4_config_get_dhcp_client_id
-                                                        (NMSettingIP4Config *setting);
+

nm_setting_ip4_config_add_dns_search ()

+
gboolean            nm_setting_ip4_config_add_dns_search
+                                                        (NMSettingIP4Config *setting,
+                                                         const char *dns_search);

-Returns the value contained in the "dhcp-client-id" -property. +Adds a new DNS search domain to the setting.

-

setting :

i :

index number of the address to returnindex number of the DNS search domain to return

Returns :

the address at index i +the DNS search domain at index i
+
+++ @@ -1206,24 +1299,32 @@ property. + + + + - +

setting :

dns_search :

the search domain to add

Returns :

the configured Client ID to send to the DHCP server when requesting -addresses via DHCP. +TRUE if the DNS search domain was added; FALSE if the search +domain was already known

-

nm_setting_ip4_config_get_dhcp_hostname ()

-
const char *        nm_setting_ip4_config_get_dhcp_hostname
-                                                        (NMSettingIP4Config *setting);
+

nm_setting_ip4_config_remove_dns_search ()

+
void                nm_setting_ip4_config_remove_dns_search
+                                                        (NMSettingIP4Config *setting,
+                                                         guint32 i);

-Returns the value contained in the "dhcp-hostname" -property. +Removes the DNS search domain at index i.

-
+
+++ @@ -1231,46 +1332,42 @@ property. - - + +

setting :

Returns :

the configured hostname to send to the DHCP server

i :

index number of the DNS search domain

-

nm_setting_ip4_config_get_dhcp_send_hostname ()

-
gboolean            nm_setting_ip4_config_get_dhcp_send_hostname
+

nm_setting_ip4_config_clear_dns_searches ()

+
void                nm_setting_ip4_config_clear_dns_searches
                                                         (NMSettingIP4Config *setting);

-Returns the value contained in the "dhcp-send-hostname" -property. +Removes all configured DNS search domains.

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

setting :

the NMSettingIP4Config

Returns :

-TRUE if NetworkManager should send the machine hostname to the -DHCP server when requesting addresses to allow the server to automatically -update DNS information for this machine.

-
-

nm_setting_ip4_config_get_dns ()

-
guint32             nm_setting_ip4_config_get_dns       (NMSettingIP4Config *setting,
-                                                         guint32 i);
-
+
+

nm_setting_ip4_config_get_num_addresses ()

+
guint32             nm_setting_ip4_config_get_num_addresses
+                                                        (NMSettingIP4Config *setting);
+
+++ @@ -1278,26 +1375,22 @@ update DNS information for this machine. - - - - - +

setting :

i :

index number of the DNS server to return

Returns :

the IPv4 address (network byte order) of the DNS server at index -i -the number of configured addresses

-

nm_setting_ip4_config_get_dns_search ()

-
const char *        nm_setting_ip4_config_get_dns_search
-                                                        (NMSettingIP4Config *setting,
+

nm_setting_ip4_config_get_address ()

+
NMIP4Address *      nm_setting_ip4_config_get_address   (NMSettingIP4Config *setting,
                                                          guint32 i);
-
+
+++ @@ -1306,11 +1399,11 @@ update DNS information for this machine. - + - @@ -1318,15 +1411,18 @@ update DNS information for this machine.
-

nm_setting_ip4_config_get_ignore_auto_dns ()

-
gboolean            nm_setting_ip4_config_get_ignore_auto_dns
-                                                        (NMSettingIP4Config *setting);
+

nm_setting_ip4_config_add_address ()

+
gboolean            nm_setting_ip4_config_add_address   (NMSettingIP4Config *setting,
+                                                         NMIP4Address *address);

-Returns the value contained in the "ignore-auto-dns" -property. +Adds a new IPv4 address and associated information to the setting. The +given address is duplicated internally and is not changed by this function.

-

setting :

i :

index number of the DNS search domain to returnindex number of the address to return

Returns :

the DNS search domain at index i +the address at index i
+
+++ @@ -1334,25 +1430,32 @@ property. + + + + +TRUE if the address was added; FALSE if the address was already +known.

setting :

address :

the new address to add

Returns :

-TRUE if automatically configured (ie via DHCP) DNS information -should be ignored.

-

nm_setting_ip4_config_get_ignore_auto_routes ()

-
gboolean            nm_setting_ip4_config_get_ignore_auto_routes
-                                                        (NMSettingIP4Config *setting);
+

nm_setting_ip4_config_remove_address ()

+
void                nm_setting_ip4_config_remove_address
+                                                        (NMSettingIP4Config *setting,
+                                                         guint32 i);

-Returns the value contained in the "ignore-auto-routes" -property. +Removes the address at index i.

-
+
+++ @@ -1360,24 +1463,42 @@ property. - - + +

setting :

Returns :

-TRUE if automatically configured (ie via DHCP) routes should be -ignored.

i :

index number of the address to remove

-

nm_setting_ip4_config_get_may_fail ()

-
gboolean            nm_setting_ip4_config_get_may_fail  (NMSettingIP4Config *setting);
+

nm_setting_ip4_config_clear_addresses ()

+
void                nm_setting_ip4_config_clear_addresses
+                                                        (NMSettingIP4Config *setting);

-Returns the value contained in the "may-fail" -property. +Removes all configured addresses.

-
+
++++ + + + + +

setting :

the NMSettingIP4Config +
+
+
+
+

nm_setting_ip4_config_get_num_routes ()

+
guint32             nm_setting_ip4_config_get_num_routes
+                                                        (NMSettingIP4Config *setting);
+
+++ @@ -1386,19 +1507,21 @@ property. - +

setting :

Returns :

-TRUE if this connection doesn't require IPv4 addressing to complete -for the connection to succeed.the number of configured routes

-

nm_setting_ip4_config_get_method ()

-
const char *        nm_setting_ip4_config_get_method    (NMSettingIP4Config *setting);
-
+

nm_setting_ip4_config_get_route ()

+
NMIP4Route *        nm_setting_ip4_config_get_route     (NMSettingIP4Config *setting,
+                                                         guint32 i);
+
+++ @@ -1406,23 +1529,31 @@ for the connection to succeed. + + + + - +

setting :

i :

index number of the route to return

Returns :

the "method" property of the settingthe route at index i +

-

nm_setting_ip4_config_get_never_default ()

-
gboolean            nm_setting_ip4_config_get_never_default
-                                                        (NMSettingIP4Config *setting);
+

nm_setting_ip4_config_add_route ()

+
gboolean            nm_setting_ip4_config_add_route     (NMSettingIP4Config *setting,
+                                                         NMIP4Route *route);

-Returns the value contained in the "never-default" -property. +Adds a new IPv4 route and associated information to the setting. The +given route is duplicated internally and is not changed by this function.

-
+
+++ @@ -1430,21 +1561,30 @@ property. + + + + +TRUE if the route was added; FALSE if the route was already known.

setting :

route :

the route to add

Returns :

-TRUE if this connection should never be the default connection -for IPv4 addressing

-

nm_setting_ip4_config_get_num_addresses ()

-
guint32             nm_setting_ip4_config_get_num_addresses
-                                                        (NMSettingIP4Config *setting);
-
+

nm_setting_ip4_config_remove_route ()

+
void                nm_setting_ip4_config_remove_route  (NMSettingIP4Config *setting,
+                                                         guint32 i);
+

+Removes the route at index i. +

+
+++ @@ -1452,38 +1592,45 @@ for IPv4 addressing - - + +

setting :

Returns :

the number of configured addresses

i :

index number of the route

-

nm_setting_ip4_config_get_num_dns ()

-
guint32             nm_setting_ip4_config_get_num_dns   (NMSettingIP4Config *setting);
-
+

nm_setting_ip4_config_clear_routes ()

+
void                nm_setting_ip4_config_clear_routes  (NMSettingIP4Config *setting);
+

+Removes all configured routes. +

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

setting :

the NMSettingIP4Config

Returns :

the number of configured DNS servers

-

nm_setting_ip4_config_get_num_dns_searches ()

-
guint32             nm_setting_ip4_config_get_num_dns_searches
+

nm_setting_ip4_config_get_ignore_auto_routes ()

+
gboolean            nm_setting_ip4_config_get_ignore_auto_routes
                                                         (NMSettingIP4Config *setting);
-
+

+Returns the value contained in the "ignore-auto-routes" +property. +

+
+++ @@ -1492,18 +1639,27 @@ for IPv4 addressing - +

setting :

Returns :

the number of configured DNS search domains +TRUE if automatically configured (ie via DHCP) routes should be +ignored.

-

nm_setting_ip4_config_get_num_routes ()

-
guint32             nm_setting_ip4_config_get_num_routes
+

nm_setting_ip4_config_get_ignore_auto_dns ()

+
gboolean            nm_setting_ip4_config_get_ignore_auto_dns
                                                         (NMSettingIP4Config *setting);
-
+

+Returns the value contained in the "ignore-auto-dns" +property. +

+
+++ @@ -1512,18 +1668,27 @@ for IPv4 addressing - +

setting :

Returns :

the number of configured routes +TRUE if automatically configured (ie via DHCP) DNS information +should be ignored.

-

nm_setting_ip4_config_get_route ()

-
NMIP4Route *        nm_setting_ip4_config_get_route     (NMSettingIP4Config *setting,
-                                                         guint32 i);
-
+

nm_setting_ip4_config_get_dhcp_client_id ()

+
const char *        nm_setting_ip4_config_get_dhcp_client_id
+                                                        (NMSettingIP4Config *setting);
+

+Returns the value contained in the "dhcp-client-id" +property. +

+
+++ @@ -1531,44 +1696,27 @@ for IPv4 addressing - - - - - +

setting :

i :

index number of the route to return

Returns :

the route at index i -the configured Client ID to send to the DHCP server when requesting +addresses via DHCP.

-

nm_setting_ip4_config_new ()

-
NMSetting *         nm_setting_ip4_config_new           (void);
-

-Creates a new NMSettingIP4Config object with default values. -

-
-- - - - -

Returns :

the new empty NMSettingIP4Config object. [transfer full] -
-
-
-
-

nm_setting_ip4_config_remove_address ()

-
void                nm_setting_ip4_config_remove_address
-                                                        (NMSettingIP4Config *setting,
-                                                         guint32 i);
+

nm_setting_ip4_config_get_dhcp_send_hostname ()

+
gboolean            nm_setting_ip4_config_get_dhcp_send_hostname
+                                                        (NMSettingIP4Config *setting);

-Removes the address at index i. +Returns the value contained in the "dhcp-send-hostname" +property.

-
+
+++ @@ -1576,22 +1724,29 @@ Removes the address at index i. - - + +

setting :

i :

index number of the address to remove

Returns :

+TRUE if NetworkManager should send the machine hostname to the +DHCP server when requesting addresses to allow the server to automatically +update DNS information for this machine.

-

nm_setting_ip4_config_remove_dns ()

-
void                nm_setting_ip4_config_remove_dns    (NMSettingIP4Config *setting,
-                                                         guint32 i);
+

nm_setting_ip4_config_get_dhcp_hostname ()

+
const char *        nm_setting_ip4_config_get_dhcp_hostname
+                                                        (NMSettingIP4Config *setting);

-Removes the DNS server at index i. +Returns the value contained in the "dhcp-hostname" +property.

-
+
+++ @@ -1599,23 +1754,26 @@ Removes the DNS server at index i. - - + +

setting :

i :

index number of the DNS server to remove

Returns :

the configured hostname to send to the DHCP server

-

nm_setting_ip4_config_remove_dns_search ()

-
void                nm_setting_ip4_config_remove_dns_search
-                                                        (NMSettingIP4Config *setting,
-                                                         guint32 i);
+

nm_setting_ip4_config_get_never_default ()

+
gboolean            nm_setting_ip4_config_get_never_default
+                                                        (NMSettingIP4Config *setting);

-Removes the DNS search domain at index i. +Returns the value contained in the "never-default" +property.

-
+
+++ @@ -1623,22 +1781,27 @@ Removes the DNS search domain at index i - - + +

setting :

i :

index number of the DNS search domain

Returns :

+TRUE if this connection should never be the default connection +for IPv4 addressing

-

nm_setting_ip4_config_remove_route ()

-
void                nm_setting_ip4_config_remove_route  (NMSettingIP4Config *setting,
-                                                         guint32 i);
+

nm_setting_ip4_config_get_may_fail ()

+
gboolean            nm_setting_ip4_config_get_may_fail  (NMSettingIP4Config *setting);

-Removes the route at index i. +Returns the value contained in the "may-fail" +property.

-
+
+++ @@ -1646,8 +1809,10 @@ Removes the route at index i. - - + +

setting :

i :

index number of the route

Returns :

+TRUE if this connection doesn't require IPv4 addressing to complete +for the connection to succeed.
@@ -1813,6 +1978,6 @@ or 'disabled' methods because there is no upstream network.
+ Generated by GTK-Doc V1.19 \ No newline at end of file diff --git a/docs/libnm-util/html/NMSettingIP6Config.html b/docs/libnm-util/html/NMSettingIP6Config.html index cca1efa8..9df4ad93 100644 --- a/docs/libnm-util/html/NMSettingIP6Config.html +++ b/docs/libnm-util/html/NMSettingIP6Config.html @@ -3,12 +3,12 @@ NMSettingIP6Config - + - + @@ -41,126 +41,134 @@

Synopsis

-
+
 #include <nm-setting-ip6-config.h>
 
-typedef             NMIP6Address;
-typedef             NMIP6Route;
-                    NMSettingIP6Config;
-                    NMSettingIP6ConfigClass;
+#define             NM_SETTING_IP6_CONFIG_SETTING_NAME
 enum                NMSettingIP6ConfigError;
-enum                NMSettingIP6ConfigPrivacy;
-#define             NM_SETTING_IP6_CONFIG_ADDRESSES
-#define             NM_SETTING_IP6_CONFIG_DHCP_HOSTNAME
+#define             NM_SETTING_IP6_CONFIG_ERROR
+GQuark              nm_setting_ip6_config_error_quark   (void);
+#define             NM_SETTING_IP6_CONFIG_METHOD
 #define             NM_SETTING_IP6_CONFIG_DNS
 #define             NM_SETTING_IP6_CONFIG_DNS_SEARCH
-#define             NM_SETTING_IP6_CONFIG_ERROR
-#define             NM_SETTING_IP6_CONFIG_IGNORE_AUTO_DNS
+#define             NM_SETTING_IP6_CONFIG_ADDRESSES
+#define             NM_SETTING_IP6_CONFIG_ROUTES
 #define             NM_SETTING_IP6_CONFIG_IGNORE_AUTO_ROUTES
-#define             NM_SETTING_IP6_CONFIG_IP6_PRIVACY
+#define             NM_SETTING_IP6_CONFIG_IGNORE_AUTO_DNS
+#define             NM_SETTING_IP6_CONFIG_NEVER_DEFAULT
 #define             NM_SETTING_IP6_CONFIG_MAY_FAIL
-#define             NM_SETTING_IP6_CONFIG_METHOD
+#define             NM_SETTING_IP6_CONFIG_IP6_PRIVACY
+#define             NM_SETTING_IP6_CONFIG_DHCP_HOSTNAME
+#define             NM_SETTING_IP6_CONFIG_METHOD_IGNORE
 #define             NM_SETTING_IP6_CONFIG_METHOD_AUTO
 #define             NM_SETTING_IP6_CONFIG_METHOD_DHCP
-#define             NM_SETTING_IP6_CONFIG_METHOD_IGNORE
 #define             NM_SETTING_IP6_CONFIG_METHOD_LINK_LOCAL
 #define             NM_SETTING_IP6_CONFIG_METHOD_MANUAL
 #define             NM_SETTING_IP6_CONFIG_METHOD_SHARED
-#define             NM_SETTING_IP6_CONFIG_NEVER_DEFAULT
-#define             NM_SETTING_IP6_CONFIG_ROUTES
-#define             NM_SETTING_IP6_CONFIG_SETTING_NAME
+enum                NMSettingIP6ConfigPrivacy;
+typedef             NMIP6Address;
+NMIP6Address *      nm_ip6_address_new                  (void);
+NMIP6Address *      nm_ip6_address_dup                  (NMIP6Address *source);
+void                nm_ip6_address_ref                  (NMIP6Address *address);
+void                nm_ip6_address_unref                (NMIP6Address *address);
 gboolean            nm_ip6_address_compare              (NMIP6Address *address,
                                                          NMIP6Address *other);
-NMIP6Address *      nm_ip6_address_dup                  (NMIP6Address *source);
 const struct in6_addr * nm_ip6_address_get_address      (NMIP6Address *address);
-const struct in6_addr * nm_ip6_address_get_gateway      (NMIP6Address *address);
-guint32             nm_ip6_address_get_prefix           (NMIP6Address *address);
-NMIP6Address *      nm_ip6_address_new                  (void);
-void                nm_ip6_address_ref                  (NMIP6Address *address);
 void                nm_ip6_address_set_address          (NMIP6Address *address,
                                                          const struct in6_addr *addr);
-void                nm_ip6_address_set_gateway          (NMIP6Address *address,
-                                                         const struct in6_addr *gateway);
+guint32             nm_ip6_address_get_prefix           (NMIP6Address *address);
 void                nm_ip6_address_set_prefix           (NMIP6Address *address,
                                                          guint32 prefix);
-void                nm_ip6_address_unref                (NMIP6Address *address);
+const struct in6_addr * nm_ip6_address_get_gateway      (NMIP6Address *address);
+void                nm_ip6_address_set_gateway          (NMIP6Address *address,
+                                                         const struct in6_addr *gateway);
+typedef             NMIP6Route;
+NMIP6Route *        nm_ip6_route_new                    (void);
+NMIP6Route *        nm_ip6_route_dup                    (NMIP6Route *source);
+void                nm_ip6_route_ref                    (NMIP6Route *route);
+void                nm_ip6_route_unref                  (NMIP6Route *route);
 gboolean            nm_ip6_route_compare                (NMIP6Route *route,
                                                          NMIP6Route *other);
-NMIP6Route *        nm_ip6_route_dup                    (NMIP6Route *source);
 const struct in6_addr * nm_ip6_route_get_dest           (NMIP6Route *route);
-guint32             nm_ip6_route_get_metric             (NMIP6Route *route);
-const struct in6_addr * nm_ip6_route_get_next_hop       (NMIP6Route *route);
-guint32             nm_ip6_route_get_prefix             (NMIP6Route *route);
-NMIP6Route *        nm_ip6_route_new                    (void);
-void                nm_ip6_route_ref                    (NMIP6Route *route);
 void                nm_ip6_route_set_dest               (NMIP6Route *route,
                                                          const struct in6_addr *dest);
-void                nm_ip6_route_set_metric             (NMIP6Route *route,
-                                                         guint32 metric);
-void                nm_ip6_route_set_next_hop           (NMIP6Route *route,
-                                                         const struct in6_addr *next_hop);
+guint32             nm_ip6_route_get_prefix             (NMIP6Route *route);
 void                nm_ip6_route_set_prefix             (NMIP6Route *route,
                                                          guint32 prefix);
-void                nm_ip6_route_unref                  (NMIP6Route *route);
-gboolean            nm_setting_ip6_config_add_address   (NMSettingIP6Config *setting,
-                                                         NMIP6Address *address);
+const struct in6_addr * nm_ip6_route_get_next_hop       (NMIP6Route *route);
+void                nm_ip6_route_set_next_hop           (NMIP6Route *route,
+                                                         const struct in6_addr *next_hop);
+guint32             nm_ip6_route_get_metric             (NMIP6Route *route);
+void                nm_ip6_route_set_metric             (NMIP6Route *route,
+                                                         guint32 metric);
+                    NMSettingIP6Config;
+                    NMSettingIP6ConfigClass;
+NMSetting *         nm_setting_ip6_config_new           (void);
+const char *        nm_setting_ip6_config_get_method    (NMSettingIP6Config *setting);
+guint32             nm_setting_ip6_config_get_num_dns   (NMSettingIP6Config *setting);
+const struct in6_addr * nm_setting_ip6_config_get_dns   (NMSettingIP6Config *setting,
+                                                         guint32 i);
 gboolean            nm_setting_ip6_config_add_dns       (NMSettingIP6Config *setting,
                                                          const struct in6_addr *dns);
+void                nm_setting_ip6_config_remove_dns    (NMSettingIP6Config *setting,
+                                                         guint32 i);
+void                nm_setting_ip6_config_clear_dns     (NMSettingIP6Config *setting);
+guint32             nm_setting_ip6_config_get_num_dns_searches
+                                                        (NMSettingIP6Config *setting);
+const char *        nm_setting_ip6_config_get_dns_search
+                                                        (NMSettingIP6Config *setting,
+                                                         guint32 i);
 gboolean            nm_setting_ip6_config_add_dns_search
                                                         (NMSettingIP6Config *setting,
                                                          const char *dns_search);
-gboolean            nm_setting_ip6_config_add_route     (NMSettingIP6Config *setting,
-                                                         NMIP6Route *route);
-void                nm_setting_ip6_config_clear_addresses
-                                                        (NMSettingIP6Config *setting);
-void                nm_setting_ip6_config_clear_dns     (NMSettingIP6Config *setting);
+void                nm_setting_ip6_config_remove_dns_search
+                                                        (NMSettingIP6Config *setting,
+                                                         guint32 i);
 void                nm_setting_ip6_config_clear_dns_searches
                                                         (NMSettingIP6Config *setting);
-void                nm_setting_ip6_config_clear_routes  (NMSettingIP6Config *setting);
-GQuark              nm_setting_ip6_config_error_quark   (void);
-NMIP6Address *      nm_setting_ip6_config_get_address   (NMSettingIP6Config *setting,
-                                                         guint32 i);
-const char *        nm_setting_ip6_config_get_dhcp_hostname
+guint32             nm_setting_ip6_config_get_num_addresses
                                                         (NMSettingIP6Config *setting);
-const struct in6_addr * nm_setting_ip6_config_get_dns   (NMSettingIP6Config *setting,
+NMIP6Address *      nm_setting_ip6_config_get_address   (NMSettingIP6Config *setting,
                                                          guint32 i);
-const char *        nm_setting_ip6_config_get_dns_search
+gboolean            nm_setting_ip6_config_add_address   (NMSettingIP6Config *setting,
+                                                         NMIP6Address *address);
+void                nm_setting_ip6_config_remove_address
                                                         (NMSettingIP6Config *setting,
                                                          guint32 i);
-gboolean            nm_setting_ip6_config_get_ignore_auto_dns
-                                                        (NMSettingIP6Config *setting);
-gboolean            nm_setting_ip6_config_get_ignore_auto_routes
-                                                        (NMSettingIP6Config *setting);
-NMSettingIP6ConfigPrivacy nm_setting_ip6_config_get_ip6_privacy
-                                                        (NMSettingIP6Config *setting);
-gboolean            nm_setting_ip6_config_get_may_fail  (NMSettingIP6Config *setting);
-const char *        nm_setting_ip6_config_get_method    (NMSettingIP6Config *setting);
-gboolean            nm_setting_ip6_config_get_never_default
-                                                        (NMSettingIP6Config *setting);
-guint32             nm_setting_ip6_config_get_num_addresses
-                                                        (NMSettingIP6Config *setting);
-guint32             nm_setting_ip6_config_get_num_dns   (NMSettingIP6Config *setting);
-guint32             nm_setting_ip6_config_get_num_dns_searches
+void                nm_setting_ip6_config_clear_addresses
                                                         (NMSettingIP6Config *setting);
 guint32             nm_setting_ip6_config_get_num_routes
                                                         (NMSettingIP6Config *setting);
 NMIP6Route *        nm_setting_ip6_config_get_route     (NMSettingIP6Config *setting,
                                                          guint32 i);
-NMSetting *         nm_setting_ip6_config_new           (void);
-void                nm_setting_ip6_config_remove_address
-                                                        (NMSettingIP6Config *setting,
-                                                         guint32 i);
-void                nm_setting_ip6_config_remove_dns    (NMSettingIP6Config *setting,
-                                                         guint32 i);
-void                nm_setting_ip6_config_remove_dns_search
-                                                        (NMSettingIP6Config *setting,
-                                                         guint32 i);
+gboolean            nm_setting_ip6_config_add_route     (NMSettingIP6Config *setting,
+                                                         NMIP6Route *route);
 void                nm_setting_ip6_config_remove_route  (NMSettingIP6Config *setting,
                                                          guint32 i);
+void                nm_setting_ip6_config_clear_routes  (NMSettingIP6Config *setting);
+gboolean            nm_setting_ip6_config_get_ignore_auto_routes
+                                                        (NMSettingIP6Config *setting);
+gboolean            nm_setting_ip6_config_get_ignore_auto_dns
+                                                        (NMSettingIP6Config *setting);
+const char *        nm_setting_ip6_config_get_dhcp_hostname
+                                                        (NMSettingIP6Config *setting);
+gboolean            nm_setting_ip6_config_get_never_default
+                                                        (NMSettingIP6Config *setting);
+gboolean            nm_setting_ip6_config_get_may_fail  (NMSettingIP6Config *setting);
+NMSettingIP6ConfigPrivacy nm_setting_ip6_config_get_ip6_privacy
+                                                        (NMSettingIP6Config *setting);
 

Object Hierarchy

+
+  GEnum
+   +----NMSettingIP6ConfigError
+
+
+  GEnum
+   +----NMSettingIP6ConfigPrivacy
+
   GBoxed
    +----NMIP6Address
@@ -174,14 +182,6 @@ const char *        NMSetting
          +----NMSettingIP6Config
 
-
-  GEnum
-   +----NMSettingIP6ConfigError
-
-
-  GEnum
-   +----NMSettingIP6ConfigPrivacy
-

Properties

@@ -209,39 +209,8 @@ properties related to IPv6 addressing, routing, and Domain Name Service

Details

-

NMIP6Address

-
typedef struct NMIP6Address NMIP6Address;
-
-

-

-
-
-
-

NMIP6Route

-
typedef struct NMIP6Route NMIP6Route;
-
-

-

-
-
-
-

NMSettingIP6Config

-
typedef struct _NMSettingIP6Config NMSettingIP6Config;
-

-

-
-
-
-

NMSettingIP6ConfigClass

-
typedef struct {
-	NMSettingClass parent;
-
-	/* Padding for future expansion */
-	void (*_reserved1) (void);
-	void (*_reserved2) (void);
-	void (*_reserved3) (void);
-	void (*_reserved4) (void);
-} NMSettingIP6ConfigClass;
+

NM_SETTING_IP6_CONFIG_SETTING_NAME

+
#define NM_SETTING_IP6_CONFIG_SETTING_NAME "ipv6"
 

@@ -256,8 +225,11 @@ properties related to IPv6 addressing, routing, and Domain Name Service NM_SETTING_IP6_CONFIG_ERROR_NOT_ALLOWED_FOR_METHOD /*< nick=NotAllowedForMethod >*/ } NMSettingIP6ConfigError;
-
+
+++ @@ -286,58 +258,34 @@ not valid with the given IPv6 method
-

enum NMSettingIP6ConfigPrivacy

-
typedef enum {
-	NM_SETTING_IP6_CONFIG_PRIVACY_UNKNOWN = -1,
-	NM_SETTING_IP6_CONFIG_PRIVACY_DISABLED = 0,
-	NM_SETTING_IP6_CONFIG_PRIVACY_PREFER_PUBLIC_ADDR = 1,
-	NM_SETTING_IP6_CONFIG_PRIVACY_PREFER_TEMP_ADDR = 2
-} NMSettingIP6ConfigPrivacy;
+

NM_SETTING_IP6_CONFIG_ERROR

+
#define NM_SETTING_IP6_CONFIG_ERROR nm_setting_ip6_config_error_quark ()
 

-NMSettingIP6ConfigPrivacy values indicate if and how IPv6 Privacy -Extensions are used (RFC4941).

-

NM_SETTING_IP6_CONFIG_ERROR_UNKNOWN

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

NM_SETTING_IP6_CONFIG_PRIVACY_UNKNOWN

unknown or no value specified -

NM_SETTING_IP6_CONFIG_PRIVACY_DISABLED

IPv6 Privacy Extensions are disabled -

NM_SETTING_IP6_CONFIG_PRIVACY_PREFER_PUBLIC_ADDR

IPv6 Privacy Extensions -are enabled, but public addresses are preferred over temporary addresses -

NM_SETTING_IP6_CONFIG_PRIVACY_PREFER_TEMP_ADDR

IPv6 Privacy Extensions -are enabled and temporary addresses are preferred over public addresses -

-

NM_SETTING_IP6_CONFIG_ADDRESSES

-
#define NM_SETTING_IP6_CONFIG_ADDRESSES          "addresses"
-
+

nm_setting_ip6_config_error_quark ()

+
GQuark              nm_setting_ip6_config_error_quark   (void);

+Registers an error quark for NMSettingIP6Config if necessary.

+
++++ + + + + +

Returns :

the error quark used for NMSettingIP6Config errors.

-

NM_SETTING_IP6_CONFIG_DHCP_HOSTNAME

-
#define NM_SETTING_IP6_CONFIG_DHCP_HOSTNAME      "dhcp-hostname"
+

NM_SETTING_IP6_CONFIG_METHOD

+
#define NM_SETTING_IP6_CONFIG_METHOD             "method"
 

@@ -360,16 +308,16 @@ are enabled and temporary addresses are preferred over public addresses

-

NM_SETTING_IP6_CONFIG_ERROR

-
#define NM_SETTING_IP6_CONFIG_ERROR nm_setting_ip6_config_error_quark ()
+

NM_SETTING_IP6_CONFIG_ADDRESSES

+
#define NM_SETTING_IP6_CONFIG_ADDRESSES          "addresses"
 


-

NM_SETTING_IP6_CONFIG_IGNORE_AUTO_DNS

-
#define NM_SETTING_IP6_CONFIG_IGNORE_AUTO_DNS    "ignore-auto-dns"
+

NM_SETTING_IP6_CONFIG_ROUTES

+
#define NM_SETTING_IP6_CONFIG_ROUTES             "routes"
 

@@ -384,8 +332,16 @@ are enabled and temporary addresses are preferred over public addresses

-

NM_SETTING_IP6_CONFIG_IP6_PRIVACY

-
#define NM_SETTING_IP6_CONFIG_IP6_PRIVACY        "ip6-privacy"
+

NM_SETTING_IP6_CONFIG_IGNORE_AUTO_DNS

+
#define NM_SETTING_IP6_CONFIG_IGNORE_AUTO_DNS    "ignore-auto-dns"
+
+

+

+
+
+
+

NM_SETTING_IP6_CONFIG_NEVER_DEFAULT

+
#define NM_SETTING_IP6_CONFIG_NEVER_DEFAULT      "never-default"
 

@@ -400,10 +356,28 @@ are enabled and temporary addresses are preferred over public addresses

-

NM_SETTING_IP6_CONFIG_METHOD

-
#define NM_SETTING_IP6_CONFIG_METHOD             "method"
+

NM_SETTING_IP6_CONFIG_IP6_PRIVACY

+
#define NM_SETTING_IP6_CONFIG_IP6_PRIVACY        "ip6-privacy"
+
+

+

+
+
+
+

NM_SETTING_IP6_CONFIG_DHCP_HOSTNAME

+
#define NM_SETTING_IP6_CONFIG_DHCP_HOSTNAME      "dhcp-hostname"
+
+

+

+
+
+
+

NM_SETTING_IP6_CONFIG_METHOD_IGNORE

+
#define NM_SETTING_IP6_CONFIG_METHOD_IGNORE     "ignore"
 

+IPv6 is not required or is handled by some other mechanism, and NetworkManager +should not configure IPv6 for this connection.


@@ -429,16 +403,6 @@ router advertisements should be ignored.

-

NM_SETTING_IP6_CONFIG_METHOD_IGNORE

-
#define NM_SETTING_IP6_CONFIG_METHOD_IGNORE     "ignore"
-
-

-IPv6 is not required or is handled by some other mechanism, and NetworkManager -should not configure IPv6 for this connection. -

-
-
-

NM_SETTING_IP6_CONFIG_METHOD_LINK_LOCAL

#define NM_SETTING_IP6_CONFIG_METHOD_LINK_LOCAL "link-local"
 
@@ -474,27 +438,139 @@ supported for IPv6)

-

NM_SETTING_IP6_CONFIG_NEVER_DEFAULT

-
#define NM_SETTING_IP6_CONFIG_NEVER_DEFAULT      "never-default"
+

enum NMSettingIP6ConfigPrivacy

+
typedef enum {
+	NM_SETTING_IP6_CONFIG_PRIVACY_UNKNOWN = -1,
+	NM_SETTING_IP6_CONFIG_PRIVACY_DISABLED = 0,
+	NM_SETTING_IP6_CONFIG_PRIVACY_PREFER_PUBLIC_ADDR = 1,
+	NM_SETTING_IP6_CONFIG_PRIVACY_PREFER_TEMP_ADDR = 2
+} NMSettingIP6ConfigPrivacy;
 

+NMSettingIP6ConfigPrivacy values indicate if and how IPv6 Privacy +Extensions are used (RFC4941).

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

NM_SETTING_IP6_CONFIG_PRIVACY_UNKNOWN

unknown or no value specified +

NM_SETTING_IP6_CONFIG_PRIVACY_DISABLED

IPv6 Privacy Extensions are disabled +

NM_SETTING_IP6_CONFIG_PRIVACY_PREFER_PUBLIC_ADDR

IPv6 Privacy Extensions +are enabled, but public addresses are preferred over temporary addresses +

NM_SETTING_IP6_CONFIG_PRIVACY_PREFER_TEMP_ADDR

IPv6 Privacy Extensions +are enabled and temporary addresses are preferred over public addresses +

-

NM_SETTING_IP6_CONFIG_ROUTES

-
#define NM_SETTING_IP6_CONFIG_ROUTES             "routes"
+

NMIP6Address

+
typedef struct NMIP6Address NMIP6Address;
 


-

NM_SETTING_IP6_CONFIG_SETTING_NAME

-
#define NM_SETTING_IP6_CONFIG_SETTING_NAME "ipv6"
-
+

nm_ip6_address_new ()

+
NMIP6Address *      nm_ip6_address_new                  (void);
+

+Creates and returns a new NMIP6Address object. +

+
++++ + + + + +

Returns :

the new empty NMIP6Address object. [transfer full] +
+
+
+
+

nm_ip6_address_dup ()

+
NMIP6Address *      nm_ip6_address_dup                  (NMIP6Address *source);
+

+Copies a given NMIP6Address object and returns the copy. +

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

source :

the NMIP6Address object to copy

Returns :

the copy of the given NMIP6Address copy. [transfer full] +
+
+
+
+

nm_ip6_address_ref ()

+
void                nm_ip6_address_ref                  (NMIP6Address *address);
+

+Increases the reference count of the object. +

+
++++ + + + + +

address :

the NMIP6Address +
+
+
+
+

nm_ip6_address_unref ()

+
void                nm_ip6_address_unref                (NMIP6Address *address);

+Decreases the reference count of the object. If the reference count +reaches zero, the object will be destroyed.

+
++++ + + + + +

address :

the NMIP6Address +

@@ -504,8 +580,11 @@ supported for IPv6)

Determines if two NMIP6Address objects contain the same values.

-
+
+++ @@ -526,35 +605,16 @@ Determines if two
-

nm_ip6_address_dup ()

-
NMIP6Address *      nm_ip6_address_dup                  (NMIP6Address *source);
-

-Copies a given NMIP6Address object and returns the copy. -

-

address :

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

source :

the NMIP6Address object to copy

Returns :

the copy of the given NMIP6Address copy. [transfer full] -
-
-
-

nm_ip6_address_get_address ()

const struct in6_addr * nm_ip6_address_get_address      (NMIP6Address *address);

Gets the IPv6 address property of this address object.

-
+
+++ @@ -571,13 +631,17 @@ Gets the IPv6 address property of this address object.
-

nm_ip6_address_get_gateway ()

-
const struct in6_addr * nm_ip6_address_get_gateway      (NMIP6Address *address);
+

nm_ip6_address_set_address ()

+
void                nm_ip6_address_set_address          (NMIP6Address *address,
+                                                         const struct in6_addr *addr);

-Gets the IPv6 default gateway property of this address object. +Sets the IPv6 address property of this object.

-

address :

+
+++ @@ -585,9 +649,8 @@ Gets the IPv6 default gateway property of this address object. - - + +

address :

Returns :

the IPv6 gateway address. [transfer none] -

addr :

the IPv6 address
@@ -599,8 +662,11 @@ Gets the IPv6 default gateway property of this address object.

Gets the IPv6 address prefix property of this address object.

-
+
+++ @@ -616,46 +682,42 @@ Gets the IPv6 address prefix property of this address object.
-

nm_ip6_address_new ()

-
NMIP6Address *      nm_ip6_address_new                  (void);
-

-Creates and returns a new NMIP6Address object. -

-

address :

-- - - - -

Returns :

the new empty NMIP6Address object. [transfer full] -
-
-
-
-

nm_ip6_address_ref ()

-
void                nm_ip6_address_ref                  (NMIP6Address *address);
+

nm_ip6_address_set_prefix ()

+
void                nm_ip6_address_set_prefix           (NMIP6Address *address,
+                                                         guint32 prefix);

-Increases the reference count of the object. +Sets the IPv6 address prefix.

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

address :

the NMIP6Address

prefix :

the address prefix, a number between 0 and 128 inclusive

-

nm_ip6_address_set_address ()

-
void                nm_ip6_address_set_address          (NMIP6Address *address,
-                                                         const struct in6_addr *addr);
+

nm_ip6_address_get_gateway ()

+
const struct in6_addr * nm_ip6_address_get_gateway      (NMIP6Address *address);

-Sets the IPv6 address property of this object. +Gets the IPv6 default gateway property of this address object.

-
+
+++ @@ -663,8 +725,9 @@ Sets the IPv6 address property of this object. - - + +

address :

addr :

the IPv6 address

Returns :

the IPv6 gateway address. [transfer none] +
@@ -677,8 +740,11 @@ Sets the IPv6 address property of this object.

Sets the IPv6 default gateway property of this address object.

-
+
+++ @@ -694,40 +760,91 @@ Sets the IPv6 default gateway property of this address object.
-

nm_ip6_address_set_prefix ()

-
void                nm_ip6_address_set_prefix           (NMIP6Address *address,
-                                                         guint32 prefix);
+

NMIP6Route

+
typedef struct NMIP6Route NMIP6Route;
+

-Sets the IPv6 address prefix.

-

address :

+ +
+
+

nm_ip6_route_new ()

+
NMIP6Route *        nm_ip6_route_new                    (void);
+

+Creates and returns a new NMIP6Route object. +

+
+++ + + + + +

Returns :

the new empty NMIP6Route object. [transfer full] +
+
+
+
+

nm_ip6_route_dup ()

+
NMIP6Route *        nm_ip6_route_dup                    (NMIP6Route *source);
+

+Copies a given NMIP6Route object and returns the copy. +

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

address :

the NMIP6Address -

source :

the NMIP6Route object to copy

prefix :

the address prefix, a number between 0 and 128 inclusive

Returns :

the copy of the given NMIP6Route copy. [transfer full] +

-

nm_ip6_address_unref ()

-
void                nm_ip6_address_unref                (NMIP6Address *address);
+

nm_ip6_route_ref ()

+
void                nm_ip6_route_ref                    (NMIP6Route *route);
+

+Increases the reference count of the object. +

+
++++ + + + + +

route :

the NMIP6Route +
+
+
+
+

nm_ip6_route_unref ()

+
void                nm_ip6_route_unref                  (NMIP6Route *route);

Decreases the reference count of the object. If the reference count reaches zero, the object will be destroyed.

-
+
+++ - - +

address :

the NMIP6Address +

route :

the NMIP6Route
@@ -740,8 +857,11 @@ reaches zero, the object will be destroyed.

Determines if two NMIP6Route objects contain the same values.

-
+
+++ @@ -762,35 +882,42 @@ Determines if two
-

nm_ip6_route_dup ()

-
NMIP6Route *        nm_ip6_route_dup                    (NMIP6Route *source);
+

nm_ip6_route_get_dest ()

+
const struct in6_addr * nm_ip6_route_get_dest           (NMIP6Route *route);

-Copies a given NMIP6Route object and returns the copy. +Gets the IPv6 destination address property of this route object.

-

route :

+
+++ - - + + - +

source :

the NMIP6Route object to copy

route :

the NMIP6Route +

Returns :

the copy of the given NMIP6Route copy. [transfer full] -the IPv6 address

-

nm_ip6_route_get_dest ()

-
const struct in6_addr * nm_ip6_route_get_dest           (NMIP6Route *route);
+

nm_ip6_route_set_dest ()

+
void                nm_ip6_route_set_dest               (NMIP6Route *route,
+                                                         const struct in6_addr *dest);

-Gets the IPv6 destination address property of this route object. +Sets the IPv6 destination address property of this route object.

-
+
+++ @@ -798,22 +925,24 @@ Gets the IPv6 destination address property of this route object. - - + +

route :

Returns :

the IPv6 address

dest :

the destination address

-

nm_ip6_route_get_metric ()

-
guint32             nm_ip6_route_get_metric             (NMIP6Route *route);
+

nm_ip6_route_get_prefix ()

+
guint32             nm_ip6_route_get_prefix             (NMIP6Route *route);

-Gets the route metric property of this route object; lower values indicate -"better" or more preferred routes. +Gets the IPv6 prefix (ie "32" or "64" etc) of this route.

-
+
+++ @@ -822,20 +951,24 @@ Gets the route metric property of this route object; lower values indicate - +

route :

Returns :

the route metricthe IPv6 prefix

-

nm_ip6_route_get_next_hop ()

-
const struct in6_addr * nm_ip6_route_get_next_hop       (NMIP6Route *route);
+

nm_ip6_route_set_prefix ()

+
void                nm_ip6_route_set_prefix             (NMIP6Route *route,
+                                                         guint32 prefix);

-Gets the IPv6 address of the next hop of this route. +Sets the IPv6 prefix of this route.

-
+
+++ @@ -843,21 +976,24 @@ Gets the IPv6 address of the next hop of this route. - - + +

route :

Returns :

the IPv6 address

prefix :

the prefix, a number between 1 and 128 inclusive

-

nm_ip6_route_get_prefix ()

-
guint32             nm_ip6_route_get_prefix             (NMIP6Route *route);
+

nm_ip6_route_get_next_hop ()

+
const struct in6_addr * nm_ip6_route_get_next_hop       (NMIP6Route *route);

-Gets the IPv6 prefix (ie "32" or "64" etc) of this route. +Gets the IPv6 address of the next hop of this route.

-
+
+++ @@ -866,53 +1002,50 @@ Gets the IPv6 prefix (ie "32" or "64" etc) of this route. - +

route :

Returns :

the IPv6 prefixthe IPv6 address

-

nm_ip6_route_new ()

-
NMIP6Route *        nm_ip6_route_new                    (void);
-

-Creates and returns a new NMIP6Route object. -

-
-- - - - -

Returns :

the new empty NMIP6Route object. [transfer full] -
-
-
-
-

nm_ip6_route_ref ()

-
void                nm_ip6_route_ref                    (NMIP6Route *route);
+

nm_ip6_route_set_next_hop ()

+
void                nm_ip6_route_set_next_hop           (NMIP6Route *route,
+                                                         const struct in6_addr *next_hop);

-Increases the reference count of the object. +Sets the IPv6 address of the next hop of this route.

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

route :

the NMIP6Route

next_hop :

the IPv6 address of the next hop

-

nm_ip6_route_set_dest ()

-
void                nm_ip6_route_set_dest               (NMIP6Route *route,
-                                                         const struct in6_addr *dest);
+

nm_ip6_route_get_metric ()

+
guint32             nm_ip6_route_get_metric             (NMIP6Route *route);

-Sets the IPv6 destination address property of this route object. +Gets the route metric property of this route object; lower values indicate +"better" or more preferred routes.

-
+
+++ @@ -920,8 +1053,8 @@ Sets the IPv6 destination address property of this route object. - - + +

route :

dest :

the destination address

Returns :

the route metric
@@ -935,8 +1068,11 @@ Sets the IPv6 destination address property of this route object. Sets the route metric property of this route object; lower values indicate "better" or more preferred routes.

-
+
+++ @@ -952,78 +1088,55 @@ Sets the route metric property of this route object; lower values indicate
-

nm_ip6_route_set_next_hop ()

-
void                nm_ip6_route_set_next_hop           (NMIP6Route *route,
-                                                         const struct in6_addr *next_hop);
+

NMSettingIP6Config

+
typedef struct _NMSettingIP6Config NMSettingIP6Config;

-Sets the IPv6 address of the next hop of this route.

-

route :

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

route :

the NMIP6Route -

next_hop :

the IPv6 address of the next hop

-

nm_ip6_route_set_prefix ()

-
void                nm_ip6_route_set_prefix             (NMIP6Route *route,
-                                                         guint32 prefix);
+

NMSettingIP6ConfigClass

+
typedef struct {
+	NMSettingClass parent;
+
+	/* Padding for future expansion */
+	void (*_reserved1) (void);
+	void (*_reserved2) (void);
+	void (*_reserved3) (void);
+	void (*_reserved4) (void);
+} NMSettingIP6ConfigClass;
+

-Sets the IPv6 prefix of this route.

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

route :

the NMIP6Route -

prefix :

the prefix, a number between 1 and 128 inclusive

-

nm_ip6_route_unref ()

-
void                nm_ip6_route_unref                  (NMIP6Route *route);
+

nm_setting_ip6_config_new ()

+
NMSetting *         nm_setting_ip6_config_new           (void);

-Decreases the reference count of the object. If the reference count -reaches zero, the object will be destroyed. +Creates a new NMSettingIP6Config object with default values.

-
+
+++ - - +

route :

the NMIP6Route +

Returns :

the new empty NMSettingIP6Config object. [transfer full]

-

nm_setting_ip6_config_add_address ()

-
gboolean            nm_setting_ip6_config_add_address   (NMSettingIP6Config *setting,
-                                                         NMIP6Address *address);
-

-Adds a new IPv6 address and associated information to the setting. The -given address is duplicated internally and is not changed by this function. -

-
+

nm_setting_ip6_config_get_method ()

+
const char *        nm_setting_ip6_config_get_method    (NMSettingIP6Config *setting);
+
+++ @@ -1031,28 +1144,21 @@ given address is duplicated internally and is not changed by this function. - - - - - +

setting :

address :

the new address to add

Returns :

-TRUE if the address was added; FALSE if the address was already -known.the "method" property of the setting

-

nm_setting_ip6_config_add_dns ()

-
gboolean            nm_setting_ip6_config_add_dns       (NMSettingIP6Config *setting,
-                                                         const struct in6_addr *dns);
-

-Adds a new DNS server to the setting. -

-
+

nm_setting_ip6_config_get_num_dns ()

+
guint32             nm_setting_ip6_config_get_num_dns   (NMSettingIP6Config *setting);
+
+++ @@ -1060,29 +1166,22 @@ Adds a new DNS server to the setting. - - - - - +

setting :

dns :

the IPv6 address of the DNS server to add

Returns :

-TRUE if the DNS server was added; FALSE if the server was already -knownthe number of configured DNS servers

-

nm_setting_ip6_config_add_dns_search ()

-
gboolean            nm_setting_ip6_config_add_dns_search
-                                                        (NMSettingIP6Config *setting,
-                                                         const char *dns_search);
-

-Adds a new DNS search domain to the setting. -

-
+

nm_setting_ip6_config_get_dns ()

+
const struct in6_addr * nm_setting_ip6_config_get_dns   (NMSettingIP6Config *setting,
+                                                         guint32 i);
+
+++ @@ -1090,29 +1189,30 @@ Adds a new DNS search domain to the setting. - - + + - +

setting :

dns_search :

the search domain to add

i :

index number of the DNS server to return

Returns :

-TRUE if the DNS search domain was added; FALSE if the search -domain was already knownthe IPv6 address of the DNS server at index i. [transfer none] +

-

nm_setting_ip6_config_add_route ()

-
gboolean            nm_setting_ip6_config_add_route     (NMSettingIP6Config *setting,
-                                                         NMIP6Route *route);
+

nm_setting_ip6_config_add_dns ()

+
gboolean            nm_setting_ip6_config_add_dns       (NMSettingIP6Config *setting,
+                                                         const struct in6_addr *dns);

-Adds a new IPv6 route and associated information to the setting. The -given route is duplicated internally and is not changed by this function. +Adds a new DNS server to the setting.

-
+
+++ @@ -1120,32 +1220,42 @@ given route is duplicated internally and is not changed by this function. - - + + +TRUE if the DNS server was added; FALSE if the server was already +known

setting :

route :

the route to add

dns :

the IPv6 address of the DNS server to add

Returns :

-TRUE if the route was added; FALSE if the route was already known.

-

nm_setting_ip6_config_clear_addresses ()

-
void                nm_setting_ip6_config_clear_addresses
-                                                        (NMSettingIP6Config *setting);
+

nm_setting_ip6_config_remove_dns ()

+
void                nm_setting_ip6_config_remove_dns    (NMSettingIP6Config *setting,
+                                                         guint32 i);

-Removes all configured addresses. +Removes the DNS server at index i.

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

setting :

the NMSettingIP6Config

i :

index number of the DNS server to remove

@@ -1155,8 +1265,11 @@ Removes all configured addresses.

Removes all configured DNS servers.

-
+
+++

setting :

the NMSettingIP6Config @@ -1166,59 +1279,70 @@ Removes all configured DNS servers.
-

nm_setting_ip6_config_clear_dns_searches ()

-
void                nm_setting_ip6_config_clear_dns_searches
+

nm_setting_ip6_config_get_num_dns_searches ()

+
guint32             nm_setting_ip6_config_get_num_dns_searches
                                                         (NMSettingIP6Config *setting);
-

-Removes all configured DNS search domains. -

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

setting :

the NMSettingIP6Config

Returns :

the number of configured DNS search domains

-

nm_setting_ip6_config_clear_routes ()

-
void                nm_setting_ip6_config_clear_routes  (NMSettingIP6Config *setting);
-

-Removes all configured routes. -

-
+

nm_setting_ip6_config_get_dns_search ()

+
const char *        nm_setting_ip6_config_get_dns_search
+                                                        (NMSettingIP6Config *setting,
+                                                         guint32 i);
+
+- ++ + + - + + + + + + + + + +

setting :

the NMSettingIP6Config

i :

index number of the DNS search domain to return

Returns :

the DNS search domain at index i +

-

nm_setting_ip6_config_error_quark ()

-
GQuark              nm_setting_ip6_config_error_quark   (void);
+

nm_setting_ip6_config_add_dns_search ()

+
gboolean            nm_setting_ip6_config_add_dns_search
+                                                        (NMSettingIP6Config *setting,
+                                                         const char *dns_search);

-Registers an error quark for NMSettingIP6Config if necessary. +Adds a new DNS search domain to the setting.

-
-- - - - -

Returns :

the error quark used for NMSettingIP6Config errors.
-
-
-
-

nm_setting_ip6_config_get_address ()

-
NMIP6Address *      nm_setting_ip6_config_get_address   (NMSettingIP6Config *setting,
-                                                         guint32 i);
-
+
+++ @@ -1226,28 +1350,32 @@ Registers an error quark for - - + + - +

setting :

i :

index number of the address to return

dns_search :

the search domain to add

Returns :

the address at index i - +TRUE if the DNS search domain was added; FALSE if the search +domain was already known

-

nm_setting_ip6_config_get_dhcp_hostname ()

-
const char *        nm_setting_ip6_config_get_dhcp_hostname
-                                                        (NMSettingIP6Config *setting);
+

nm_setting_ip6_config_remove_dns_search ()

+
void                nm_setting_ip6_config_remove_dns_search
+                                                        (NMSettingIP6Config *setting,
+                                                         guint32 i);

-Returns the value contained in the "dhcp-hostname" -property. +Removes the DNS search domain at index i.

-
+
+++ @@ -1255,20 +1383,42 @@ property. - - + +

setting :

Returns :

the configured hostname to send to the DHCP server

i :

index number of the DNS search domain
-

Since 0.9.8


-

nm_setting_ip6_config_get_dns ()

-
const struct in6_addr * nm_setting_ip6_config_get_dns   (NMSettingIP6Config *setting,
-                                                         guint32 i);
-
+

nm_setting_ip6_config_clear_dns_searches ()

+
void                nm_setting_ip6_config_clear_dns_searches
+                                                        (NMSettingIP6Config *setting);
+

+Removes all configured DNS search domains. +

+
++++ + + + + +

setting :

the NMSettingIP6Config +
+
+
+
+

nm_setting_ip6_config_get_num_addresses ()

+
guint32             nm_setting_ip6_config_get_num_addresses
+                                                        (NMSettingIP6Config *setting);
+
+++ @@ -1276,25 +1426,22 @@ property. - - - - - +

setting :

i :

index number of the DNS server to return

Returns :

the IPv6 address of the DNS server at index i. [transfer none] -the number of configured addresses

-

nm_setting_ip6_config_get_dns_search ()

-
const char *        nm_setting_ip6_config_get_dns_search
-                                                        (NMSettingIP6Config *setting,
+

nm_setting_ip6_config_get_address ()

+
NMIP6Address *      nm_setting_ip6_config_get_address   (NMSettingIP6Config *setting,
                                                          guint32 i);
-
+
+++ @@ -1303,11 +1450,11 @@ property. - + - @@ -1315,15 +1462,18 @@ property.
-

nm_setting_ip6_config_get_ignore_auto_dns ()

-
gboolean            nm_setting_ip6_config_get_ignore_auto_dns
-                                                        (NMSettingIP6Config *setting);
+

nm_setting_ip6_config_add_address ()

+
gboolean            nm_setting_ip6_config_add_address   (NMSettingIP6Config *setting,
+                                                         NMIP6Address *address);

-Returns the value contained in the "ignore-auto-dns" -property. +Adds a new IPv6 address and associated information to the setting. The +given address is duplicated internally and is not changed by this function.

-

setting :

i :

index number of the DNS search domain to returnindex number of the address to return

Returns :

the DNS search domain at index i +the address at index i
+
+++ @@ -1331,25 +1481,32 @@ property. + + + + +TRUE if the address was added; FALSE if the address was already +known.

setting :

address :

the new address to add

Returns :

-TRUE if automatically configured (ie via DHCP or router -advertisements) DNS information should be ignored.

-

nm_setting_ip6_config_get_ignore_auto_routes ()

-
gboolean            nm_setting_ip6_config_get_ignore_auto_routes
-                                                        (NMSettingIP6Config *setting);
+

nm_setting_ip6_config_remove_address ()

+
void                nm_setting_ip6_config_remove_address
+                                                        (NMSettingIP6Config *setting,
+                                                         guint32 i);

-Returns the value contained in the "ignore-auto-routes" -property. +Removes the address at index i.

-
+
+++ @@ -1357,48 +1514,42 @@ property. - - + +

setting :

Returns :

-TRUE if automatically configured (ie via DHCP) routes should be -ignored.

i :

index number of the address to remove

-

nm_setting_ip6_config_get_ip6_privacy ()

-
NMSettingIP6ConfigPrivacy nm_setting_ip6_config_get_ip6_privacy
+

nm_setting_ip6_config_clear_addresses ()

+
void                nm_setting_ip6_config_clear_addresses
                                                         (NMSettingIP6Config *setting);

-Returns the value contained in the "ip6-privacy" -property. +Removes all configured addresses.

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

setting :

the NMSettingIP6Config

Returns :

IPv6 Privacy Extensions configuration value (NMSettingIP6ConfigPrivacy).

-

nm_setting_ip6_config_get_may_fail ()

-
gboolean            nm_setting_ip6_config_get_may_fail  (NMSettingIP6Config *setting);
-

-Returns the value contained in the "may-fail" -property. -

-
+

nm_setting_ip6_config_get_num_routes ()

+
guint32             nm_setting_ip6_config_get_num_routes
+                                                        (NMSettingIP6Config *setting);
+
+++ @@ -1407,19 +1558,21 @@ property. - +

setting :

Returns :

-TRUE if this connection doesn't require IPv6 addressing to complete -for the connection to succeed.the number of configured routes

-

nm_setting_ip6_config_get_method ()

-
const char *        nm_setting_ip6_config_get_method    (NMSettingIP6Config *setting);
-
+

nm_setting_ip6_config_get_route ()

+
NMIP6Route *        nm_setting_ip6_config_get_route     (NMSettingIP6Config *setting,
+                                                         guint32 i);
+
+++ @@ -1427,23 +1580,31 @@ for the connection to succeed. + + + + - +

setting :

i :

index number of the route to return

Returns :

the "method" property of the settingthe route at index i +

-

nm_setting_ip6_config_get_never_default ()

-
gboolean            nm_setting_ip6_config_get_never_default
-                                                        (NMSettingIP6Config *setting);
+

nm_setting_ip6_config_add_route ()

+
gboolean            nm_setting_ip6_config_add_route     (NMSettingIP6Config *setting,
+                                                         NMIP6Route *route);

-Returns the value contained in the "never-default" -property. +Adds a new IPv6 route and associated information to the setting. The +given route is duplicated internally and is not changed by this function.

-
+
+++ @@ -1451,40 +1612,30 @@ property. - - - - -

setting :

Returns :

-TRUE if this connection should never be the default connection -for IPv6 addressing
-
-
-
-

nm_setting_ip6_config_get_num_addresses ()

-
guint32             nm_setting_ip6_config_get_num_addresses
-                                                        (NMSettingIP6Config *setting);
-
-- - - - + + - +

setting :

the NMSettingIP6Config -

route :

the route to add

Returns :

the number of configured addresses +TRUE if the route was added; FALSE if the route was already known.

-

nm_setting_ip6_config_get_num_dns ()

-
guint32             nm_setting_ip6_config_get_num_dns   (NMSettingIP6Config *setting);
-
+

nm_setting_ip6_config_remove_route ()

+
void                nm_setting_ip6_config_remove_route  (NMSettingIP6Config *setting,
+                                                         guint32 i);
+

+Removes the route at index i. +

+
+++ @@ -1492,39 +1643,45 @@ for IPv6 addressing - - + +

setting :

Returns :

the number of configured DNS servers

i :

index number of the route

-

nm_setting_ip6_config_get_num_dns_searches ()

-
guint32             nm_setting_ip6_config_get_num_dns_searches
-                                                        (NMSettingIP6Config *setting);
-
+

nm_setting_ip6_config_clear_routes ()

+
void                nm_setting_ip6_config_clear_routes  (NMSettingIP6Config *setting);
+

+Removes all configured routes. +

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

setting :

the NMSettingIP6Config

Returns :

the number of configured DNS search domains

-

nm_setting_ip6_config_get_num_routes ()

-
guint32             nm_setting_ip6_config_get_num_routes
+

nm_setting_ip6_config_get_ignore_auto_routes ()

+
gboolean            nm_setting_ip6_config_get_ignore_auto_routes
                                                         (NMSettingIP6Config *setting);
-
+

+Returns the value contained in the "ignore-auto-routes" +property. +

+
+++ @@ -1533,18 +1690,27 @@ for IPv6 addressing - +

setting :

Returns :

the number of configured routes +TRUE if automatically configured (ie via DHCP) routes should be +ignored.

-

nm_setting_ip6_config_get_route ()

-
NMIP6Route *        nm_setting_ip6_config_get_route     (NMSettingIP6Config *setting,
-                                                         guint32 i);
-
+

nm_setting_ip6_config_get_ignore_auto_dns ()

+
gboolean            nm_setting_ip6_config_get_ignore_auto_dns
+                                                        (NMSettingIP6Config *setting);
+

+Returns the value contained in the "ignore-auto-dns" +property. +

+
+++ @@ -1552,44 +1718,28 @@ for IPv6 addressing - - - - - +

setting :

i :

index number of the route to return

Returns :

the route at index i - +TRUE if automatically configured (ie via DHCP or router +advertisements) DNS information should be ignored.

-

nm_setting_ip6_config_new ()

-
NMSetting *         nm_setting_ip6_config_new           (void);
-

-Creates a new NMSettingIP6Config object with default values. -

-
-- - - - -

Returns :

the new empty NMSettingIP6Config object. [transfer full] -
-
-
-
-

nm_setting_ip6_config_remove_address ()

-
void                nm_setting_ip6_config_remove_address
-                                                        (NMSettingIP6Config *setting,
-                                                         guint32 i);
+

nm_setting_ip6_config_get_dhcp_hostname ()

+
const char *        nm_setting_ip6_config_get_dhcp_hostname
+                                                        (NMSettingIP6Config *setting);

-Removes the address at index i. +Returns the value contained in the "dhcp-hostname" +property.

-
+
+++ @@ -1597,22 +1747,27 @@ Removes the address at index i. - - + +

setting :

i :

index number of the address to remove

Returns :

the configured hostname to send to the DHCP server
+

Since 0.9.8


-

nm_setting_ip6_config_remove_dns ()

-
void                nm_setting_ip6_config_remove_dns    (NMSettingIP6Config *setting,
-                                                         guint32 i);
+

nm_setting_ip6_config_get_never_default ()

+
gboolean            nm_setting_ip6_config_get_never_default
+                                                        (NMSettingIP6Config *setting);

-Removes the DNS server at index i. +Returns the value contained in the "never-default" +property.

-
+
+++ @@ -1620,23 +1775,27 @@ Removes the DNS server at index i. - - + +

setting :

i :

index number of the DNS server to remove

Returns :

+TRUE if this connection should never be the default connection +for IPv6 addressing

-

nm_setting_ip6_config_remove_dns_search ()

-
void                nm_setting_ip6_config_remove_dns_search
-                                                        (NMSettingIP6Config *setting,
-                                                         guint32 i);
+

nm_setting_ip6_config_get_may_fail ()

+
gboolean            nm_setting_ip6_config_get_may_fail  (NMSettingIP6Config *setting);

-Removes the DNS search domain at index i. +Returns the value contained in the "may-fail" +property.

-
+
+++ @@ -1644,22 +1803,28 @@ Removes the DNS search domain at index i - - + +

setting :

i :

index number of the DNS search domain

Returns :

+TRUE if this connection doesn't require IPv6 addressing to complete +for the connection to succeed.

-

nm_setting_ip6_config_remove_route ()

-
void                nm_setting_ip6_config_remove_route  (NMSettingIP6Config *setting,
-                                                         guint32 i);
+

nm_setting_ip6_config_get_ip6_privacy ()

+
NMSettingIP6ConfigPrivacy nm_setting_ip6_config_get_ip6_privacy
+                                                        (NMSettingIP6Config *setting);

-Removes the route at index i. +Returns the value contained in the "ip6-privacy" +property.

-
+
+++ @@ -1667,8 +1832,8 @@ Removes the route at index i. - - + +

setting :

i :

index number of the route

Returns :

IPv6 Privacy Extensions configuration value (NMSettingIP6ConfigPrivacy).
@@ -1765,7 +1930,7 @@ in some applications, on the other hand. The permitted values are: 0: disabled, 1: enabled (prefer public address), 2: enabled (prefer temporary addresses).

-

Allowed values: [G_MAXULONG,2]

+

Allowed values: [-1,2]

Default value: -1


@@ -1794,7 +1959,7 @@ of DHCP only, specify 'dhcp'; this method is only valid for ethernet- based hardware. If 'link-local' is specified, then an IPv6 link-local address will be assigned to the interface. If 'manual' is specified, static IP addressing is used and at least one IP address must be given -in the 'addresses' property. If 'ignored' is specified, IPv6 +in the 'addresses' property. If 'ignore' is specified, IPv6 configuration is not done. This property must be set. NOTE: the 'shared' method are not yet supported.

@@ -1829,6 +1994,6 @@ automatic configuration. Routes cannot be used with the 'shared' or + Generated by GTK-Doc V1.19 \ No newline at end of file diff --git a/docs/libnm-util/html/NMSettingInfiniband.html b/docs/libnm-util/html/NMSettingInfiniband.html index 03755208..a5c4b46c 100644 --- a/docs/libnm-util/html/NMSettingInfiniband.html +++ b/docs/libnm-util/html/NMSettingInfiniband.html @@ -3,12 +3,12 @@ NMSettingInfiniband - + - + @@ -44,34 +44,34 @@
 #include <nm-setting-infiniband.h>
 
-                    NMSettingInfiniband;
-                    NMSettingInfinibandClass;
+#define             NM_SETTING_INFINIBAND_SETTING_NAME
 enum                NMSettingInfinibandError;
 #define             NM_SETTING_INFINIBAND_ERROR
+GQuark              nm_setting_infiniband_error_quark   (void);
 #define             NM_SETTING_INFINIBAND_MAC_ADDRESS
 #define             NM_SETTING_INFINIBAND_MTU
-#define             NM_SETTING_INFINIBAND_SETTING_NAME
 #define             NM_SETTING_INFINIBAND_TRANSPORT_MODE
-GQuark              nm_setting_infiniband_error_quark   (void);
+                    NMSettingInfiniband;
+                    NMSettingInfinibandClass;
+NMSetting *         nm_setting_infiniband_new           (void);
 const GByteArray *  nm_setting_infiniband_get_mac_address
                                                         (NMSettingInfiniband *setting);
 guint32             nm_setting_infiniband_get_mtu       (NMSettingInfiniband *setting);
 const char *        nm_setting_infiniband_get_transport_mode
                                                         (NMSettingInfiniband *setting);
-NMSetting *         nm_setting_infiniband_new           (void);
 

Object Hierarchy

+
+  GEnum
+   +----NMSettingInfinibandError
+
   GObject
    +----NMSetting
          +----NMSettingInfiniband
 
-
-  GEnum
-   +----NMSettingInfinibandError
-

Properties

@@ -91,23 +91,8 @@ necessary for connection to IP-over-InfiniBand networks.

Details

-

NMSettingInfiniband

-
typedef struct _NMSettingInfiniband NMSettingInfiniband;
-

-

-
-
-
-

NMSettingInfinibandClass

-
typedef struct {
-	NMSettingClass parent;
-
-	/* Padding for future expansion */
-	void (*_reserved1) (void);
-	void (*_reserved2) (void);
-	void (*_reserved3) (void);
-	void (*_reserved4) (void);
-} NMSettingInfinibandClass;
+

NM_SETTING_INFINIBAND_SETTING_NAME

+
#define NM_SETTING_INFINIBAND_SETTING_NAME "infiniband"
 

@@ -121,8 +106,11 @@ necessary for connection to IP-over-InfiniBand networks. NM_SETTING_INFINIBAND_ERROR_MISSING_PROPERTY /*< nick=MissingProperty >*/ } NMSettingInfinibandError;
-
+
+++ @@ -153,6 +141,24 @@ required
+

nm_setting_infiniband_error_quark ()

+
GQuark              nm_setting_infiniband_error_quark   (void);
+

+Registers an error quark for NMSettingInfiniband if necessary. +

+

NM_SETTING_INFINIBAND_ERROR_UNKNOWN

++++ + + + + +

Returns :

the error quark used for NMSettingInfiniband errors.
+
+
+

NM_SETTING_INFINIBAND_MAC_ADDRESS

#define NM_SETTING_INFINIBAND_MAC_ADDRESS    "mac-address"
 
@@ -169,32 +175,51 @@ required

-

NM_SETTING_INFINIBAND_SETTING_NAME

-
#define NM_SETTING_INFINIBAND_SETTING_NAME "infiniband"
+

NM_SETTING_INFINIBAND_TRANSPORT_MODE

+
#define NM_SETTING_INFINIBAND_TRANSPORT_MODE "transport-mode"
 


-

NM_SETTING_INFINIBAND_TRANSPORT_MODE

-
#define NM_SETTING_INFINIBAND_TRANSPORT_MODE "transport-mode"
+

NMSettingInfiniband

+
typedef struct _NMSettingInfiniband NMSettingInfiniband;
+

+

+
+
+
+

NMSettingInfinibandClass

+
typedef struct {
+	NMSettingClass parent;
+
+	/* Padding for future expansion */
+	void (*_reserved1) (void);
+	void (*_reserved2) (void);
+	void (*_reserved3) (void);
+	void (*_reserved4) (void);
+} NMSettingInfinibandClass;
 


-

nm_setting_infiniband_error_quark ()

-
GQuark              nm_setting_infiniband_error_quark   (void);
+

nm_setting_infiniband_new ()

+
NMSetting *         nm_setting_infiniband_new           (void);

-Registers an error quark for NMSettingInfiniband if necessary. +Creates a new NMSettingInfiniband object with default values.

-
+
+++ - +

Returns :

the error quark used for NMSettingInfiniband errors.the new empty NMSettingInfiniband object. [transfer full] +
@@ -203,8 +228,11 @@ Registers an error quark for

nm_setting_infiniband_get_mac_address ()

const GByteArray *  nm_setting_infiniband_get_mac_address
                                                         (NMSettingInfiniband *setting);
-
+
+++ @@ -222,8 +250,11 @@ Registers an error quark for

nm_setting_infiniband_get_mtu ()

guint32             nm_setting_infiniband_get_mtu       (NMSettingInfiniband *setting);
-

setting :

+
+++ @@ -246,8 +277,11 @@ Registers an error quark for -

setting :

+
+++ @@ -261,22 +295,6 @@ Returns the transport mode for this device. Either 'datagram' or

setting :

-
-
-

nm_setting_infiniband_new ()

-
NMSetting *         nm_setting_infiniband_new           (void);
-

-Creates a new NMSettingInfiniband object with default values. -

-
-- - - - -

Returns :

the new empty NMSettingInfiniband object. [transfer full] -
-

Property Details

@@ -313,6 +331,6 @@ The IP-over-InfiniBand transport mode. Either 'datagram' or
+ Generated by GTK-Doc V1.19 \ No newline at end of file diff --git a/docs/libnm-util/html/NMSettingOlpcMesh.html b/docs/libnm-util/html/NMSettingOlpcMesh.html index fe2fa095..4b622152 100644 --- a/docs/libnm-util/html/NMSettingOlpcMesh.html +++ b/docs/libnm-util/html/NMSettingOlpcMesh.html @@ -3,12 +3,12 @@ NMSettingOlpcMesh - + - + @@ -41,33 +41,33 @@

Object Hierarchy

+
+  GEnum
+   +----NMSettingOlpcMeshError
+
   GObject
    +----NMSetting
          +----NMSettingOlpcMesh
 
-
-  GEnum
-   +----NMSettingOlpcMeshError
-

Properties

@@ -85,23 +85,8 @@ const

Details

-

NMSettingOlpcMesh

-
typedef struct _NMSettingOlpcMesh NMSettingOlpcMesh;
-

-

-
-
-
-

NMSettingOlpcMeshClass

-
typedef struct {
-	NMSettingClass parent;
-
-	/* Padding for future expansion */
-	void (*_reserved1) (void);
-	void (*_reserved2) (void);
-	void (*_reserved3) (void);
-	void (*_reserved4) (void);
-} NMSettingOlpcMeshClass;
+

NM_SETTING_OLPC_MESH_SETTING_NAME

+
#define NM_SETTING_OLPC_MESH_SETTING_NAME "802-11-olpc-mesh"
 

@@ -115,8 +100,11 @@ const +
+++ @@ -139,65 +127,83 @@ required
-

NM_SETTING_OLPC_MESH_CHANNEL

-
#define NM_SETTING_OLPC_MESH_CHANNEL              "channel"
+

NM_SETTING_OLPC_MESH_ERROR

+
#define NM_SETTING_OLPC_MESH_ERROR nm_setting_olpc_mesh_error_quark ()
 


-

NM_SETTING_OLPC_MESH_DHCP_ANYCAST_ADDRESS

-
#define NM_SETTING_OLPC_MESH_DHCP_ANYCAST_ADDRESS "dhcp-anycast-address"
-
+

nm_setting_olpc_mesh_error_quark ()

+
GQuark              nm_setting_olpc_mesh_error_quark    (void);


-

NM_SETTING_OLPC_MESH_ERROR

-
#define NM_SETTING_OLPC_MESH_ERROR nm_setting_olpc_mesh_error_quark ()
+

NM_SETTING_OLPC_MESH_SSID

+
#define NM_SETTING_OLPC_MESH_SSID                 "ssid"
 


-

NM_SETTING_OLPC_MESH_SETTING_NAME

-
#define NM_SETTING_OLPC_MESH_SETTING_NAME "802-11-olpc-mesh"
+

NM_SETTING_OLPC_MESH_CHANNEL

+
#define NM_SETTING_OLPC_MESH_CHANNEL              "channel"
 


-

NM_SETTING_OLPC_MESH_SSID

-
#define NM_SETTING_OLPC_MESH_SSID                 "ssid"
+

NM_SETTING_OLPC_MESH_DHCP_ANYCAST_ADDRESS

+
#define NM_SETTING_OLPC_MESH_DHCP_ANYCAST_ADDRESS "dhcp-anycast-address"
 


-

nm_setting_olpc_mesh_error_quark ()

-
GQuark              nm_setting_olpc_mesh_error_quark    (void);
+

NMSettingOlpcMesh

+
typedef struct _NMSettingOlpcMesh NMSettingOlpcMesh;


-

nm_setting_olpc_mesh_get_channel ()

-
guint32             nm_setting_olpc_mesh_get_channel    (NMSettingOlpcMesh *setting);
+

NMSettingOlpcMeshClass

+
typedef struct {
+	NMSettingClass parent;
+
+	/* Padding for future expansion */
+	void (*_reserved1) (void);
+	void (*_reserved2) (void);
+	void (*_reserved3) (void);
+	void (*_reserved4) (void);
+} NMSettingOlpcMeshClass;
+


-

nm_setting_olpc_mesh_get_dhcp_anycast_address ()

-
const GByteArray *  nm_setting_olpc_mesh_get_dhcp_anycast_address
-                                                        (NMSettingOlpcMesh *setting);
+

nm_setting_olpc_mesh_new ()

+
NMSetting *         nm_setting_olpc_mesh_new            (void);

+Creates a new NMSettingOlpcMesh object with default values.

+

NM_SETTING_OLPC_MESH_ERROR_UNKNOWN

++++ + + + + +

Returns :

the new empty NMSettingOlpcMesh object

@@ -208,18 +214,18 @@ required

-

nm_setting_olpc_mesh_new ()

-
NMSetting *         nm_setting_olpc_mesh_new            (void);
+

nm_setting_olpc_mesh_get_channel ()

+
guint32             nm_setting_olpc_mesh_get_channel    (NMSettingOlpcMesh *setting);
+

+

+
+
+
+

nm_setting_olpc_mesh_get_dhcp_anycast_address ()

+
const GByteArray *  nm_setting_olpc_mesh_get_dhcp_anycast_address
+                                                        (NMSettingOlpcMesh *setting);

-Creates a new NMSettingOlpcMesh object with default values.

-
-- - - - -

Returns :

the new empty NMSettingOlpcMesh object
@@ -254,6 +260,6 @@ SSID of the mesh network to join.
+ Generated by GTK-Doc V1.19
\ No newline at end of file diff --git a/docs/libnm-util/html/NMSettingPPP.html b/docs/libnm-util/html/NMSettingPPP.html index c4d92133..9e13b48b 100644 --- a/docs/libnm-util/html/NMSettingPPP.html +++ b/docs/libnm-util/html/NMSettingPPP.html @@ -3,12 +3,12 @@ NMSettingPPP - + - + @@ -45,63 +45,63 @@ that require PPP to deliver IP capability

 #include <nm-setting-ppp.h>
 
-                    NMSettingPPP;
-                    NMSettingPPPClass;
+#define             NM_SETTING_PPP_SETTING_NAME
 enum                NMSettingPPPError;
-#define             NM_SETTING_PPP_BAUD
-#define             NM_SETTING_PPP_CRTSCTS
 #define             NM_SETTING_PPP_ERROR
-#define             NM_SETTING_PPP_LCP_ECHO_FAILURE
-#define             NM_SETTING_PPP_LCP_ECHO_INTERVAL
-#define             NM_SETTING_PPP_MPPE_STATEFUL
-#define             NM_SETTING_PPP_MRU
-#define             NM_SETTING_PPP_MTU
+GQuark              nm_setting_ppp_error_quark          (void);
 #define             NM_SETTING_PPP_NOAUTH
-#define             NM_SETTING_PPP_NOBSDCOMP
-#define             NM_SETTING_PPP_NODEFLATE
-#define             NM_SETTING_PPP_NO_VJ_COMP
-#define             NM_SETTING_PPP_REFUSE_CHAP
 #define             NM_SETTING_PPP_REFUSE_EAP
+#define             NM_SETTING_PPP_REFUSE_PAP
+#define             NM_SETTING_PPP_REFUSE_CHAP
 #define             NM_SETTING_PPP_REFUSE_MSCHAP
 #define             NM_SETTING_PPP_REFUSE_MSCHAPV2
-#define             NM_SETTING_PPP_REFUSE_PAP
+#define             NM_SETTING_PPP_NOBSDCOMP
+#define             NM_SETTING_PPP_NODEFLATE
+#define             NM_SETTING_PPP_NO_VJ_COMP
 #define             NM_SETTING_PPP_REQUIRE_MPPE
 #define             NM_SETTING_PPP_REQUIRE_MPPE_128
-#define             NM_SETTING_PPP_SETTING_NAME
-GQuark              nm_setting_ppp_error_quark          (void);
-guint32             nm_setting_ppp_get_baud             (NMSettingPPP *setting);
-gboolean            nm_setting_ppp_get_crtscts          (NMSettingPPP *setting);
-guint32             nm_setting_ppp_get_lcp_echo_failure (NMSettingPPP *setting);
-guint32             nm_setting_ppp_get_lcp_echo_interval
-                                                        (NMSettingPPP *setting);
-gboolean            nm_setting_ppp_get_mppe_stateful    (NMSettingPPP *setting);
-guint32             nm_setting_ppp_get_mru              (NMSettingPPP *setting);
-guint32             nm_setting_ppp_get_mtu              (NMSettingPPP *setting);
-gboolean            nm_setting_ppp_get_no_vj_comp       (NMSettingPPP *setting);
+#define             NM_SETTING_PPP_MPPE_STATEFUL
+#define             NM_SETTING_PPP_CRTSCTS
+#define             NM_SETTING_PPP_BAUD
+#define             NM_SETTING_PPP_MRU
+#define             NM_SETTING_PPP_MTU
+#define             NM_SETTING_PPP_LCP_ECHO_FAILURE
+#define             NM_SETTING_PPP_LCP_ECHO_INTERVAL
+                    NMSettingPPP;
+                    NMSettingPPPClass;
+NMSetting *         nm_setting_ppp_new                  (void);
 gboolean            nm_setting_ppp_get_noauth           (NMSettingPPP *setting);
-gboolean            nm_setting_ppp_get_nobsdcomp        (NMSettingPPP *setting);
-gboolean            nm_setting_ppp_get_nodeflate        (NMSettingPPP *setting);
-gboolean            nm_setting_ppp_get_refuse_chap      (NMSettingPPP *setting);
 gboolean            nm_setting_ppp_get_refuse_eap       (NMSettingPPP *setting);
+gboolean            nm_setting_ppp_get_refuse_pap       (NMSettingPPP *setting);
+gboolean            nm_setting_ppp_get_refuse_chap      (NMSettingPPP *setting);
 gboolean            nm_setting_ppp_get_refuse_mschap    (NMSettingPPP *setting);
 gboolean            nm_setting_ppp_get_refuse_mschapv2  (NMSettingPPP *setting);
-gboolean            nm_setting_ppp_get_refuse_pap       (NMSettingPPP *setting);
+gboolean            nm_setting_ppp_get_nobsdcomp        (NMSettingPPP *setting);
+gboolean            nm_setting_ppp_get_nodeflate        (NMSettingPPP *setting);
+gboolean            nm_setting_ppp_get_no_vj_comp       (NMSettingPPP *setting);
 gboolean            nm_setting_ppp_get_require_mppe     (NMSettingPPP *setting);
 gboolean            nm_setting_ppp_get_require_mppe_128 (NMSettingPPP *setting);
-NMSetting *         nm_setting_ppp_new                  (void);
+gboolean            nm_setting_ppp_get_mppe_stateful    (NMSettingPPP *setting);
+gboolean            nm_setting_ppp_get_crtscts          (NMSettingPPP *setting);
+guint32             nm_setting_ppp_get_baud             (NMSettingPPP *setting);
+guint32             nm_setting_ppp_get_mru              (NMSettingPPP *setting);
+guint32             nm_setting_ppp_get_mtu              (NMSettingPPP *setting);
+guint32             nm_setting_ppp_get_lcp_echo_failure (NMSettingPPP *setting);
+guint32             nm_setting_ppp_get_lcp_echo_interval
+                                                        (NMSettingPPP *setting);
 

Object Hierarchy

+
+  GEnum
+   +----NMSettingPPPError
+
   GObject
    +----NMSetting
          +----NMSettingPPP
 
-
-  GEnum
-   +----NMSettingPPPError
-

Properties

@@ -137,23 +137,8 @@ cable and DSL modems and some mobile broadband devices.

Details

-

NMSettingPPP

-
typedef struct _NMSettingPPP NMSettingPPP;
-

-

-
-
-
-

NMSettingPPPClass

-
typedef struct {
-	NMSettingClass parent;
-
-	/* Padding for future expansion */
-	void (*_reserved1) (void);
-	void (*_reserved2) (void);
-	void (*_reserved3) (void);
-	void (*_reserved4) (void);
-} NMSettingPPPClass;
+

NM_SETTING_PPP_SETTING_NAME

+
#define NM_SETTING_PPP_SETTING_NAME "ppp"
 

@@ -168,8 +153,11 @@ cable and DSL modems and some mobile broadband devices. NM_SETTING_PPP_ERROR_REQUIRE_MPPE_NOT_ALLOWED /*< nick=RequireMPPENotAllowed >*/ } NMSettingPPPError;
-
+
+++ @@ -198,185 +186,225 @@ with other setting configuration parameters
-

NM_SETTING_PPP_BAUD

-
#define NM_SETTING_PPP_BAUD              "baud"
+

NM_SETTING_PPP_ERROR

+
#define NM_SETTING_PPP_ERROR nm_setting_ppp_error_quark ()
 


-

NM_SETTING_PPP_CRTSCTS

-
#define NM_SETTING_PPP_CRTSCTS           "crtscts"
+

nm_setting_ppp_error_quark ()

+
GQuark              nm_setting_ppp_error_quark          (void);
+

+Registers an error quark for NMSettingPPP if necessary. +

+

NM_SETTING_PPP_ERROR_UNKNOWN

++++ + + + + +

Returns :

the error quark used for NMSettingPPP errors.
+
+
+
+

NM_SETTING_PPP_NOAUTH

+
#define NM_SETTING_PPP_NOAUTH            "noauth"
 


-

NM_SETTING_PPP_ERROR

-
#define NM_SETTING_PPP_ERROR nm_setting_ppp_error_quark ()
+

NM_SETTING_PPP_REFUSE_EAP

+
#define NM_SETTING_PPP_REFUSE_EAP        "refuse-eap"
 


-

NM_SETTING_PPP_LCP_ECHO_FAILURE

-
#define NM_SETTING_PPP_LCP_ECHO_FAILURE  "lcp-echo-failure"
+

NM_SETTING_PPP_REFUSE_PAP

+
#define NM_SETTING_PPP_REFUSE_PAP        "refuse-pap"
 


-

NM_SETTING_PPP_LCP_ECHO_INTERVAL

-
#define NM_SETTING_PPP_LCP_ECHO_INTERVAL "lcp-echo-interval"
+

NM_SETTING_PPP_REFUSE_CHAP

+
#define NM_SETTING_PPP_REFUSE_CHAP       "refuse-chap"
 


-

NM_SETTING_PPP_MPPE_STATEFUL

-
#define NM_SETTING_PPP_MPPE_STATEFUL     "mppe-stateful"
+

NM_SETTING_PPP_REFUSE_MSCHAP

+
#define NM_SETTING_PPP_REFUSE_MSCHAP     "refuse-mschap"
 


-

NM_SETTING_PPP_MRU

-
#define NM_SETTING_PPP_MRU               "mru"
+

NM_SETTING_PPP_REFUSE_MSCHAPV2

+
#define NM_SETTING_PPP_REFUSE_MSCHAPV2   "refuse-mschapv2"
 


-

NM_SETTING_PPP_MTU

-
#define NM_SETTING_PPP_MTU               "mtu"
+

NM_SETTING_PPP_NOBSDCOMP

+
#define NM_SETTING_PPP_NOBSDCOMP         "nobsdcomp"
 


-

NM_SETTING_PPP_NOAUTH

-
#define NM_SETTING_PPP_NOAUTH            "noauth"
+

NM_SETTING_PPP_NODEFLATE

+
#define NM_SETTING_PPP_NODEFLATE         "nodeflate"
 


-

NM_SETTING_PPP_NOBSDCOMP

-
#define NM_SETTING_PPP_NOBSDCOMP         "nobsdcomp"
+

NM_SETTING_PPP_NO_VJ_COMP

+
#define NM_SETTING_PPP_NO_VJ_COMP        "no-vj-comp"
 


-

NM_SETTING_PPP_NODEFLATE

-
#define NM_SETTING_PPP_NODEFLATE         "nodeflate"
+

NM_SETTING_PPP_REQUIRE_MPPE

+
#define NM_SETTING_PPP_REQUIRE_MPPE      "require-mppe"
 


-

NM_SETTING_PPP_NO_VJ_COMP

-
#define NM_SETTING_PPP_NO_VJ_COMP        "no-vj-comp"
+

NM_SETTING_PPP_REQUIRE_MPPE_128

+
#define NM_SETTING_PPP_REQUIRE_MPPE_128  "require-mppe-128"
 


-

NM_SETTING_PPP_REFUSE_CHAP

-
#define NM_SETTING_PPP_REFUSE_CHAP       "refuse-chap"
+

NM_SETTING_PPP_MPPE_STATEFUL

+
#define NM_SETTING_PPP_MPPE_STATEFUL     "mppe-stateful"
 


-

NM_SETTING_PPP_REFUSE_EAP

-
#define NM_SETTING_PPP_REFUSE_EAP        "refuse-eap"
+

NM_SETTING_PPP_CRTSCTS

+
#define NM_SETTING_PPP_CRTSCTS           "crtscts"
 


-

NM_SETTING_PPP_REFUSE_MSCHAP

-
#define NM_SETTING_PPP_REFUSE_MSCHAP     "refuse-mschap"
+

NM_SETTING_PPP_BAUD

+
#define NM_SETTING_PPP_BAUD              "baud"
 


-

NM_SETTING_PPP_REFUSE_MSCHAPV2

-
#define NM_SETTING_PPP_REFUSE_MSCHAPV2   "refuse-mschapv2"
+

NM_SETTING_PPP_MRU

+
#define NM_SETTING_PPP_MRU               "mru"
 


-

NM_SETTING_PPP_REFUSE_PAP

-
#define NM_SETTING_PPP_REFUSE_PAP        "refuse-pap"
+

NM_SETTING_PPP_MTU

+
#define NM_SETTING_PPP_MTU               "mtu"
 


-

NM_SETTING_PPP_REQUIRE_MPPE

-
#define NM_SETTING_PPP_REQUIRE_MPPE      "require-mppe"
+

NM_SETTING_PPP_LCP_ECHO_FAILURE

+
#define NM_SETTING_PPP_LCP_ECHO_FAILURE  "lcp-echo-failure"
 


-

NM_SETTING_PPP_REQUIRE_MPPE_128

-
#define NM_SETTING_PPP_REQUIRE_MPPE_128  "require-mppe-128"
+

NM_SETTING_PPP_LCP_ECHO_INTERVAL

+
#define NM_SETTING_PPP_LCP_ECHO_INTERVAL "lcp-echo-interval"
 


-

NM_SETTING_PPP_SETTING_NAME

-
#define NM_SETTING_PPP_SETTING_NAME "ppp"
+

NMSettingPPP

+
typedef struct _NMSettingPPP NMSettingPPP;
+

+

+
+
+
+

NMSettingPPPClass

+
typedef struct {
+	NMSettingClass parent;
+
+	/* Padding for future expansion */
+	void (*_reserved1) (void);
+	void (*_reserved2) (void);
+	void (*_reserved3) (void);
+	void (*_reserved4) (void);
+} NMSettingPPPClass;
 


-

nm_setting_ppp_error_quark ()

-
GQuark              nm_setting_ppp_error_quark          (void);
+

nm_setting_ppp_new ()

+
NMSetting *         nm_setting_ppp_new                  (void);

-Registers an error quark for NMSettingPPP if necessary. +Creates a new NMSettingPPP object with default values.

-
+
+++ - +

Returns :

the error quark used for NMSettingPPP errors.the new empty NMSettingPPP object. [transfer full] +

-

nm_setting_ppp_get_baud ()

-
guint32             nm_setting_ppp_get_baud             (NMSettingPPP *setting);
-
+

nm_setting_ppp_get_noauth ()

+
gboolean            nm_setting_ppp_get_noauth           (NMSettingPPP *setting);
+
+++ @@ -385,17 +413,20 @@ Registers an error quark for Returns :

-
+

setting :

the "baud" property of the settingthe "noauth" property of the setting

-

nm_setting_ppp_get_crtscts ()

-
gboolean            nm_setting_ppp_get_crtscts          (NMSettingPPP *setting);
-
+

nm_setting_ppp_get_refuse_eap ()

+
gboolean            nm_setting_ppp_get_refuse_eap       (NMSettingPPP *setting);
+
+++ @@ -404,17 +435,20 @@ Registers an error quark for Returns :

-
+

setting :

the "crtscts" property of the settingthe "refuse-eap" property of the setting

-

nm_setting_ppp_get_lcp_echo_failure ()

-
guint32             nm_setting_ppp_get_lcp_echo_failure (NMSettingPPP *setting);
-
+

nm_setting_ppp_get_refuse_pap ()

+
gboolean            nm_setting_ppp_get_refuse_pap       (NMSettingPPP *setting);
+
+++ @@ -423,18 +457,20 @@ Registers an error quark for Returns :

-
+

setting :

the "lcp-echo-failure" property of the settingthe "refuse-pap" property of the setting

-

nm_setting_ppp_get_lcp_echo_interval ()

-
guint32             nm_setting_ppp_get_lcp_echo_interval
-                                                        (NMSettingPPP *setting);
-
+

nm_setting_ppp_get_refuse_chap ()

+
gboolean            nm_setting_ppp_get_refuse_chap      (NMSettingPPP *setting);
+
+++ @@ -443,17 +479,20 @@ Registers an error quark for Returns :

-
+

setting :

the "lcp-echo-interval" property of the settingthe "refuse-chap" property of the setting

-

nm_setting_ppp_get_mppe_stateful ()

-
gboolean            nm_setting_ppp_get_mppe_stateful    (NMSettingPPP *setting);
-
+

nm_setting_ppp_get_refuse_mschap ()

+
gboolean            nm_setting_ppp_get_refuse_mschap    (NMSettingPPP *setting);
+
+++ @@ -462,17 +501,20 @@ Registers an error quark for Returns :

-
+

setting :

the "mppe-stateful" property of the settingthe "refuse-mschap" property of the setting

-

nm_setting_ppp_get_mru ()

-
guint32             nm_setting_ppp_get_mru              (NMSettingPPP *setting);
-
+

nm_setting_ppp_get_refuse_mschapv2 ()

+
gboolean            nm_setting_ppp_get_refuse_mschapv2  (NMSettingPPP *setting);
+
+++ @@ -481,17 +523,20 @@ Registers an error quark for Returns :

-
+

setting :

the "mru" property of the settingthe "refuse-mschapv2" property of the setting

-

nm_setting_ppp_get_mtu ()

-
guint32             nm_setting_ppp_get_mtu              (NMSettingPPP *setting);
-
+

nm_setting_ppp_get_nobsdcomp ()

+
gboolean            nm_setting_ppp_get_nobsdcomp        (NMSettingPPP *setting);
+
+++ @@ -500,17 +545,20 @@ Registers an error quark for Returns :

-
+

setting :

the "mtu" property of the settingthe "nobsdcomp" property of the setting

-

nm_setting_ppp_get_no_vj_comp ()

-
gboolean            nm_setting_ppp_get_no_vj_comp       (NMSettingPPP *setting);
-
+

nm_setting_ppp_get_nodeflate ()

+
gboolean            nm_setting_ppp_get_nodeflate        (NMSettingPPP *setting);
+
+++ @@ -519,17 +567,20 @@ Registers an error quark for Returns :

-
+

setting :

the "no-vj-comp" property of the settingthe "nodeflate" property of the setting

-

nm_setting_ppp_get_noauth ()

-
gboolean            nm_setting_ppp_get_noauth           (NMSettingPPP *setting);
-
+

nm_setting_ppp_get_no_vj_comp ()

+
gboolean            nm_setting_ppp_get_no_vj_comp       (NMSettingPPP *setting);
+
+++ @@ -538,17 +589,20 @@ Registers an error quark for Returns :

-
+

setting :

the "noauth" property of the settingthe "no-vj-comp" property of the setting

-

nm_setting_ppp_get_nobsdcomp ()

-
gboolean            nm_setting_ppp_get_nobsdcomp        (NMSettingPPP *setting);
-
+

nm_setting_ppp_get_require_mppe ()

+
gboolean            nm_setting_ppp_get_require_mppe     (NMSettingPPP *setting);
+
+++ @@ -557,17 +611,20 @@ Registers an error quark for Returns :

-
+

setting :

the "nobsdcomp" property of the settingthe "require-mppe" property of the setting

-

nm_setting_ppp_get_nodeflate ()

-
gboolean            nm_setting_ppp_get_nodeflate        (NMSettingPPP *setting);
-
+

nm_setting_ppp_get_require_mppe_128 ()

+
gboolean            nm_setting_ppp_get_require_mppe_128 (NMSettingPPP *setting);
+
+++ @@ -576,17 +633,20 @@ Registers an error quark for Returns :

-
+

setting :

the "nodeflate" property of the settingthe "require-mppe-128" property of the setting

-

nm_setting_ppp_get_refuse_chap ()

-
gboolean            nm_setting_ppp_get_refuse_chap      (NMSettingPPP *setting);
-
+

nm_setting_ppp_get_mppe_stateful ()

+
gboolean            nm_setting_ppp_get_mppe_stateful    (NMSettingPPP *setting);
+
+++ @@ -595,17 +655,20 @@ Registers an error quark for Returns :

-
+

setting :

the "refuse-chap" property of the settingthe "mppe-stateful" property of the setting

-

nm_setting_ppp_get_refuse_eap ()

-
gboolean            nm_setting_ppp_get_refuse_eap       (NMSettingPPP *setting);
-
+

nm_setting_ppp_get_crtscts ()

+
gboolean            nm_setting_ppp_get_crtscts          (NMSettingPPP *setting);
+
+++ @@ -614,17 +677,20 @@ Registers an error quark for Returns :

-
+

setting :

the "refuse-eap" property of the settingthe "crtscts" property of the setting

-

nm_setting_ppp_get_refuse_mschap ()

-
gboolean            nm_setting_ppp_get_refuse_mschap    (NMSettingPPP *setting);
-
+

nm_setting_ppp_get_baud ()

+
guint32             nm_setting_ppp_get_baud             (NMSettingPPP *setting);
+
+++ @@ -633,17 +699,20 @@ Registers an error quark for Returns :

-
+

setting :

the "refuse-mschap" property of the settingthe "baud" property of the setting

-

nm_setting_ppp_get_refuse_mschapv2 ()

-
gboolean            nm_setting_ppp_get_refuse_mschapv2  (NMSettingPPP *setting);
-
+

nm_setting_ppp_get_mru ()

+
guint32             nm_setting_ppp_get_mru              (NMSettingPPP *setting);
+
+++ @@ -652,17 +721,20 @@ Registers an error quark for Returns :

-
+

setting :

the "refuse-mschapv2" property of the settingthe "mru" property of the setting

-

nm_setting_ppp_get_refuse_pap ()

-
gboolean            nm_setting_ppp_get_refuse_pap       (NMSettingPPP *setting);
-
+

nm_setting_ppp_get_mtu ()

+
guint32             nm_setting_ppp_get_mtu              (NMSettingPPP *setting);
+
+++ @@ -671,17 +743,20 @@ Registers an error quark for Returns :

-
+

setting :

the "refuse-pap" property of the settingthe "mtu" property of the setting

-

nm_setting_ppp_get_require_mppe ()

-
gboolean            nm_setting_ppp_get_require_mppe     (NMSettingPPP *setting);
-
+

nm_setting_ppp_get_lcp_echo_failure ()

+
guint32             nm_setting_ppp_get_lcp_echo_failure (NMSettingPPP *setting);
+
+++ @@ -690,17 +765,21 @@ Registers an error quark for Returns :

-
+

setting :

the "require-mppe" property of the settingthe "lcp-echo-failure" property of the setting

-

nm_setting_ppp_get_require_mppe_128 ()

-
gboolean            nm_setting_ppp_get_require_mppe_128 (NMSettingPPP *setting);
-
+

nm_setting_ppp_get_lcp_echo_interval ()

+
guint32             nm_setting_ppp_get_lcp_echo_interval
+                                                        (NMSettingPPP *setting);
+
+++ @@ -709,27 +788,11 @@ Registers an error quark for Returns :

-
+

setting :

the "require-mppe-128" property of the settingthe "lcp-echo-interval" property of the setting
-
-
-

nm_setting_ppp_new ()

-
NMSetting *         nm_setting_ppp_new                  (void);
-

-Creates a new NMSettingPPP object with default values. -

-
-- - - - -

Returns :

the new empty NMSettingPPP object. [transfer full] -
-

Property Details

@@ -920,6 +983,6 @@ be set to TRUE. If 128-bit MPPE is not available the session will fail.
+ Generated by GTK-Doc V1.19
\ No newline at end of file diff --git a/docs/libnm-util/html/NMSettingPPPOE.html b/docs/libnm-util/html/NMSettingPPPOE.html index 3f20ccec..fd91a0ad 100644 --- a/docs/libnm-util/html/NMSettingPPPOE.html +++ b/docs/libnm-util/html/NMSettingPPPOE.html @@ -3,12 +3,12 @@ NMSettingPPPOE - + - + @@ -44,35 +44,35 @@
 #include <nm-setting-pppoe.h>
 
-                    NMSettingPPPOE;
-                    NMSettingPPPOEClass;
+#define             NM_SETTING_PPPOE_SETTING_NAME
 enum                NMSettingPPPOEError;
 #define             NM_SETTING_PPPOE_ERROR
-#define             NM_SETTING_PPPOE_PASSWORD
-#define             NM_SETTING_PPPOE_PASSWORD_FLAGS
+GQuark              nm_setting_pppoe_error_quark        (void);
 #define             NM_SETTING_PPPOE_SERVICE
-#define             NM_SETTING_PPPOE_SETTING_NAME
 #define             NM_SETTING_PPPOE_USERNAME
-GQuark              nm_setting_pppoe_error_quark        (void);
+#define             NM_SETTING_PPPOE_PASSWORD
+#define             NM_SETTING_PPPOE_PASSWORD_FLAGS
+                    NMSettingPPPOE;
+                    NMSettingPPPOEClass;
+NMSetting *         nm_setting_pppoe_new                (void);
+const char *        nm_setting_pppoe_get_service        (NMSettingPPPOE *setting);
+const char *        nm_setting_pppoe_get_username       (NMSettingPPPOE *setting);
 const char *        nm_setting_pppoe_get_password       (NMSettingPPPOE *setting);
 NMSettingSecretFlags nm_setting_pppoe_get_password_flags
                                                         (NMSettingPPPOE *setting);
-const char *        nm_setting_pppoe_get_service        (NMSettingPPPOE *setting);
-const char *        nm_setting_pppoe_get_username       (NMSettingPPPOE *setting);
-NMSetting *         nm_setting_pppoe_new                (void);
 

Object Hierarchy

+
+  GEnum
+   +----NMSettingPPPOEError
+
   GObject
    +----NMSetting
          +----NMSettingPPPOE
 
-
-  GEnum
-   +----NMSettingPPPOEError
-

Properties

@@ -94,23 +94,8 @@ to provide IP transport, for example cable or DSL modems.

Details

-

NMSettingPPPOE

-
typedef struct _NMSettingPPPOE NMSettingPPPOE;
-

-

-
-
-
-

NMSettingPPPOEClass

-
typedef struct {
-	NMSettingClass parent;
-
-	/* Padding for future expansion */
-	void (*_reserved1) (void);
-	void (*_reserved2) (void);
-	void (*_reserved3) (void);
-	void (*_reserved4) (void);
-} NMSettingPPPOEClass;
+

NM_SETTING_PPPOE_SETTING_NAME

+
#define NM_SETTING_PPPOE_SETTING_NAME "pppoe"
 

@@ -125,8 +110,11 @@ to provide IP transport, for example cable or DSL modems. NM_SETTING_PPPOE_ERROR_MISSING_PPP_SETTING /*< nick=MissingPPPSetting >*/ } NMSettingPPPOEError;
-
+
+++ @@ -163,65 +151,105 @@ did not contain a required PPP setting for PPP related options
-

NM_SETTING_PPPOE_PASSWORD

-
#define NM_SETTING_PPPOE_PASSWORD       "password"
+

nm_setting_pppoe_error_quark ()

+
GQuark              nm_setting_pppoe_error_quark        (void);
+

+Registers an error quark for NMSettingPPPOE if necessary. +

+

NM_SETTING_PPPOE_ERROR_UNKNOWN

++++ + + + + +

Returns :

the error quark used for NMSettingPPPOE errors.
+
+
+
+

NM_SETTING_PPPOE_SERVICE

+
#define NM_SETTING_PPPOE_SERVICE        "service"
 


-

NM_SETTING_PPPOE_PASSWORD_FLAGS

-
#define NM_SETTING_PPPOE_PASSWORD_FLAGS "password-flags"
+

NM_SETTING_PPPOE_USERNAME

+
#define NM_SETTING_PPPOE_USERNAME       "username"
 


-

NM_SETTING_PPPOE_SERVICE

-
#define NM_SETTING_PPPOE_SERVICE        "service"
+

NM_SETTING_PPPOE_PASSWORD

+
#define NM_SETTING_PPPOE_PASSWORD       "password"
 


-

NM_SETTING_PPPOE_SETTING_NAME

-
#define NM_SETTING_PPPOE_SETTING_NAME "pppoe"
+

NM_SETTING_PPPOE_PASSWORD_FLAGS

+
#define NM_SETTING_PPPOE_PASSWORD_FLAGS "password-flags"
 


-

NM_SETTING_PPPOE_USERNAME

-
#define NM_SETTING_PPPOE_USERNAME       "username"
+

NMSettingPPPOE

+
typedef struct _NMSettingPPPOE NMSettingPPPOE;
+

+

+
+
+
+

NMSettingPPPOEClass

+
typedef struct {
+	NMSettingClass parent;
+
+	/* Padding for future expansion */
+	void (*_reserved1) (void);
+	void (*_reserved2) (void);
+	void (*_reserved3) (void);
+	void (*_reserved4) (void);
+} NMSettingPPPOEClass;
 


-

nm_setting_pppoe_error_quark ()

-
GQuark              nm_setting_pppoe_error_quark        (void);
+

nm_setting_pppoe_new ()

+
NMSetting *         nm_setting_pppoe_new                (void);

-Registers an error quark for NMSettingPPPOE if necessary. +Creates a new NMSettingPPPOE object with default values.

-
+
+++ - +

Returns :

the error quark used for NMSettingPPPOE errors.the new empty NMSettingPPPOE object. [transfer full] +

-

nm_setting_pppoe_get_password ()

-
const char *        nm_setting_pppoe_get_password       (NMSettingPPPOE *setting);
-
+

nm_setting_pppoe_get_service ()

+
const char *        nm_setting_pppoe_get_service        (NMSettingPPPOE *setting);
+
+++ @@ -230,18 +258,20 @@ Registers an error quark for Returns :

-
+

setting :

the "password" property of the settingthe "service" property of the setting

-

nm_setting_pppoe_get_password_flags ()

-
NMSettingSecretFlags nm_setting_pppoe_get_password_flags
-                                                        (NMSettingPPPOE *setting);
-
+

nm_setting_pppoe_get_username ()

+
const char *        nm_setting_pppoe_get_username       (NMSettingPPPOE *setting);
+
+++ @@ -250,18 +280,20 @@ Registers an error quark for Returns :

-
+

setting :

the NMSettingSecretFlags pertaining to the "password" -the "username" property of the setting

-

nm_setting_pppoe_get_service ()

-
const char *        nm_setting_pppoe_get_service        (NMSettingPPPOE *setting);
-
+

nm_setting_pppoe_get_password ()

+
const char *        nm_setting_pppoe_get_password       (NMSettingPPPOE *setting);
+
+++ @@ -270,17 +302,21 @@ Registers an error quark for Returns :

-
+

setting :

the "service" property of the settingthe "password" property of the setting

-

nm_setting_pppoe_get_username ()

-
const char *        nm_setting_pppoe_get_username       (NMSettingPPPOE *setting);
-
+

nm_setting_pppoe_get_password_flags ()

+
NMSettingSecretFlags nm_setting_pppoe_get_password_flags
+                                                        (NMSettingPPPOE *setting);
+
+++ @@ -289,27 +325,12 @@ Registers an error quark for Returns :

-
+

setting :

the "username" property of the settingthe NMSettingSecretFlags pertaining to the "password" +
-
-
-

nm_setting_pppoe_new ()

-
NMSetting *         nm_setting_pppoe_new                (void);
-

-Creates a new NMSettingPPPOE object with default values. -

-
-- - - - -

Returns :

the new empty NMSettingPPPOE object. [transfer full] -
-

Property Details

@@ -356,6 +377,6 @@ Username used to authenticate with the PPPoE service.
+ Generated by GTK-Doc V1.19
\ No newline at end of file diff --git a/docs/libnm-util/html/NMSettingSerial.html b/docs/libnm-util/html/NMSettingSerial.html index e68a2609..16f6d603 100644 --- a/docs/libnm-util/html/NMSettingSerial.html +++ b/docs/libnm-util/html/NMSettingSerial.html @@ -3,12 +3,12 @@ NMSettingSerial - + - + @@ -45,36 +45,36 @@ serial communications

 #include <nm-setting-serial.h>
 
-                    NMSettingSerial;
-                    NMSettingSerialClass;
+#define             NM_SETTING_SERIAL_SETTING_NAME
 enum                NMSettingSerialError;
+#define             NM_SETTING_SERIAL_ERROR
+GQuark              nm_setting_serial_error_quark       (void);
 #define             NM_SETTING_SERIAL_BAUD
 #define             NM_SETTING_SERIAL_BITS
-#define             NM_SETTING_SERIAL_ERROR
 #define             NM_SETTING_SERIAL_PARITY
-#define             NM_SETTING_SERIAL_SEND_DELAY
-#define             NM_SETTING_SERIAL_SETTING_NAME
 #define             NM_SETTING_SERIAL_STOPBITS
-GQuark              nm_setting_serial_error_quark       (void);
+#define             NM_SETTING_SERIAL_SEND_DELAY
+                    NMSettingSerial;
+                    NMSettingSerialClass;
+NMSetting *         nm_setting_serial_new               (void);
 guint               nm_setting_serial_get_baud          (NMSettingSerial *setting);
 guint               nm_setting_serial_get_bits          (NMSettingSerial *setting);
 char                nm_setting_serial_get_parity        (NMSettingSerial *setting);
-guint64             nm_setting_serial_get_send_delay    (NMSettingSerial *setting);
 guint               nm_setting_serial_get_stopbits      (NMSettingSerial *setting);
-NMSetting *         nm_setting_serial_new               (void);
+guint64             nm_setting_serial_get_send_delay    (NMSettingSerial *setting);
 

Object Hierarchy

+
+  GEnum
+   +----NMSettingSerialError
+
   GObject
    +----NMSetting
          +----NMSettingSerial
 
-
-  GEnum
-   +----NMSettingSerialError
-

Properties

@@ -97,23 +97,8 @@ such as mobile broadband or analog telephone connections.

Details

-

NMSettingSerial

-
typedef struct _NMSettingSerial NMSettingSerial;
-

-

-
-
-
-

NMSettingSerialClass

-
typedef struct {
-	NMSettingClass parent;
-
-	/* Padding for future expansion */
-	void (*_reserved1) (void);
-	void (*_reserved2) (void);
-	void (*_reserved3) (void);
-	void (*_reserved4) (void);
-} NMSettingSerialClass;
+

NM_SETTING_SERIAL_SETTING_NAME

+
#define NM_SETTING_SERIAL_SETTING_NAME "serial"
 

@@ -128,8 +113,11 @@ such as mobile broadband or analog telephone connections. NM_SETTING_SERIAL_ERROR_MISSING_PPP_SETTING /*< nick=MissingPPPSetting >*/ } NMSettingSerialError;
-
+
+++ @@ -158,6 +146,32 @@ setting requires the connection to contain an +

NM_SETTING_SERIAL_ERROR

+
#define NM_SETTING_SERIAL_ERROR nm_setting_serial_error_quark ()
+
+

+

+ +
+
+

nm_setting_serial_error_quark ()

+
GQuark              nm_setting_serial_error_quark       (void);
+

+Registers an error quark for NMSettingSerial if necessary. +

+

NM_SETTING_SERIAL_ERROR_UNKNOWN

++++ + + + + +

Returns :

the error quark used for NMSettingSerial errors.
+
+
+

NM_SETTING_SERIAL_BAUD

#define NM_SETTING_SERIAL_BAUD "baud"
 
@@ -174,16 +188,16 @@ setting requires the connection to contain an -

NM_SETTING_SERIAL_ERROR

-
#define NM_SETTING_SERIAL_ERROR nm_setting_serial_error_quark ()
+

NM_SETTING_SERIAL_PARITY

+
#define NM_SETTING_SERIAL_PARITY "parity"
 


-

NM_SETTING_SERIAL_PARITY

-
#define NM_SETTING_SERIAL_PARITY "parity"
+

NM_SETTING_SERIAL_STOPBITS

+
#define NM_SETTING_SERIAL_STOPBITS "stopbits"
 

@@ -198,32 +212,43 @@ setting requires the connection to contain an -

NM_SETTING_SERIAL_SETTING_NAME

-
#define NM_SETTING_SERIAL_SETTING_NAME "serial"
-
+

NMSettingSerial

+
typedef struct _NMSettingSerial NMSettingSerial;


-

NM_SETTING_SERIAL_STOPBITS

-
#define NM_SETTING_SERIAL_STOPBITS "stopbits"
+

NMSettingSerialClass

+
typedef struct {
+	NMSettingClass parent;
+
+	/* Padding for future expansion */
+	void (*_reserved1) (void);
+	void (*_reserved2) (void);
+	void (*_reserved3) (void);
+	void (*_reserved4) (void);
+} NMSettingSerialClass;
 


-

nm_setting_serial_error_quark ()

-
GQuark              nm_setting_serial_error_quark       (void);
+

nm_setting_serial_new ()

+
NMSetting *         nm_setting_serial_new               (void);

-Registers an error quark for NMSettingSerial if necessary. +Creates a new NMSettingSerial object with default values.

-
+
+++ - +

Returns :

the error quark used for NMSettingSerial errors.the new empty NMSettingSerial object. [transfer full] +
@@ -231,8 +256,11 @@ Registers an error quark for

nm_setting_serial_get_baud ()

guint               nm_setting_serial_get_baud          (NMSettingSerial *setting);
-
+
+++ @@ -250,8 +278,11 @@ Registers an error quark for

nm_setting_serial_get_bits ()

guint               nm_setting_serial_get_bits          (NMSettingSerial *setting);
-

setting :

+
+++ @@ -269,8 +300,11 @@ Registers an error quark for

nm_setting_serial_get_parity ()

char                nm_setting_serial_get_parity        (NMSettingSerial *setting);
-

setting :

+
+++ @@ -286,10 +320,13 @@ Registers an error quark for -

nm_setting_serial_get_send_delay ()

-
guint64             nm_setting_serial_get_send_delay    (NMSettingSerial *setting);
-

setting :

+

nm_setting_serial_get_stopbits ()

+
guint               nm_setting_serial_get_stopbits      (NMSettingSerial *setting);
+
+++ @@ -298,17 +335,20 @@ Registers an error quark for Returns :

-
+

setting :

the "send-delay" property of the settingthe "stopbits" property of the setting

-

nm_setting_serial_get_stopbits ()

-
guint               nm_setting_serial_get_stopbits      (NMSettingSerial *setting);
-
+

nm_setting_serial_get_send_delay ()

+
guint64             nm_setting_serial_get_send_delay    (NMSettingSerial *setting);
+
+++ @@ -317,27 +357,11 @@ Registers an error quark for Returns :

-
+

setting :

the "stopbits" property of the settingthe "send-delay" property of the setting
-
-
-

nm_setting_serial_new ()

-
NMSetting *         nm_setting_serial_new               (void);
-

-Creates a new NMSettingSerial object with default values. -

-
-- - - - -

Returns :

the new empty NMSettingSerial object. [transfer full] -
-

Property Details

@@ -396,6 +420,6 @@ The 1 in '8n1' for example.
+ Generated by GTK-Doc V1.19 \ No newline at end of file diff --git a/docs/libnm-util/html/NMSettingVPN.html b/docs/libnm-util/html/NMSettingVPN.html index d686803b..afbe41bf 100644 --- a/docs/libnm-util/html/NMSettingVPN.html +++ b/docs/libnm-util/html/NMSettingVPN.html @@ -3,12 +3,12 @@ NMSettingVPN - + - + @@ -44,57 +44,57 @@
 #include <nm-setting-vpn.h>
 
+#define             NM_SETTING_VPN_SETTING_NAME
+enum                NMSettingVpnError;
+#define             NM_SETTING_VPN_ERROR
+GQuark              nm_setting_vpn_error_quark          (void);
+#define             NM_SETTING_VPN_SERVICE_TYPE
+#define             NM_SETTING_VPN_USER_NAME
+#define             NM_SETTING_VPN_DATA
+#define             NM_SETTING_VPN_SECRETS
                     NMSettingVPN;
                     NMSettingVPNClass;
-enum                NMSettingVpnError;
 void                (*NMVPNIterFunc)                    (const char *key,
                                                          const char *value,
                                                          gpointer user_data);
-#define             NM_SETTING_VPN_DATA
-#define             NM_SETTING_VPN_ERROR
-#define             NM_SETTING_VPN_SECRETS
-#define             NM_SETTING_VPN_SERVICE_TYPE
-#define             NM_SETTING_VPN_SETTING_NAME
-#define             NM_SETTING_VPN_USER_NAME
+NMSetting *         nm_setting_vpn_new                  (void);
+const char *        nm_setting_vpn_get_service_type     (NMSettingVPN *setting);
+const char *        nm_setting_vpn_get_user_name        (NMSettingVPN *setting);
+guint32             nm_setting_vpn_get_num_data_items   (NMSettingVPN *setting);
 void                nm_setting_vpn_add_data_item        (NMSettingVPN *setting,
                                                          const char *key,
                                                          const char *item);
-void                nm_setting_vpn_add_secret           (NMSettingVPN *setting,
-                                                         const char *key,
-                                                         const char *secret);
-GQuark              nm_setting_vpn_error_quark          (void);
+const char *        nm_setting_vpn_get_data_item        (NMSettingVPN *setting,
+                                                         const char *key);
+void                nm_setting_vpn_remove_data_item     (NMSettingVPN *setting,
+                                                         const char *key);
 void                nm_setting_vpn_foreach_data_item    (NMSettingVPN *setting,
                                                          NMVPNIterFunc func,
                                                          gpointer user_data);
-void                nm_setting_vpn_foreach_secret       (NMSettingVPN *setting,
-                                                         NMVPNIterFunc func,
-                                                         gpointer user_data);
-const char *        nm_setting_vpn_get_data_item        (NMSettingVPN *setting,
-                                                         const char *key);
-guint32             nm_setting_vpn_get_num_data_items   (NMSettingVPN *setting);
 guint32             nm_setting_vpn_get_num_secrets      (NMSettingVPN *setting);
+void                nm_setting_vpn_add_secret           (NMSettingVPN *setting,
+                                                         const char *key,
+                                                         const char *secret);
 const char *        nm_setting_vpn_get_secret           (NMSettingVPN *setting,
                                                          const char *key);
-const char *        nm_setting_vpn_get_service_type     (NMSettingVPN *setting);
-const char *        nm_setting_vpn_get_user_name        (NMSettingVPN *setting);
-NMSetting *         nm_setting_vpn_new                  (void);
-void                nm_setting_vpn_remove_data_item     (NMSettingVPN *setting,
-                                                         const char *key);
 void                nm_setting_vpn_remove_secret        (NMSettingVPN *setting,
                                                          const char *key);
+void                nm_setting_vpn_foreach_secret       (NMSettingVPN *setting,
+                                                         NMVPNIterFunc func,
+                                                         gpointer user_data);
 

Object Hierarchy

+
+  GEnum
+   +----NMSettingVpnError
+
   GObject
    +----NMSetting
          +----NMSettingVPN
 
-
-  GEnum
-   +----NMSettingVpnError
-

Properties

@@ -120,23 +120,8 @@ properties.

Details

-

NMSettingVPN

-
typedef struct _NMSettingVPN NMSettingVPN;
-

-

-
-
-
-

NMSettingVPNClass

-
typedef struct {
-	NMSettingClass parent;
-
-	/* Padding for future expansion */
-	void (*_reserved1) (void);
-	void (*_reserved2) (void);
-	void (*_reserved3) (void);
-	void (*_reserved4) (void);
-} NMSettingVPNClass;
+

NM_SETTING_VPN_SETTING_NAME

+
#define NM_SETTING_VPN_SETTING_NAME "vpn"
 

@@ -150,8 +135,11 @@ properties. NM_SETTING_VPN_ERROR_MISSING_PROPERTY, /*< nick=MissingProperty >*/ } NMSettingVpnError;
-
+
+++ @@ -174,105 +162,109 @@ required
-

NMVPNIterFunc ()

-
void                (*NMVPNIterFunc)                    (const char *key,
-                                                         const char *value,
-                                                         gpointer user_data);
-

NM_SETTING_VPN_ERROR_UNKNOWN

+

NM_SETTING_VPN_ERROR

+
#define NM_SETTING_VPN_ERROR nm_setting_vpn_error_quark ()
+
+

+

+ +
+
+

nm_setting_vpn_error_quark ()

+
GQuark              nm_setting_vpn_error_quark          (void);
+

+Registers an error quark for NMSettingVPN if necessary. +

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

key :

the name of the data or secret item

value :

the value of the data or secret item

user_data :

User data passed to nm_setting_vpn_foreach_data_item() or -nm_setting_vpn_foreach_secret() -

Returns :

the error quark used for NMSettingVPN errors.

-

NM_SETTING_VPN_DATA

-
#define NM_SETTING_VPN_DATA         "data"
+

NM_SETTING_VPN_SERVICE_TYPE

+
#define NM_SETTING_VPN_SERVICE_TYPE "service-type"
 


-

NM_SETTING_VPN_ERROR

-
#define NM_SETTING_VPN_ERROR nm_setting_vpn_error_quark ()
+

NM_SETTING_VPN_USER_NAME

+
#define NM_SETTING_VPN_USER_NAME    "user-name"
 


-

NM_SETTING_VPN_SECRETS

-
#define NM_SETTING_VPN_SECRETS      "secrets"
+

NM_SETTING_VPN_DATA

+
#define NM_SETTING_VPN_DATA         "data"
 


-

NM_SETTING_VPN_SERVICE_TYPE

-
#define NM_SETTING_VPN_SERVICE_TYPE "service-type"
+

NM_SETTING_VPN_SECRETS

+
#define NM_SETTING_VPN_SECRETS      "secrets"
 


-

NM_SETTING_VPN_SETTING_NAME

-
#define NM_SETTING_VPN_SETTING_NAME "vpn"
-
+

NMSettingVPN

+
typedef struct _NMSettingVPN NMSettingVPN;


-

NM_SETTING_VPN_USER_NAME

-
#define NM_SETTING_VPN_USER_NAME    "user-name"
+

NMSettingVPNClass

+
typedef struct {
+	NMSettingClass parent;
+
+	/* Padding for future expansion */
+	void (*_reserved1) (void);
+	void (*_reserved2) (void);
+	void (*_reserved3) (void);
+	void (*_reserved4) (void);
+} NMSettingVPNClass;
 


-

nm_setting_vpn_add_data_item ()

-
void                nm_setting_vpn_add_data_item        (NMSettingVPN *setting,
-                                                         const char *key,
-                                                         const char *item);
-

-Establishes a relationship between key and item internally in the -setting which may be retrieved later. Should not be used to store passwords -or other secrets, which is what nm_setting_vpn_add_secret() is for. -

-
+

NMVPNIterFunc ()

+
void                (*NMVPNIterFunc)                    (const char *key,
+                                                         const char *value,
+                                                         gpointer user_data);
+
+++ - - + + - - + + - - + @@ -280,16 +272,36 @@ or other secrets, which is what -

nm_setting_vpn_add_secret ()

-
void                nm_setting_vpn_add_secret           (NMSettingVPN *setting,
-                                                         const char *key,
-                                                         const char *secret);
+

nm_setting_vpn_new ()

+
NMSetting *         nm_setting_vpn_new                  (void);

-Establishes a relationship between key and secret internally in the -setting which may be retrieved later. +Creates a new NMSettingVPN object with default values.

-

setting :

the NMSettingVPN -

key :

the name of the data or secret item

key :

a name that uniquely identifies the given value item -

value :

the value of the data or secret item

item :

the value to be referenced by key +

user_data :

User data passed to nm_setting_vpn_foreach_data_item() or +nm_setting_vpn_foreach_secret()
+
+++ + + + + +

Returns :

the new empty NMSettingVPN object. [transfer full] +
+
+
+
+

nm_setting_vpn_get_service_type ()

+
const char *        nm_setting_vpn_get_service_type     (NMSettingVPN *setting);
+

+Returns the service name of the VPN, which identifies the specific VPN +plugin that should be used to connect to this VPN. +

+
++++ @@ -297,92 +309,89 @@ setting which may be retrieved later. - - - - - - + +

setting :

key :

a name that uniquely identifies the given secret secret -

secret :

the secret to be referenced by key -

Returns :

the VPN plugin's service name

-

nm_setting_vpn_error_quark ()

-
GQuark              nm_setting_vpn_error_quark          (void);
-

-Registers an error quark for NMSettingVPN if necessary. -

-
+

nm_setting_vpn_get_user_name ()

+
const char *        nm_setting_vpn_get_user_name        (NMSettingVPN *setting);
+
+- ++ + + + + + + - - + + +

setting :

the NMSettingVPN +

Returns :

the error quark used for NMSettingVPN errors.
the "user-name" property of the setting

-

nm_setting_vpn_foreach_data_item ()

-
void                nm_setting_vpn_foreach_data_item    (NMSettingVPN *setting,
-                                                         NMVPNIterFunc func,
-                                                         gpointer user_data);
+

nm_setting_vpn_get_num_data_items ()

+
guint32             nm_setting_vpn_get_num_data_items   (NMSettingVPN *setting);

-Iterates all data items stored in this setting. It is safe to add, remove, -and modify data items inside func, though any additions or removals made -during iteration will not be part of the iteration. +Gets number of key/value pairs of VPN configuration data.

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

setting :

a NMSettingVPN -

func :

an user provided function. [scope call] +the NMSettingVPN

user_data :

data to be passed to func -

Returns :

the number of VPN plugin specific configuration data items

-

nm_setting_vpn_foreach_secret ()

-
void                nm_setting_vpn_foreach_secret       (NMSettingVPN *setting,
-                                                         NMVPNIterFunc func,
-                                                         gpointer user_data);
+

nm_setting_vpn_add_data_item ()

+
void                nm_setting_vpn_add_data_item        (NMSettingVPN *setting,
+                                                         const char *key,
+                                                         const char *item);

-Iterates all secrets stored in this setting. It is safe to add, remove, -and modify secrets inside func, though any additions or removals made during -iteration will not be part of the iteration. +Establishes a relationship between key and item internally in the +setting which may be retrieved later. Should not be used to store passwords +or other secrets, which is what nm_setting_vpn_add_secret() is for.

-
+
+++ - - - + - - + @@ -397,8 +406,11 @@ iteration will not be part of the iteration. Retrieves the data item of a key/value relationship previously established by nm_setting_vpn_add_data_item().

-

setting :

a NMSettingVPN +the NMSettingVPN

func :

an user provided function. [scope call] +

key :

a name that uniquely identifies the given value item

user_data :

data to be passed to func +

item :

the value to be referenced by key
+
+++ @@ -418,13 +430,18 @@ by -

nm_setting_vpn_get_num_data_items ()

-
guint32             nm_setting_vpn_get_num_data_items   (NMSettingVPN *setting);
+

nm_setting_vpn_remove_data_item ()

+
void                nm_setting_vpn_remove_data_item     (NMSettingVPN *setting,
+                                                         const char *key);

-Gets number of key/value pairs of VPN configuration data. +Deletes a key/value relationship previously established by +nm_setting_vpn_add_data_item().

-

setting :

+
+++ @@ -432,45 +449,59 @@ Gets number of key/value pairs of VPN configuration data. - - + +

setting :

Returns :

the number of VPN plugin specific configuration data items

key :

the name of the data item to remove

-

nm_setting_vpn_get_num_secrets ()

-
guint32             nm_setting_vpn_get_num_secrets      (NMSettingVPN *setting);
+

nm_setting_vpn_foreach_data_item ()

+
void                nm_setting_vpn_foreach_data_item    (NMSettingVPN *setting,
+                                                         NMVPNIterFunc func,
+                                                         gpointer user_data);

-Gets number of VPN plugin specific secrets in the setting. +Iterates all data items stored in this setting. It is safe to add, remove, +and modify data items inside func, though any additions or removals made +during iteration will not be part of the iteration.

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

setting :

the NMSettingVPN +a NMSettingVPN

Returns :

the number of VPN plugin specific secrets

func :

an user provided function. [scope call] +

user_data :

data to be passed to func +

-

nm_setting_vpn_get_secret ()

-
const char *        nm_setting_vpn_get_secret           (NMSettingVPN *setting,
-                                                         const char *key);
+

nm_setting_vpn_get_num_secrets ()

+
guint32             nm_setting_vpn_get_num_secrets      (NMSettingVPN *setting);

-Retrieves the secret of a key/value relationship previously established -by nm_setting_vpn_add_secret(). +Gets number of VPN plugin specific secrets in the setting.

-
+
+++ @@ -478,26 +509,27 @@ by key :

-
- - - +

setting :

the name of the secret to retrieve

Returns :

the secret, if anythe number of VPN plugin specific secrets

-

nm_setting_vpn_get_service_type ()

-
const char *        nm_setting_vpn_get_service_type     (NMSettingVPN *setting);
+

nm_setting_vpn_add_secret ()

+
void                nm_setting_vpn_add_secret           (NMSettingVPN *setting,
+                                                         const char *key,
+                                                         const char *secret);

-Returns the service name of the VPN, which identifies the specific VPN -plugin that should be used to connect to this VPN. +Establishes a relationship between key and secret internally in the +setting which may be retrieved later.

-
+
+++ @@ -505,18 +537,32 @@ plugin that should be used to connect to this VPN. - - + + + + + +

setting :

Returns :

the VPN plugin's service name

key :

a name that uniquely identifies the given secret secret +

secret :

the secret to be referenced by key +

-

nm_setting_vpn_get_user_name ()

-
const char *        nm_setting_vpn_get_user_name        (NMSettingVPN *setting);
-
+

nm_setting_vpn_get_secret ()

+
const char *        nm_setting_vpn_get_secret           (NMSettingVPN *setting,
+                                                         const char *key);
+

+Retrieves the secret of a key/value relationship previously established +by nm_setting_vpn_add_secret(). +

+
+++ @@ -524,39 +570,30 @@ plugin that should be used to connect to this VPN. + + + + - +

setting :

key :

the name of the secret to retrieve

Returns :

the "user-name" property of the settingthe secret, if any

-

nm_setting_vpn_new ()

-
NMSetting *         nm_setting_vpn_new                  (void);
-

-Creates a new NMSettingVPN object with default values. -

-
-- - - - -

Returns :

the new empty NMSettingVPN object. [transfer full] -
-
-
-
-

nm_setting_vpn_remove_data_item ()

-
void                nm_setting_vpn_remove_data_item     (NMSettingVPN *setting,
+

nm_setting_vpn_remove_secret ()

+
void                nm_setting_vpn_remove_secret        (NMSettingVPN *setting,
                                                          const char *key);

Deletes a key/value relationship previously established by -nm_setting_vpn_add_data_item(). +nm_setting_vpn_add_secret().

-
+
+++ @@ -565,31 +602,42 @@ Deletes a key/value relationship previously established by - +

setting :

key :

the name of the data item to removethe name of the secret to remove

-

nm_setting_vpn_remove_secret ()

-
void                nm_setting_vpn_remove_secret        (NMSettingVPN *setting,
-                                                         const char *key);
+

nm_setting_vpn_foreach_secret ()

+
void                nm_setting_vpn_foreach_secret       (NMSettingVPN *setting,
+                                                         NMVPNIterFunc func,
+                                                         gpointer user_data);

-Deletes a key/value relationship previously established by -nm_setting_vpn_add_secret(). +Iterates all secrets stored in this setting. It is safe to add, remove, +and modify secrets inside func, though any additions or removals made during +iteration will not be part of the iteration.

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

setting :

the NMSettingVPN +a NMSettingVPN

key :

the name of the secret to remove

func :

an user provided function. [scope call] +

user_data :

data to be passed to func +
@@ -643,6 +691,6 @@ VPN connection.
+ Generated by GTK-Doc V1.19
\ No newline at end of file diff --git a/docs/libnm-util/html/NMSettingVlan.html b/docs/libnm-util/html/NMSettingVlan.html index b1edb3ad..edc209ba 100644 --- a/docs/libnm-util/html/NMSettingVlan.html +++ b/docs/libnm-util/html/NMSettingVlan.html @@ -3,12 +3,12 @@ NMSettingVlan - + - + @@ -41,51 +41,55 @@

Synopsis

-
+
 #include <nm-setting-vlan.h>
 
-                    NMSettingVlan;
-                    NMSettingVlanClass;
+#define             NM_SETTING_VLAN_SETTING_NAME
 enum                NMSettingVlanError;
-enum                NMVlanFlags;
-enum                NMVlanPriorityMap;
-#define             NM_SETTING_VLAN_EGRESS_PRIORITY_MAP
 #define             NM_SETTING_VLAN_ERROR
-#define             NM_SETTING_VLAN_FLAGS
-#define             NM_SETTING_VLAN_ID
-#define             NM_SETTING_VLAN_INGRESS_PRIORITY_MAP
+GQuark              nm_setting_vlan_error_quark         (void);
 #define             NM_SETTING_VLAN_INTERFACE_NAME
 #define             NM_SETTING_VLAN_PARENT
-#define             NM_SETTING_VLAN_SETTING_NAME
-gboolean            nm_setting_vlan_add_priority        (NMSettingVlan *setting,
-                                                         NMVlanPriorityMap map,
-                                                         guint32 from,
-                                                         guint32 to);
-gboolean            nm_setting_vlan_add_priority_str    (NMSettingVlan *setting,
-                                                         NMVlanPriorityMap map,
-                                                         const char *str);
-void                nm_setting_vlan_clear_priorities    (NMSettingVlan *setting,
-                                                         NMVlanPriorityMap map);
-GQuark              nm_setting_vlan_error_quark         (void);
-guint32             nm_setting_vlan_get_flags           (NMSettingVlan *setting);
-guint32             nm_setting_vlan_get_id              (NMSettingVlan *setting);
+#define             NM_SETTING_VLAN_ID
+#define             NM_SETTING_VLAN_FLAGS
+#define             NM_SETTING_VLAN_INGRESS_PRIORITY_MAP
+#define             NM_SETTING_VLAN_EGRESS_PRIORITY_MAP
+                    NMSettingVlan;
+                    NMSettingVlanClass;
+enum                NMVlanPriorityMap;
+enum                NMVlanFlags;
+NMSetting *         nm_setting_vlan_new                 (void);
 const char *        nm_setting_vlan_get_interface_name  (NMSettingVlan *setting);
+const char *        nm_setting_vlan_get_parent          (NMSettingVlan *setting);
+guint32             nm_setting_vlan_get_id              (NMSettingVlan *setting);
+guint32             nm_setting_vlan_get_flags           (NMSettingVlan *setting);
 gint32              nm_setting_vlan_get_num_priorities  (NMSettingVlan *setting,
                                                          NMVlanPriorityMap map);
-const char *        nm_setting_vlan_get_parent          (NMSettingVlan *setting);
 gboolean            nm_setting_vlan_get_priority        (NMSettingVlan *setting,
                                                          NMVlanPriorityMap map,
                                                          guint32 idx,
                                                          guint32 *out_from,
                                                          guint32 *out_to);
-NMSetting *         nm_setting_vlan_new                 (void);
+gboolean            nm_setting_vlan_add_priority        (NMSettingVlan *setting,
+                                                         NMVlanPriorityMap map,
+                                                         guint32 from,
+                                                         guint32 to);
 void                nm_setting_vlan_remove_priority     (NMSettingVlan *setting,
                                                          NMVlanPriorityMap map,
                                                          guint32 idx);
+void                nm_setting_vlan_clear_priorities    (NMSettingVlan *setting,
+                                                         NMVlanPriorityMap map);
+gboolean            nm_setting_vlan_add_priority_str    (NMSettingVlan *setting,
+                                                         NMVlanPriorityMap map,
+                                                         const char *str);
 

Object Hierarchy

+
+  GEnum
+   +----NMSettingVlanError
+
   GObject
    +----NMSetting
@@ -93,16 +97,12 @@ const char *        
   GEnum
-   +----NMSettingVlanError
+   +----NMVlanPriorityMap
 
   GEnum
    +----NMVlanFlags
 
-
-  GEnum
-   +----NMVlanPriorityMap
-

Properties

@@ -125,23 +125,8 @@ necessary for connection to VLAN interfaces.

Details

-

NMSettingVlan

-
typedef struct _NMSettingVlan NMSettingVlan;
-

-

-
-
-
-

NMSettingVlanClass

-
typedef struct {
-	NMSettingClass parent;
-
-	/* Padding for future expansion */
-	void (*_reserved1) (void);
-	void (*_reserved2) (void);
-	void (*_reserved3) (void);
-	void (*_reserved4) (void);
-} NMSettingVlanClass;
+

NM_SETTING_VLAN_SETTING_NAME

+
#define NM_SETTING_VLAN_SETTING_NAME "vlan"
 

@@ -156,8 +141,11 @@ necessary for connection to VLAN interfaces. NM_SETTING_VLAN_ERROR_INVALID_PARENT /*< nick=InvalidParent >*/ } NMSettingVlanError;
-
+
+++ @@ -186,99 +174,58 @@ necessary for connection to VLAN interfaces.
-

enum NMVlanFlags

-
typedef enum {
-	NM_VLAN_FLAG_REORDER_HEADERS = 0x1,
-	NM_VLAN_FLAG_GVRP            = 0x2,
-	NM_VLAN_FLAG_LOOSE_BINDING   = 0x4,
-
-	/* NOTE: if adding flags update nm-setting-vlan.c::verify() */
-} NMVlanFlags;
+

NM_SETTING_VLAN_ERROR

+
#define NM_SETTING_VLAN_ERROR nm_setting_vlan_error_quark ()
 

-NMVlanFlags values control the behavior of the VLAN interface.

-

NM_SETTING_VLAN_ERROR_UNKNOWN

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

NM_VLAN_FLAG_REORDER_HEADERS

indicates that this interface should reorder - outgoing packet headers to look more like a non-VLAN ethernet interface -

NM_VLAN_FLAG_GVRP

indicates that this interface should use GVRP to register - itself with it's switch -

NM_VLAN_FLAG_LOOSE_BINDING

indicates that this interface's operating - state is tied to the underlying network interface but other details - (like routing) are not. -

-

enum NMVlanPriorityMap

-
typedef enum {
-	NM_VLAN_INGRESS_MAP,
-	NM_VLAN_EGRESS_MAP
-} NMVlanPriorityMap;
-
+

nm_setting_vlan_error_quark ()

+
GQuark              nm_setting_vlan_error_quark         (void);

-A selector for traffic priority maps; these map Linux SKB priorities -to 802.1p priorities used in VLANs. +Registers an error quark for NMSettingVlan if necessary.

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

NM_VLAN_INGRESS_MAP

map for incoming data -

NM_VLAN_EGRESS_MAP

map for outgoing data -

Returns :

the error quark used for NMSettingVlan errors.

-

NM_SETTING_VLAN_EGRESS_PRIORITY_MAP

-
#define NM_SETTING_VLAN_EGRESS_PRIORITY_MAP  "egress-priority-map"
+

NM_SETTING_VLAN_INTERFACE_NAME

+
#define NM_SETTING_VLAN_INTERFACE_NAME       "interface-name"
 


-

NM_SETTING_VLAN_ERROR

-
#define NM_SETTING_VLAN_ERROR nm_setting_vlan_error_quark ()
+

NM_SETTING_VLAN_PARENT

+
#define NM_SETTING_VLAN_PARENT               "parent"
 


-

NM_SETTING_VLAN_FLAGS

-
#define NM_SETTING_VLAN_FLAGS                "flags"
+

NM_SETTING_VLAN_ID

+
#define NM_SETTING_VLAN_ID                   "id"
 


-

NM_SETTING_VLAN_ID

-
#define NM_SETTING_VLAN_ID                   "id"
+

NM_SETTING_VLAN_FLAGS

+
#define NM_SETTING_VLAN_FLAGS                "flags"
 

@@ -293,124 +240,136 @@ to 802.1p priorities used in VLANs.

-

NM_SETTING_VLAN_INTERFACE_NAME

-
#define NM_SETTING_VLAN_INTERFACE_NAME       "interface-name"
+

NM_SETTING_VLAN_EGRESS_PRIORITY_MAP

+
#define NM_SETTING_VLAN_EGRESS_PRIORITY_MAP  "egress-priority-map"
 


-

NM_SETTING_VLAN_PARENT

-
#define NM_SETTING_VLAN_PARENT               "parent"
-
+

NMSettingVlan

+
typedef struct _NMSettingVlan NMSettingVlan;


-

NM_SETTING_VLAN_SETTING_NAME

-
#define NM_SETTING_VLAN_SETTING_NAME "vlan"
+

NMSettingVlanClass

+
typedef struct {
+	NMSettingClass parent;
+
+	/* Padding for future expansion */
+	void (*_reserved1) (void);
+	void (*_reserved2) (void);
+	void (*_reserved3) (void);
+	void (*_reserved4) (void);
+} NMSettingVlanClass;
 


-

nm_setting_vlan_add_priority ()

-
gboolean            nm_setting_vlan_add_priority        (NMSettingVlan *setting,
-                                                         NMVlanPriorityMap map,
-                                                         guint32 from,
-                                                         guint32 to);
-

-Adds a priority mapping to the "ingress_priority_map" or -"egress_priority_map" properties of the setting. If from is -already in the given priority map, this function will overwrite the -existing entry with the new to. -

-

-If map is NM_VLAN_INGRESS_MAP then from is the incoming 802.1q VLAN -Priority Code Point (PCP) value, and to is the Linux SKB priority value. -

+

enum NMVlanPriorityMap

+
typedef enum {
+	NM_VLAN_INGRESS_MAP,
+	NM_VLAN_EGRESS_MAP
+} NMVlanPriorityMap;
+

-If map is NM_VLAN_EGRESS_MAP then from is the Linux SKB priority value and -to is the outgoing 802.1q VLAN Priority Code Point (PCP) value. +A selector for traffic priority maps; these map Linux SKB priorities +to 802.1p priorities used in VLANs.

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

setting :

the NMSettingVlan +

NM_VLAN_INGRESS_MAP

map for incoming data

map :

the type of priority map

from :

the priority to map to to +

NM_VLAN_EGRESS_MAP

map for outgoing data

to :

the priority to map from to

Returns :

TRUE if the new priority mapping was successfully added to the -list, FALSE if error

-

nm_setting_vlan_add_priority_str ()

-
gboolean            nm_setting_vlan_add_priority_str    (NMSettingVlan *setting,
-                                                         NMVlanPriorityMap map,
-                                                         const char *str);
+

enum NMVlanFlags

+
typedef enum {
+	NM_VLAN_FLAG_REORDER_HEADERS = 0x1,
+	NM_VLAN_FLAG_GVRP            = 0x2,
+	NM_VLAN_FLAG_LOOSE_BINDING   = 0x4,
+
+	/* NOTE: if adding flags update nm-setting-vlan.c::verify() */
+} NMVlanFlags;
+

-Adds a priority map entry into either the "ingress_priority_map" -or the "egress_priority_map" properties. The priority map maps -the Linux SKB priorities to 802.1p priorities. +NMVlanFlags values control the behavior of the VLAN interface.

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

setting :

the NMSettingVlan +

NM_VLAN_FLAG_REORDER_HEADERS

indicates that this interface should reorder + outgoing packet headers to look more like a non-VLAN ethernet interface

map :

the type of priority map

str :

the string which contains a priority map, like "3:7"

NM_VLAN_FLAG_GVRP

indicates that this interface should use GVRP to register + itself with it's switch +

Returns :

TRUE if the entry was successfully added to the list, or it -overwrote the old value, FALSE if error

NM_VLAN_FLAG_LOOSE_BINDING

indicates that this interface's operating + state is tied to the underlying network interface but other details + (like routing) are not. +

-

nm_setting_vlan_clear_priorities ()

-
void                nm_setting_vlan_clear_priorities    (NMSettingVlan *setting,
-                                                         NMVlanPriorityMap map);
+

nm_setting_vlan_new ()

+
NMSetting *         nm_setting_vlan_new                 (void);

-Clear all the entires from "ingress_priority_map" or -"egress_priority_map" properties. +Creates a new NMSettingVlan object with default values.

-
+
++++ + + + + +

Returns :

the new empty NMSettingVlan object. [transfer full] +
+
+
+
+

nm_setting_vlan_get_interface_name ()

+
const char *        nm_setting_vlan_get_interface_name  (NMSettingVlan *setting);
+
+++ @@ -418,33 +377,21 @@ Clear all the entires from map :

-
+ +

setting :

the type of priority map

Returns :

the "interface_name" property of the setting

-

nm_setting_vlan_error_quark ()

-
GQuark              nm_setting_vlan_error_quark         (void);
-

-Registers an error quark for NMSettingVlan if necessary. -

-
-- - - - -

Returns :

the error quark used for NMSettingVlan errors.
-
-
-
-

nm_setting_vlan_get_flags ()

-
guint32             nm_setting_vlan_get_flags           (NMSettingVlan *setting);
-
+

nm_setting_vlan_get_parent ()

+
const char *        nm_setting_vlan_get_parent          (NMSettingVlan *setting);
+
+++ @@ -453,7 +400,7 @@ Registers an error quark for Returns :

-
+

setting :

the "flags" property of the settingthe "parent" property of the setting
@@ -462,8 +409,11 @@ Registers an error quark for

nm_setting_vlan_get_id ()

guint32             nm_setting_vlan_get_id              (NMSettingVlan *setting);
-
+
+++ @@ -479,10 +429,13 @@ Registers an error quark for -

nm_setting_vlan_get_interface_name ()

-
const char *        nm_setting_vlan_get_interface_name  (NMSettingVlan *setting);
-

setting :

+

nm_setting_vlan_get_flags ()

+
guint32             nm_setting_vlan_get_flags           (NMSettingVlan *setting);
+
+++ @@ -491,7 +444,7 @@ Registers an error quark for Returns :

-
+

setting :

the "interface_name" property of the settingthe "flags" property of the setting
@@ -506,8 +459,11 @@ Returns the number of entires in the "ingress_priority_map" or "egress_priority_map" properties of this setting.

-
+
+++ @@ -527,25 +483,6 @@ properties of this setting.
-

nm_setting_vlan_get_parent ()

-
const char *        nm_setting_vlan_get_parent          (NMSettingVlan *setting);
-

setting :

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

setting :

the NMSettingVlan -

Returns :

the "parent" property of the setting
-
-
-

nm_setting_vlan_get_priority ()

gboolean            nm_setting_vlan_get_priority        (NMSettingVlan *setting,
                                                          NMVlanPriorityMap map,
@@ -556,8 +493,11 @@ properties of this setting.
 Retrieve one of the entries of the "ingress_priority_map"
 or "egress_priority_map" properties of this setting.
 

-
+
+++ @@ -592,18 +532,55 @@ or
-

nm_setting_vlan_new ()

-
NMSetting *         nm_setting_vlan_new                 (void);
+

nm_setting_vlan_add_priority ()

+
gboolean            nm_setting_vlan_add_priority        (NMSettingVlan *setting,
+                                                         NMVlanPriorityMap map,
+                                                         guint32 from,
+                                                         guint32 to);

-Creates a new NMSettingVlan object with default values. +Adds a priority mapping to the "ingress_priority_map" or +"egress_priority_map" properties of the setting. If from is +already in the given priority map, this function will overwrite the +existing entry with the new to.

-

setting :

+

+If map is NM_VLAN_INGRESS_MAP then from is the incoming 802.1q VLAN +Priority Code Point (PCP) value, and to is the Linux SKB priority value. +

+

+If map is NM_VLAN_EGRESS_MAP then from is the Linux SKB priority value and +to is the outgoing 802.1q VLAN Priority Code Point (PCP) value. +

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

Returns :

the new empty NMSettingVlan object. [transfer full] +

setting :

the NMSettingVlan

map :

the type of priority map

from :

the priority to map to to +

to :

the priority to map from to

Returns :

TRUE if the new priority mapping was successfully added to the +list, FALSE if error

@@ -617,8 +594,11 @@ Removes the priority map at index idx fr "ingress_priority_map" or "egress_priority_map" properties.

-
+
+++ @@ -636,6 +616,71 @@ properties.

setting :

+
+
+

nm_setting_vlan_clear_priorities ()

+
void                nm_setting_vlan_clear_priorities    (NMSettingVlan *setting,
+                                                         NMVlanPriorityMap map);
+

+Clear all the entires from "ingress_priority_map" or +"egress_priority_map" properties. +

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

setting :

the NMSettingVlan +

map :

the type of priority map
+
+
+
+

nm_setting_vlan_add_priority_str ()

+
gboolean            nm_setting_vlan_add_priority_str    (NMSettingVlan *setting,
+                                                         NMVlanPriorityMap map,
+                                                         const char *str);
+

+Adds a priority map entry into either the "ingress_priority_map" +or the "egress_priority_map" properties. The priority map maps +the Linux SKB priorities to 802.1p priorities. +

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

setting :

the NMSettingVlan +

map :

the type of priority map

str :

the string which contains a priority map, like "3:7"

Returns :

TRUE if the entry was successfully added to the list, or it +overwrote the old value, FALSE if error
+

Property Details

@@ -708,6 +753,6 @@ hardware-specific setting, like
- Generated by GTK-Doc V1.18
+ Generated by GTK-Doc V1.19 \ No newline at end of file diff --git a/docs/libnm-util/html/NMSettingWimax.html b/docs/libnm-util/html/NMSettingWimax.html index ee30d02e..00676582 100644 --- a/docs/libnm-util/html/NMSettingWimax.html +++ b/docs/libnm-util/html/NMSettingWimax.html @@ -3,12 +3,12 @@ NMSettingWimax - + - + @@ -44,30 +44,30 @@
 #include <nm-setting-wimax.h>
 
-                    NMSettingWimax;
-                    NMSettingWimaxClass;
+#define             NM_SETTING_WIMAX_SETTING_NAME
 enum                NMSettingWimaxError;
 #define             NM_SETTING_WIMAX_ERROR
-#define             NM_SETTING_WIMAX_MAC_ADDRESS
-#define             NM_SETTING_WIMAX_NETWORK_NAME
-#define             NM_SETTING_WIMAX_SETTING_NAME
 GQuark              nm_setting_wimax_error_quark        (void);
-const GByteArray *  nm_setting_wimax_get_mac_address    (NMSettingWimax *setting);
-const char *        nm_setting_wimax_get_network_name   (NMSettingWimax *setting);
+#define             NM_SETTING_WIMAX_NETWORK_NAME
+#define             NM_SETTING_WIMAX_MAC_ADDRESS
+                    NMSettingWimax;
+                    NMSettingWimaxClass;
 NMSetting *         nm_setting_wimax_new                (void);
+const char *        nm_setting_wimax_get_network_name   (NMSettingWimax *setting);
+const GByteArray *  nm_setting_wimax_get_mac_address    (NMSettingWimax *setting);
 

Object Hierarchy

+
+  GEnum
+   +----NMSettingWimaxError
+
   GObject
    +----NMSetting
          +----NMSettingWimax
 
-
-  GEnum
-   +----NMSettingWimaxError
-

Properties

@@ -86,17 +86,8 @@ necessary for connection to 802.16e Mobile WiMAX networks.

Details

-

NMSettingWimax

-
typedef struct _NMSettingWimax NMSettingWimax;
-

-

-
-
-
-

NMSettingWimaxClass

-
typedef struct {
-	NMSettingClass parent;
-} NMSettingWimaxClass;
+

NM_SETTING_WIMAX_SETTING_NAME

+
#define NM_SETTING_WIMAX_SETTING_NAME "wimax"
 

@@ -110,8 +101,11 @@ necessary for connection to 802.16e Mobile WiMAX networks. NM_SETTING_WIMAX_ERROR_MISSING_PROPERTY /*< nick=MissingProperty >*/ } NMSettingWimaxError;
-
+
+++ @@ -142,11 +136,21 @@ required
-

NM_SETTING_WIMAX_MAC_ADDRESS

-
#define NM_SETTING_WIMAX_MAC_ADDRESS  "mac-address"
-
+

nm_setting_wimax_error_quark ()

+
GQuark              nm_setting_wimax_error_quark        (void);

+Registers an error quark for NMSettingWimax if necessary.

+

NM_SETTING_WIMAX_ERROR_UNKNOWN

++++ + + + + +

Returns :

the error quark used for NMSettingWimax errors.

@@ -158,37 +162,60 @@ required

-

NM_SETTING_WIMAX_SETTING_NAME

-
#define NM_SETTING_WIMAX_SETTING_NAME "wimax"
+

NM_SETTING_WIMAX_MAC_ADDRESS

+
#define NM_SETTING_WIMAX_MAC_ADDRESS  "mac-address"
 


-

nm_setting_wimax_error_quark ()

-
GQuark              nm_setting_wimax_error_quark        (void);
+

NMSettingWimax

+
typedef struct _NMSettingWimax NMSettingWimax;

-Registers an error quark for NMSettingWimax if necessary.

-
+ +
+
+

NMSettingWimaxClass

+
typedef struct {
+	NMSettingClass parent;
+} NMSettingWimaxClass;
+
+

+

+
+
+
+

nm_setting_wimax_new ()

+
NMSetting *         nm_setting_wimax_new                (void);
+

+Creates a new NMSettingWimax object with default values. +

+
+++ - +

Returns :

the error quark used for NMSettingWimax errors.the new empty NMSettingWimax object

-

nm_setting_wimax_get_mac_address ()

-
const GByteArray *  nm_setting_wimax_get_mac_address    (NMSettingWimax *setting);
+

nm_setting_wimax_get_network_name ()

+
const char *        nm_setting_wimax_get_network_name   (NMSettingWimax *setting);

-Returns the MAC address of a WiMAX device which this connection is locked -to. +Returns the WiMAX NSP name (ex "Sprint" or "CLEAR") which identifies the +specific WiMAX network this setting describes a connection to.

-
+
+++ @@ -197,21 +224,24 @@ to. - +

setting :

Returns :

the MAC addressthe WiMAX NSP name

-

nm_setting_wimax_get_network_name ()

-
const char *        nm_setting_wimax_get_network_name   (NMSettingWimax *setting);
+

nm_setting_wimax_get_mac_address ()

+
const GByteArray *  nm_setting_wimax_get_mac_address    (NMSettingWimax *setting);

-Returns the WiMAX NSP name (ex "Sprint" or "CLEAR") which identifies the -specific WiMAX network this setting describes a connection to. +Returns the MAC address of a WiMAX device which this connection is locked +to.

-
+
+++ @@ -220,26 +250,11 @@ specific WiMAX network this setting describes a connection to. - +

setting :

Returns :

the WiMAX NSP namethe MAC address
-
-
-

nm_setting_wimax_new ()

-
NMSetting *         nm_setting_wimax_new                (void);
-

-Creates a new NMSettingWimax object with default values. -

-
-- - - - -

Returns :

the new empty NMSettingWimax object
-

Property Details

@@ -266,6 +281,6 @@ should use.
+ Generated by GTK-Doc V1.19
\ No newline at end of file diff --git a/docs/libnm-util/html/NMSettingWired.html b/docs/libnm-util/html/NMSettingWired.html index d56f053f..75d9cf16 100644 --- a/docs/libnm-util/html/NMSettingWired.html +++ b/docs/libnm-util/html/NMSettingWired.html @@ -3,12 +3,12 @@ NMSettingWired - + - + @@ -44,38 +44,39 @@
 #include <nm-setting-wired.h>
 
-                    NMSettingWired;
-                    NMSettingWiredClass;
+#define             NM_SETTING_WIRED_SETTING_NAME
 enum                NMSettingWiredError;
-#define             NM_SETTING_WIRED_AUTO_NEGOTIATE
-#define             NM_SETTING_WIRED_CLONED_MAC_ADDRESS
-#define             NM_SETTING_WIRED_DUPLEX
 #define             NM_SETTING_WIRED_ERROR
+GQuark              nm_setting_wired_error_quark        (void);
+#define             NM_SETTING_WIRED_PORT
+#define             NM_SETTING_WIRED_SPEED
+#define             NM_SETTING_WIRED_DUPLEX
+#define             NM_SETTING_WIRED_AUTO_NEGOTIATE
 #define             NM_SETTING_WIRED_MAC_ADDRESS
+#define             NM_SETTING_WIRED_CLONED_MAC_ADDRESS
 #define             NM_SETTING_WIRED_MAC_ADDRESS_BLACKLIST
 #define             NM_SETTING_WIRED_MTU
-#define             NM_SETTING_WIRED_PORT
+#define             NM_SETTING_WIRED_S390_SUBCHANNELS
 #define             NM_SETTING_WIRED_S390_NETTYPE
 #define             NM_SETTING_WIRED_S390_OPTIONS
-#define             NM_SETTING_WIRED_S390_SUBCHANNELS
-#define             NM_SETTING_WIRED_SETTING_NAME
-#define             NM_SETTING_WIRED_SPEED
-gboolean            nm_setting_wired_add_s390_option    (NMSettingWired *setting,
-                                                         const char *key,
-                                                         const char *item);
-GQuark              nm_setting_wired_error_quark        (void);
+                    NMSettingWired;
+                    NMSettingWiredClass;
+NMSetting *         nm_setting_wired_new                (void);
+const char *        nm_setting_wired_get_port           (NMSettingWired *setting);
+guint32             nm_setting_wired_get_speed          (NMSettingWired *setting);
+const char *        nm_setting_wired_get_duplex         (NMSettingWired *setting);
 gboolean            nm_setting_wired_get_auto_negotiate (NMSettingWired *setting);
+const GByteArray *  nm_setting_wired_get_mac_address    (NMSettingWired *setting);
 const GByteArray *  nm_setting_wired_get_cloned_mac_address
                                                         (NMSettingWired *setting);
-const char *        nm_setting_wired_get_duplex         (NMSettingWired *setting);
-const GByteArray *  nm_setting_wired_get_mac_address    (NMSettingWired *setting);
 const GSList *      nm_setting_wired_get_mac_address_blacklist
                                                         (NMSettingWired *setting);
 guint32             nm_setting_wired_get_mtu            (NMSettingWired *setting);
-guint32             nm_setting_wired_get_num_s390_options
+const GPtrArray *   nm_setting_wired_get_s390_subchannels
                                                         (NMSettingWired *setting);
-const char *        nm_setting_wired_get_port           (NMSettingWired *setting);
 const char *        nm_setting_wired_get_s390_nettype   (NMSettingWired *setting);
+guint32             nm_setting_wired_get_num_s390_options
+                                                        (NMSettingWired *setting);
 gboolean            nm_setting_wired_get_s390_option    (NMSettingWired *setting,
                                                          guint32 idx,
                                                          const char **out_key,
@@ -83,25 +84,24 @@ const char *        char *        nm_setting_wired_get_s390_option_by_key
                                                         (NMSettingWired *setting,
                                                          const char *key);
-const GPtrArray *   nm_setting_wired_get_s390_subchannels
-                                                        (NMSettingWired *setting);
-guint32             nm_setting_wired_get_speed          (NMSettingWired *setting);
-NMSetting *         nm_setting_wired_new                (void);
+gboolean            nm_setting_wired_add_s390_option    (NMSettingWired *setting,
+                                                         const char *key,
+                                                         const char *item);
 gboolean            nm_setting_wired_remove_s390_option (NMSettingWired *setting,
                                                          const char *key);
 

Object Hierarchy

+
+  GEnum
+   +----NMSettingWiredError
+
   GObject
    +----NMSetting
          +----NMSettingWired
 
-
-  GEnum
-   +----NMSettingWiredError
-

Properties

@@ -129,23 +129,8 @@ necessary for connection to Ethernet networks.

Details

-

NMSettingWired

-
typedef struct _NMSettingWired NMSettingWired;
-

-

-
-
-
-

NMSettingWiredClass

-
typedef struct {
-	NMSettingClass parent;
-
-	/* Padding for future expansion */
-	void (*_reserved1) (void);
-	void (*_reserved2) (void);
-	void (*_reserved3) (void);
-	void (*_reserved4) (void);
-} NMSettingWiredClass;
+

NM_SETTING_WIRED_SETTING_NAME

+
#define NM_SETTING_WIRED_SETTING_NAME "802-3-ethernet"
 

@@ -159,8 +144,11 @@ necessary for connection to Ethernet networks. NM_SETTING_WIRED_ERROR_MISSING_PROPERTY /*< nick=MissingProperty >*/ } NMSettingWiredError;
-
+
+++ @@ -183,80 +171,90 @@ required
-

NM_SETTING_WIRED_AUTO_NEGOTIATE

-
#define NM_SETTING_WIRED_AUTO_NEGOTIATE "auto-negotiate"
+

NM_SETTING_WIRED_ERROR

+
#define NM_SETTING_WIRED_ERROR nm_setting_wired_error_quark ()
 


-

NM_SETTING_WIRED_CLONED_MAC_ADDRESS

-
#define NM_SETTING_WIRED_CLONED_MAC_ADDRESS "cloned-mac-address"
-
+

nm_setting_wired_error_quark ()

+
GQuark              nm_setting_wired_error_quark        (void);

+Registers an error quark for NMSettingWired if necessary.

+

NM_SETTING_WIRED_ERROR_UNKNOWN

++++ + + + + +

Returns :

the error quark used for NMSettingWired errors.

-

NM_SETTING_WIRED_DUPLEX

-
#define NM_SETTING_WIRED_DUPLEX "duplex"
+

NM_SETTING_WIRED_PORT

+
#define NM_SETTING_WIRED_PORT "port"
 


-

NM_SETTING_WIRED_ERROR

-
#define NM_SETTING_WIRED_ERROR nm_setting_wired_error_quark ()
+

NM_SETTING_WIRED_SPEED

+
#define NM_SETTING_WIRED_SPEED "speed"
 


-

NM_SETTING_WIRED_MAC_ADDRESS

-
#define NM_SETTING_WIRED_MAC_ADDRESS "mac-address"
+

NM_SETTING_WIRED_DUPLEX

+
#define NM_SETTING_WIRED_DUPLEX "duplex"
 


-

NM_SETTING_WIRED_MAC_ADDRESS_BLACKLIST

-
#define NM_SETTING_WIRED_MAC_ADDRESS_BLACKLIST "mac-address-blacklist"
+

NM_SETTING_WIRED_AUTO_NEGOTIATE

+
#define NM_SETTING_WIRED_AUTO_NEGOTIATE "auto-negotiate"
 


-

NM_SETTING_WIRED_MTU

-
#define NM_SETTING_WIRED_MTU "mtu"
+

NM_SETTING_WIRED_MAC_ADDRESS

+
#define NM_SETTING_WIRED_MAC_ADDRESS "mac-address"
 


-

NM_SETTING_WIRED_PORT

-
#define NM_SETTING_WIRED_PORT "port"
+

NM_SETTING_WIRED_CLONED_MAC_ADDRESS

+
#define NM_SETTING_WIRED_CLONED_MAC_ADDRESS "cloned-mac-address"
 


-

NM_SETTING_WIRED_S390_NETTYPE

-
#define NM_SETTING_WIRED_S390_NETTYPE "s390-nettype"
+

NM_SETTING_WIRED_MAC_ADDRESS_BLACKLIST

+
#define NM_SETTING_WIRED_MAC_ADDRESS_BLACKLIST "mac-address-blacklist"
 


-

NM_SETTING_WIRED_S390_OPTIONS

-
#define NM_SETTING_WIRED_S390_OPTIONS "s390-options"
+

NM_SETTING_WIRED_MTU

+
#define NM_SETTING_WIRED_MTU "mtu"
 

@@ -271,50 +269,71 @@ required

-

NM_SETTING_WIRED_SETTING_NAME

-
#define NM_SETTING_WIRED_SETTING_NAME "802-3-ethernet"
+

NM_SETTING_WIRED_S390_NETTYPE

+
#define NM_SETTING_WIRED_S390_NETTYPE "s390-nettype"
 


-

NM_SETTING_WIRED_SPEED

-
#define NM_SETTING_WIRED_SPEED "speed"
+

NM_SETTING_WIRED_S390_OPTIONS

+
#define NM_SETTING_WIRED_S390_OPTIONS "s390-options"
 


-

nm_setting_wired_add_s390_option ()

-
gboolean            nm_setting_wired_add_s390_option    (NMSettingWired *setting,
-                                                         const char *key,
-                                                         const char *item);
+

NMSettingWired

+
typedef struct _NMSettingWired NMSettingWired;


-

nm_setting_wired_error_quark ()

-
GQuark              nm_setting_wired_error_quark        (void);
+

NMSettingWiredClass

+
typedef struct {
+	NMSettingClass parent;
+
+	/* Padding for future expansion */
+	void (*_reserved1) (void);
+	void (*_reserved2) (void);
+	void (*_reserved3) (void);
+	void (*_reserved4) (void);
+} NMSettingWiredClass;
+

-Registers an error quark for NMSettingWired if necessary.

-
+ +
+
+

nm_setting_wired_new ()

+
NMSetting *         nm_setting_wired_new                (void);
+

+Creates a new NMSettingWired object with default values. +

+
+++ - +

Returns :

the error quark used for NMSettingWired errors.the new empty NMSettingWired object. [transfer full] +

-

nm_setting_wired_get_auto_negotiate ()

-
gboolean            nm_setting_wired_get_auto_negotiate (NMSettingWired *setting);
-
+

nm_setting_wired_get_port ()

+
const char *        nm_setting_wired_get_port           (NMSettingWired *setting);
+
+++ @@ -323,18 +342,20 @@ Registers an error quark for Returns :

-
+

setting :

the "auto-negotiate" property of the settingthe "port" property of the setting

-

nm_setting_wired_get_cloned_mac_address ()

-
const GByteArray *  nm_setting_wired_get_cloned_mac_address
-                                                        (NMSettingWired *setting);
-
+

nm_setting_wired_get_speed ()

+
guint32             nm_setting_wired_get_speed          (NMSettingWired *setting);
+
+++ @@ -343,7 +364,7 @@ Registers an error quark for Returns :

-
+

setting :

the "cloned-mac-address" property of the settingthe "speed" property of the setting
@@ -352,8 +373,11 @@ Registers an error quark for

nm_setting_wired_get_duplex ()

const char *        nm_setting_wired_get_duplex         (NMSettingWired *setting);
-
+
+++ @@ -369,10 +393,35 @@ Registers an error quark for +

nm_setting_wired_get_auto_negotiate ()

+
gboolean            nm_setting_wired_get_auto_negotiate (NMSettingWired *setting);
+

setting :

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

setting :

the NMSettingWired +

Returns :

the "auto-negotiate" property of the setting
+
+
+

nm_setting_wired_get_mac_address ()

const GByteArray *  nm_setting_wired_get_mac_address    (NMSettingWired *setting);
-
+
+++ @@ -388,11 +437,37 @@ Registers an error quark for +

nm_setting_wired_get_cloned_mac_address ()

+
const GByteArray *  nm_setting_wired_get_cloned_mac_address
+                                                        (NMSettingWired *setting);
+

setting :

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

setting :

the NMSettingWired +

Returns :

the "cloned-mac-address" property of the setting
+
+
+

nm_setting_wired_get_mac_address_blacklist ()

const GSList *      nm_setting_wired_get_mac_address_blacklist
                                                         (NMSettingWired *setting);
-
+
+++ @@ -412,8 +487,11 @@ property of the setting. [

nm_setting_wired_get_mtu ()

guint32             nm_setting_wired_get_mtu            (NMSettingWired *setting);
-

setting :

+
+++ @@ -429,16 +507,19 @@ property of the setting. [ -

nm_setting_wired_get_num_s390_options ()

-
guint32             nm_setting_wired_get_num_s390_options
+

nm_setting_wired_get_s390_subchannels ()

+
const GPtrArray *   nm_setting_wired_get_s390_subchannels
                                                         (NMSettingWired *setting);

-Returns the number of s390-specific options that should be set for this -device when it is activated. This can be used to retrieve each s390 -option individually using nm_setting_wired_get_s390_option(). +Return the list of s390 subchannels that identify the device that this +connection is applicable to. The connection should only be used in +conjunction with that device.

-

setting :

+
+++ @@ -447,17 +528,27 @@ option individually using Returns :

-
+

setting :

the number of s390-specific device options +GPtrArray of strings, each specifying one +subchannel the s390 device uses to communicate to the host. [element-type utf8] +

-

nm_setting_wired_get_port ()

-
const char *        nm_setting_wired_get_port           (NMSettingWired *setting);
-
+

nm_setting_wired_get_s390_nettype ()

+
const char *        nm_setting_wired_get_s390_nettype   (NMSettingWired *setting);
+

+Returns the s390 device type this connection should apply to. Will be one +of 'qeth', 'lcs', or 'ctc'. +

+
+++ @@ -466,21 +557,26 @@ option individually using Returns :

-
+

setting :

the "port" property of the settingthe s390 device type

-

nm_setting_wired_get_s390_nettype ()

-
const char *        nm_setting_wired_get_s390_nettype   (NMSettingWired *setting);
+

nm_setting_wired_get_num_s390_options ()

+
guint32             nm_setting_wired_get_num_s390_options
+                                                        (NMSettingWired *setting);

-Returns the s390 device type this connection should apply to. Will be one -of 'qeth', 'lcs', or 'ctc'. +Returns the number of s390-specific options that should be set for this +device when it is activated. This can be used to retrieve each s390 +option individually using nm_setting_wired_get_s390_option().

-
+
+++ @@ -489,7 +585,7 @@ of 'qeth', 'lcs', or 'ctc'. - +

setting :

Returns :

the s390 device typethe number of s390-specific device options
@@ -508,8 +604,11 @@ are *not* guaranteed to be static across modifications to options done by and should not be used to refer to options except for short periods of time such as during option iteration.

-
+
+++ @@ -553,8 +652,11 @@ currently held by the setting) Returns the value associated with the s390-specific option specified by key, if it exists.

-

setting :

+
+++ @@ -567,7 +669,7 @@ Returns the value associated with the s390-specific option specified by - @@ -575,66 +677,12 @@ setting; the value is owned by the setting and must not be modified
-

nm_setting_wired_get_s390_subchannels ()

-
const GPtrArray *   nm_setting_wired_get_s390_subchannels
-                                                        (NMSettingWired *setting);
-

-Return the list of s390 subchannels that identify the device that this -connection is applicable to. The connection should only be used in -conjunction with that device. -

-

setting :

Returns :

the value, or NULL if the key/value pair was never added to the +the value, or NULL if the key/value pair was never added to the setting; the value is owned by the setting and must not be modified
-- - - - - - - - - - -

setting :

the NMSettingWired -

Returns :

-GPtrArray of strings, each specifying one -subchannel the s390 device uses to communicate to the host. [element-type utf8] -
-
-
-
-

nm_setting_wired_get_speed ()

-
guint32             nm_setting_wired_get_speed          (NMSettingWired *setting);
-
-- - - - - - - - - - -

setting :

the NMSettingWired -

Returns :

the "speed" property of the setting
-
-
-
-

nm_setting_wired_new ()

-
NMSetting *         nm_setting_wired_new                (void);
+

nm_setting_wired_add_s390_option ()

+
gboolean            nm_setting_wired_add_s390_option    (NMSettingWired *setting,
+                                                         const char *key,
+                                                         const char *item);

-Creates a new NMSettingWired object with default values.

-
-- - - - -

Returns :

the new empty NMSettingWired object. [transfer full] -

@@ -755,6 +803,7 @@ composed of hexadecimal characters and the period (.) character.
  "speed"                    guint                 : Read / Write / Construct

If non-zero, request that the device use only the specified speed. + In Mbit/s, ie 100 == 100Mbit/s.

Default value: 0

@@ -763,6 +812,6 @@ In Mbit/s, ie 100 == 100Mbit/s.
+ Generated by GTK-Doc V1.19
\ No newline at end of file diff --git a/docs/libnm-util/html/NMSettingWireless.html b/docs/libnm-util/html/NMSettingWireless.html index 3a144270..a792acc9 100644 --- a/docs/libnm-util/html/NMSettingWireless.html +++ b/docs/libnm-util/html/NMSettingWireless.html @@ -3,12 +3,12 @@ NMSettingWireless - + - + @@ -44,71 +44,71 @@
 #include <nm-setting-wireless.h>
 
-                    NMSettingWireless;
-                    NMSettingWirelessClass;
+#define             NM_SETTING_WIRELESS_SETTING_NAME
 enum                NMSettingWirelessError;
+#define             NM_SETTING_WIRELESS_ERROR
+GQuark              nm_setting_wireless_error_quark     (void);
+#define             NM_SETTING_WIRELESS_SSID
+#define             NM_SETTING_WIRELESS_MODE
 #define             NM_SETTING_WIRELESS_BAND
-#define             NM_SETTING_WIRELESS_BSSID
 #define             NM_SETTING_WIRELESS_CHANNEL
-#define             NM_SETTING_WIRELESS_CLONED_MAC_ADDRESS
-#define             NM_SETTING_WIRELESS_ERROR
-#define             NM_SETTING_WIRELESS_HIDDEN
+#define             NM_SETTING_WIRELESS_BSSID
+#define             NM_SETTING_WIRELESS_RATE
+#define             NM_SETTING_WIRELESS_TX_POWER
 #define             NM_SETTING_WIRELESS_MAC_ADDRESS
+#define             NM_SETTING_WIRELESS_CLONED_MAC_ADDRESS
 #define             NM_SETTING_WIRELESS_MAC_ADDRESS_BLACKLIST
-#define             NM_SETTING_WIRELESS_MODE
+#define             NM_SETTING_WIRELESS_MTU
+#define             NM_SETTING_WIRELESS_SEEN_BSSIDS
+#define             NM_SETTING_WIRELESS_SEC
+#define             NM_SETTING_WIRELESS_HIDDEN
 #define             NM_SETTING_WIRELESS_MODE_ADHOC
 #define             NM_SETTING_WIRELESS_MODE_AP
 #define             NM_SETTING_WIRELESS_MODE_INFRA
-#define             NM_SETTING_WIRELESS_MTU
-#define             NM_SETTING_WIRELESS_RATE
-#define             NM_SETTING_WIRELESS_SEC
-#define             NM_SETTING_WIRELESS_SEEN_BSSIDS
-#define             NM_SETTING_WIRELESS_SETTING_NAME
-#define             NM_SETTING_WIRELESS_SSID
-#define             NM_SETTING_WIRELESS_TX_POWER
-gboolean            nm_setting_wireless_add_seen_bssid  (NMSettingWireless *setting,
-                                                         const char *bssid);
-gboolean            nm_setting_wireless_ap_security_compatible
-                                                        (NMSettingWireless *s_wireless,
-                                                         NMSettingWirelessSecurity *s_wireless_sec,
-                                                         NM80211ApFlags ap_flags,
-                                                         NM80211ApSecurityFlags ap_wpa,
-                                                         NM80211ApSecurityFlags ap_rsn,
-                                                         NM80211Mode ap_mode);
-GQuark              nm_setting_wireless_error_quark     (void);
+                    NMSettingWireless;
+                    NMSettingWirelessClass;
+NMSetting *         nm_setting_wireless_new             (void);
+const GByteArray *  nm_setting_wireless_get_ssid        (NMSettingWireless *setting);
+const char *        nm_setting_wireless_get_mode        (NMSettingWireless *setting);
 const char *        nm_setting_wireless_get_band        (NMSettingWireless *setting);
-const GByteArray *  nm_setting_wireless_get_bssid       (NMSettingWireless *setting);
 guint32             nm_setting_wireless_get_channel     (NMSettingWireless *setting);
+const GByteArray *  nm_setting_wireless_get_bssid       (NMSettingWireless *setting);
+guint32             nm_setting_wireless_get_rate        (NMSettingWireless *setting);
+guint32             nm_setting_wireless_get_tx_power    (NMSettingWireless *setting);
+const GByteArray *  nm_setting_wireless_get_mac_address (NMSettingWireless *setting);
 const GByteArray *  nm_setting_wireless_get_cloned_mac_address
                                                         (NMSettingWireless *setting);
-gboolean            nm_setting_wireless_get_hidden      (NMSettingWireless *setting);
-const GByteArray *  nm_setting_wireless_get_mac_address (NMSettingWireless *setting);
 const GSList *      nm_setting_wireless_get_mac_address_blacklist
                                                         (NMSettingWireless *setting);
-const char *        nm_setting_wireless_get_mode        (NMSettingWireless *setting);
 guint32             nm_setting_wireless_get_mtu         (NMSettingWireless *setting);
+const char *        nm_setting_wireless_get_security    (NMSettingWireless *setting);
+gboolean            nm_setting_wireless_get_hidden      (NMSettingWireless *setting);
+gboolean            nm_setting_wireless_add_seen_bssid  (NMSettingWireless *setting,
+                                                         const char *bssid);
 guint32             nm_setting_wireless_get_num_seen_bssids
                                                         (NMSettingWireless *setting);
-guint32             nm_setting_wireless_get_rate        (NMSettingWireless *setting);
-const char *        nm_setting_wireless_get_security    (NMSettingWireless *setting);
 const char *        nm_setting_wireless_get_seen_bssid  (NMSettingWireless *setting,
                                                          guint32 i);
-const GByteArray *  nm_setting_wireless_get_ssid        (NMSettingWireless *setting);
-guint32             nm_setting_wireless_get_tx_power    (NMSettingWireless *setting);
-NMSetting *         nm_setting_wireless_new             (void);
+gboolean            nm_setting_wireless_ap_security_compatible
+                                                        (NMSettingWireless *s_wireless,
+                                                         NMSettingWirelessSecurity *s_wireless_sec,
+                                                         NM80211ApFlags ap_flags,
+                                                         NM80211ApSecurityFlags ap_wpa,
+                                                         NM80211ApSecurityFlags ap_rsn,
+                                                         NM80211Mode ap_mode);
 

Object Hierarchy

+
+  GEnum
+   +----NMSettingWirelessError
+
   GObject
    +----NMSetting
          +----NMSettingWireless
 
-
-  GEnum
-   +----NMSettingWirelessError
-

Properties

@@ -139,23 +139,8 @@ necessary for connection to 802.11 WiFi networks.

Details

-

NMSettingWireless

-
typedef struct _NMSettingWireless NMSettingWireless;
-

-

-
-
-
-

NMSettingWirelessClass

-
typedef struct {
-	NMSettingClass parent;
-
-	/* Padding for future expansion */
-	void (*_reserved1) (void);
-	void (*_reserved2) (void);
-	void (*_reserved3) (void);
-	void (*_reserved4) (void);
-} NMSettingWirelessClass;
+

NM_SETTING_WIRELESS_SETTING_NAME

+
#define NM_SETTING_WIRELESS_SETTING_NAME "802-11-wireless"
 

@@ -171,8 +156,11 @@ necessary for connection to 802.11 WiFi networks. NM_SETTING_WIRELESS_ERROR_CHANNEL_REQUIRES_BAND /*< nick=ChannelRequiresBand >*/ } NMSettingWirelessError;
-
+
+++ @@ -207,104 +195,108 @@ set to a value that requires the -

NM_SETTING_WIRELESS_BAND

-
#define NM_SETTING_WIRELESS_BAND        "band"
+

NM_SETTING_WIRELESS_ERROR

+
#define NM_SETTING_WIRELESS_ERROR nm_setting_wireless_error_quark ()
 


-

NM_SETTING_WIRELESS_BSSID

-
#define NM_SETTING_WIRELESS_BSSID       "bssid"
-
+

nm_setting_wireless_error_quark ()

+
GQuark              nm_setting_wireless_error_quark     (void);

+Registers an error quark for NMSettingWireless if necessary.

+

NM_SETTING_WIRELESS_ERROR_UNKNOWN

++++ + + + + +

Returns :

the error quark used for NMSettingWireless errors.

-

NM_SETTING_WIRELESS_CHANNEL

-
#define NM_SETTING_WIRELESS_CHANNEL     "channel"
+

NM_SETTING_WIRELESS_SSID

+
#define NM_SETTING_WIRELESS_SSID        "ssid"
 


-

NM_SETTING_WIRELESS_CLONED_MAC_ADDRESS

-
#define NM_SETTING_WIRELESS_CLONED_MAC_ADDRESS "cloned-mac-address"
+

NM_SETTING_WIRELESS_MODE

+
#define NM_SETTING_WIRELESS_MODE        "mode"
 


-

NM_SETTING_WIRELESS_ERROR

-
#define NM_SETTING_WIRELESS_ERROR nm_setting_wireless_error_quark ()
+

NM_SETTING_WIRELESS_BAND

+
#define NM_SETTING_WIRELESS_BAND        "band"
 


-

NM_SETTING_WIRELESS_HIDDEN

-
#define NM_SETTING_WIRELESS_HIDDEN      "hidden"
+

NM_SETTING_WIRELESS_CHANNEL

+
#define NM_SETTING_WIRELESS_CHANNEL     "channel"
 


-

NM_SETTING_WIRELESS_MAC_ADDRESS

-
#define NM_SETTING_WIRELESS_MAC_ADDRESS "mac-address"
+

NM_SETTING_WIRELESS_BSSID

+
#define NM_SETTING_WIRELESS_BSSID       "bssid"
 


-

NM_SETTING_WIRELESS_MAC_ADDRESS_BLACKLIST

-
#define NM_SETTING_WIRELESS_MAC_ADDRESS_BLACKLIST "mac-address-blacklist"
+

NM_SETTING_WIRELESS_RATE

+
#define NM_SETTING_WIRELESS_RATE        "rate"
 


-

NM_SETTING_WIRELESS_MODE

-
#define NM_SETTING_WIRELESS_MODE        "mode"
+

NM_SETTING_WIRELESS_TX_POWER

+
#define NM_SETTING_WIRELESS_TX_POWER    "tx-power"
 


-

NM_SETTING_WIRELESS_MODE_ADHOC

-
#define NM_SETTING_WIRELESS_MODE_ADHOC  "adhoc"
+

NM_SETTING_WIRELESS_MAC_ADDRESS

+
#define NM_SETTING_WIRELESS_MAC_ADDRESS "mac-address"
 

-Indicates Ad-Hoc mode where no access point is expected to be present.


-

NM_SETTING_WIRELESS_MODE_AP

-
#define NM_SETTING_WIRELESS_MODE_AP     "ap"
+

NM_SETTING_WIRELESS_CLONED_MAC_ADDRESS

+
#define NM_SETTING_WIRELESS_CLONED_MAC_ADDRESS "cloned-mac-address"
 

-Indicates AP/master mode where the wireless device is started as an access -point/hotspot.

-

Since 0.9.8


-

NM_SETTING_WIRELESS_MODE_INFRA

-
#define NM_SETTING_WIRELESS_MODE_INFRA  "infrastructure"
+

NM_SETTING_WIRELESS_MAC_ADDRESS_BLACKLIST

+
#define NM_SETTING_WIRELESS_MAC_ADDRESS_BLACKLIST "mac-address-blacklist"
 

-Indicates infrastructure mode where an access point is expected to be present -for this connection.


@@ -317,8 +309,8 @@ for this connection.

-

NM_SETTING_WIRELESS_RATE

-
#define NM_SETTING_WIRELESS_RATE        "rate"
+

NM_SETTING_WIRELESS_SEEN_BSSIDS

+
#define NM_SETTING_WIRELESS_SEEN_BSSIDS "seen-bssids"
 

@@ -333,49 +325,93 @@ for this connection.

-

NM_SETTING_WIRELESS_SEEN_BSSIDS

-
#define NM_SETTING_WIRELESS_SEEN_BSSIDS "seen-bssids"
+

NM_SETTING_WIRELESS_HIDDEN

+
#define NM_SETTING_WIRELESS_HIDDEN      "hidden"
 


-

NM_SETTING_WIRELESS_SETTING_NAME

-
#define NM_SETTING_WIRELESS_SETTING_NAME "802-11-wireless"
+

NM_SETTING_WIRELESS_MODE_ADHOC

+
#define NM_SETTING_WIRELESS_MODE_ADHOC  "adhoc"
 

+Indicates Ad-Hoc mode where no access point is expected to be present.


-

NM_SETTING_WIRELESS_SSID

-
#define NM_SETTING_WIRELESS_SSID        "ssid"
+

NM_SETTING_WIRELESS_MODE_AP

+
#define NM_SETTING_WIRELESS_MODE_AP     "ap"
 

+Indicates AP/master mode where the wireless device is started as an access +point/hotspot.

+

Since 0.9.8


-

NM_SETTING_WIRELESS_TX_POWER

-
#define NM_SETTING_WIRELESS_TX_POWER    "tx-power"
+

NM_SETTING_WIRELESS_MODE_INFRA

+
#define NM_SETTING_WIRELESS_MODE_INFRA  "infrastructure"
 

+Indicates infrastructure mode where an access point is expected to be present +for this connection.


-

nm_setting_wireless_add_seen_bssid ()

-
gboolean            nm_setting_wireless_add_seen_bssid  (NMSettingWireless *setting,
-                                                         const char *bssid);
+

NMSettingWireless

+
typedef struct _NMSettingWireless NMSettingWireless;

-Adds a new Wi-Fi AP's BSSID to the previously seen BSSID list of the setting. -NetworkManager now tracks previously seen BSSIDs internally so this function -no longer has much use. Actually, changes you make using this function will -not be preserved.

-
+ +
+
+

NMSettingWirelessClass

+
typedef struct {
+	NMSettingClass parent;
+
+	/* Padding for future expansion */
+	void (*_reserved1) (void);
+	void (*_reserved2) (void);
+	void (*_reserved3) (void);
+	void (*_reserved4) (void);
+} NMSettingWirelessClass;
+
+

+

+
+
+
+

nm_setting_wireless_new ()

+
NMSetting *         nm_setting_wireless_new             (void);
+

+Creates a new NMSettingWireless object with default values. +

+
++++ + + + + +

Returns :

the new empty NMSettingWireless object. [transfer full] +
+
+
+
+

nm_setting_wireless_get_ssid ()

+
const GByteArray *  nm_setting_wireless_get_ssid        (NMSettingWireless *setting);
+
+++ @@ -383,96 +419,65 @@ not be preserved. - - - - - +

setting :

bssid :

the new BSSID to add to the list

Returns :

-TRUE if bssid was already known, FALSE if notthe "ssid" property of the setting

-

nm_setting_wireless_ap_security_compatible ()

-
gboolean            nm_setting_wireless_ap_security_compatible
-                                                        (NMSettingWireless *s_wireless,
-                                                         NMSettingWirelessSecurity *s_wireless_sec,
-                                                         NM80211ApFlags ap_flags,
-                                                         NM80211ApSecurityFlags ap_wpa,
-                                                         NM80211ApSecurityFlags ap_rsn,
-                                                         NM80211Mode ap_mode);
-

-Given a NMSettingWireless and an optional NMSettingWirelessSecurity, -determine if the configuration given by the settings is compatible with -the security of an access point using that access point's capability flags -and mode. Useful for clients that wish to filter a set of connections -against a set of access points and determine which connections are -compatible with which access points. -

-
+

nm_setting_wireless_get_mode ()

+
const char *        nm_setting_wireless_get_mode        (NMSettingWireless *setting);
+
+++ - - - - - - + - - - - - - - - - - - - - - - - - +

s_wireless :

a NMSettingWireless -

s_wireless_sec :

a NMSettingWirelessSecurity or NULL +

setting :

the NMSettingWireless

ap_flags :

the NM80211ApFlags of the given access point

ap_wpa :

the NM80211ApSecurityFlags of the given access point's WPA -capabilities

ap_rsn :

the NM80211ApSecurityFlags of the given access point's WPA2/RSN -capabilities

ap_mode :

the 802.11 mode of the AP, either Ad-Hoc or Infrastructure

Returns :

-TRUE if the given settings are compatible with the access point's -security flags and mode, FALSE if they are not.the "mode" property of the setting

-

nm_setting_wireless_error_quark ()

-
GQuark              nm_setting_wireless_error_quark     (void);
-

-Registers an error quark for NMSettingWireless if necessary. -

-
+

nm_setting_wireless_get_band ()

+
const char *        nm_setting_wireless_get_band        (NMSettingWireless *setting);
+
+- ++ + + + + + + - - + + +

setting :

the NMSettingWireless +

Returns :

the error quark used for NMSettingWireless errors.
the "band" property of the setting

-

nm_setting_wireless_get_band ()

-
const char *        nm_setting_wireless_get_band        (NMSettingWireless *setting);
-
+

nm_setting_wireless_get_channel ()

+
guint32             nm_setting_wireless_get_channel     (NMSettingWireless *setting);
+
+++ @@ -481,7 +486,7 @@ Registers an error quark for - +

setting :

Returns :

the "band" property of the settingthe "channel" property of the setting
@@ -490,8 +495,11 @@ Registers an error quark for

nm_setting_wireless_get_bssid ()

const GByteArray *  nm_setting_wireless_get_bssid       (NMSettingWireless *setting);
-
+
+++ @@ -507,10 +515,13 @@ Registers an error quark for
-

nm_setting_wireless_get_channel ()

-
guint32             nm_setting_wireless_get_channel     (NMSettingWireless *setting);
-

setting :

+

nm_setting_wireless_get_rate ()

+
guint32             nm_setting_wireless_get_rate        (NMSettingWireless *setting);
+
+++ @@ -519,18 +530,20 @@ Registers an error quark for - +

setting :

Returns :

the "channel" property of the settingthe "rate" property of the setting

-

nm_setting_wireless_get_cloned_mac_address ()

-
const GByteArray *  nm_setting_wireless_get_cloned_mac_address
-                                                        (NMSettingWireless *setting);
-
+

nm_setting_wireless_get_tx_power ()

+
guint32             nm_setting_wireless_get_tx_power    (NMSettingWireless *setting);
+
+++ @@ -539,17 +552,20 @@ Registers an error quark for - +

setting :

Returns :

the "cloned-mac-address" property of the settingthe "tx-power" property of the setting

-

nm_setting_wireless_get_hidden ()

-
gboolean            nm_setting_wireless_get_hidden      (NMSettingWireless *setting);
-
+

nm_setting_wireless_get_mac_address ()

+
const GByteArray *  nm_setting_wireless_get_mac_address (NMSettingWireless *setting);
+
+++ @@ -558,17 +574,21 @@ Registers an error quark for - +

setting :

Returns :

the "hidden" property of the settingthe "mac-address" property of the setting

-

nm_setting_wireless_get_mac_address ()

-
const GByteArray *  nm_setting_wireless_get_mac_address (NMSettingWireless *setting);
-
+

nm_setting_wireless_get_cloned_mac_address ()

+
const GByteArray *  nm_setting_wireless_get_cloned_mac_address
+                                                        (NMSettingWireless *setting);
+
+++ @@ -577,7 +597,7 @@ Registers an error quark for - +

setting :

Returns :

the "mac-address" property of the settingthe "cloned-mac-address" property of the setting
@@ -587,8 +607,11 @@ Registers an error quark for

nm_setting_wireless_get_mac_address_blacklist ()

const GSList *      nm_setting_wireless_get_mac_address_blacklist
                                                         (NMSettingWireless *setting);
-
+
+++ @@ -606,10 +629,13 @@ Registers an error quark for
-

nm_setting_wireless_get_mode ()

-
const char *        nm_setting_wireless_get_mode        (NMSettingWireless *setting);
-

setting :

+

nm_setting_wireless_get_mtu ()

+
guint32             nm_setting_wireless_get_mtu         (NMSettingWireless *setting);
+
+++ @@ -618,17 +644,20 @@ Registers an error quark for - +

setting :

Returns :

the "mode" property of the settingthe "mtu" property of the setting

-

nm_setting_wireless_get_mtu ()

-
guint32             nm_setting_wireless_get_mtu         (NMSettingWireless *setting);
-
+

nm_setting_wireless_get_security ()

+
const char *        nm_setting_wireless_get_security    (NMSettingWireless *setting);
+
+++ @@ -637,18 +666,20 @@ Registers an error quark for - +

setting :

Returns :

the "mtu" property of the settingthe "security" property of the setting

-

nm_setting_wireless_get_num_seen_bssids ()

-
guint32             nm_setting_wireless_get_num_seen_bssids
-                                                        (NMSettingWireless *setting);
-
+

nm_setting_wireless_get_hidden ()

+
gboolean            nm_setting_wireless_get_hidden      (NMSettingWireless *setting);
+
+++ @@ -657,17 +688,27 @@ Registers an error quark for - +

setting :

Returns :

the number of BSSIDs in the previously seen BSSID listthe "hidden" property of the setting

-

nm_setting_wireless_get_rate ()

-
guint32             nm_setting_wireless_get_rate        (NMSettingWireless *setting);
-
+

nm_setting_wireless_add_seen_bssid ()

+
gboolean            nm_setting_wireless_add_seen_bssid  (NMSettingWireless *setting,
+                                                         const char *bssid);
+

+Adds a new Wi-Fi AP's BSSID to the previously seen BSSID list of the setting. +NetworkManager now tracks previously seen BSSIDs internally so this function +no longer has much use. Actually, changes you make using this function will +not be preserved. +

+
+++ @@ -675,18 +716,27 @@ Registers an error quark for + + + + - +

setting :

bssid :

the new BSSID to add to the list

Returns :

the "rate" property of the setting +TRUE if bssid was already known, FALSE if not

-

nm_setting_wireless_get_security ()

-
const char *        nm_setting_wireless_get_security    (NMSettingWireless *setting);
-
+

nm_setting_wireless_get_num_seen_bssids ()

+
guint32             nm_setting_wireless_get_num_seen_bssids
+                                                        (NMSettingWireless *setting);
+
+++ @@ -695,7 +745,7 @@ Registers an error quark for - +

setting :

Returns :

the "security" property of the settingthe number of BSSIDs in the previously seen BSSID list
@@ -705,8 +755,11 @@ Registers an error quark for

nm_setting_wireless_get_seen_bssid ()

const char *        nm_setting_wireless_get_seen_bssid  (NMSettingWireless *setting,
                                                          guint32 i);
-
+
+++ @@ -727,58 +780,65 @@ Registers an error quark for
-

nm_setting_wireless_get_ssid ()

-
const GByteArray *  nm_setting_wireless_get_ssid        (NMSettingWireless *setting);
-

setting :

+

nm_setting_wireless_ap_security_compatible ()

+
gboolean            nm_setting_wireless_ap_security_compatible
+                                                        (NMSettingWireless *s_wireless,
+                                                         NMSettingWirelessSecurity *s_wireless_sec,
+                                                         NM80211ApFlags ap_flags,
+                                                         NM80211ApSecurityFlags ap_wpa,
+                                                         NM80211ApSecurityFlags ap_rsn,
+                                                         NM80211Mode ap_mode);
+

+Given a NMSettingWireless and an optional NMSettingWirelessSecurity, +determine if the configuration given by the settings is compatible with +the security of an access point using that access point's capability flags +and mode. Useful for clients that wish to filter a set of connections +against a set of access points and determine which connections are +compatible with which access points. +

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

setting :

the NMSettingWireless +

s_wireless :

a NMSettingWireless

Returns :

the "ssid" property of the setting

s_wireless_sec :

a NMSettingWirelessSecurity or NULL +
-
-
-
-

nm_setting_wireless_get_tx_power ()

-
guint32             nm_setting_wireless_get_tx_power    (NMSettingWireless *setting);
-
-- - - + + + + + + + + + + + + + + - +

setting :

the NMSettingWireless -

ap_flags :

the NM80211ApFlags of the given access point

ap_wpa :

the NM80211ApSecurityFlags of the given access point's WPA +capabilities

ap_rsn :

the NM80211ApSecurityFlags of the given access point's WPA2/RSN +capabilities

ap_mode :

the 802.11 mode of the AP, either Ad-Hoc or Infrastructure

Returns :

the "tx-power" property of the setting +TRUE if the given settings are compatible with the access point's +security flags and mode, FALSE if they are not.
-
-
-

nm_setting_wireless_new ()

-
NMSetting *         nm_setting_wireless_new             (void);
-

-Creates a new NMSettingWireless object with default values. -

-
-- - - - -

Returns :

the new empty NMSettingWireless object. [transfer full] -
-

Property Details

@@ -855,10 +915,9 @@ of the device (i.e. MAC spoofing).

The "mac-address-blacklist" property

  "mac-address-blacklist"    GSList_gchararray_*   : Read / Write

-If specified, this connection will never apply to the WiFi device -whose permanent MAC address matches an address in the list. Each -MAC address is in the standard hex-digits-and-colons notation. -(00:11:22:33:44:55). +A list of permanent MAC addresses of Wi-Fi devices to which this +connection should never apply. Each MAC address should be given in the +standard hex-digits-and-colons notation (eg '00:11:22:33:44:55').


@@ -939,6 +998,6 @@ devices support setting a static transmit power. + Generated by GTK-Doc V1.19 \ No newline at end of file diff --git a/docs/libnm-util/html/NMSettingWirelessSecurity.html b/docs/libnm-util/html/NMSettingWirelessSecurity.html index 94ff1432..bdde2c5b 100644 --- a/docs/libnm-util/html/NMSettingWirelessSecurity.html +++ b/docs/libnm-util/html/NMSettingWirelessSecurity.html @@ -3,12 +3,12 @@ NMSettingWirelessSecurity - + - + @@ -45,107 +45,102 @@ use WEP, LEAP, WPA or WPA2/RSN security

 #include <nm-setting-wireless-security.h>
 
-                    NMSettingWirelessSecurity;
-                    NMSettingWirelessSecurityClass;
+#define             NM_SETTING_WIRELESS_SECURITY_SETTING_NAME
 enum                NMSettingWirelessSecurityError;
+#define             NM_SETTING_WIRELESS_SECURITY_ERROR
+GQuark              nm_setting_wireless_security_error_quark
+                                                        (void);
 enum                NMWepKeyType;
+#define             NM_SETTING_WIRELESS_SECURITY_KEY_MGMT
+#define             NM_SETTING_WIRELESS_SECURITY_WEP_TX_KEYIDX
 #define             NM_SETTING_WIRELESS_SECURITY_AUTH_ALG
-#define             NM_SETTING_WIRELESS_SECURITY_ERROR
+#define             NM_SETTING_WIRELESS_SECURITY_PROTO
+#define             NM_SETTING_WIRELESS_SECURITY_PAIRWISE
 #define             NM_SETTING_WIRELESS_SECURITY_GROUP
-#define             NM_SETTING_WIRELESS_SECURITY_KEY_MGMT
-#define             NM_SETTING_WIRELESS_SECURITY_LEAP_PASSWORD
-#define             NM_SETTING_WIRELESS_SECURITY_LEAP_PASSWORD_FLAGS
 #define             NM_SETTING_WIRELESS_SECURITY_LEAP_USERNAME
-#define             NM_SETTING_WIRELESS_SECURITY_PAIRWISE
-#define             NM_SETTING_WIRELESS_SECURITY_PROTO
-#define             NM_SETTING_WIRELESS_SECURITY_PSK
-#define             NM_SETTING_WIRELESS_SECURITY_PSK_FLAGS
-#define             NM_SETTING_WIRELESS_SECURITY_SETTING_NAME
 #define             NM_SETTING_WIRELESS_SECURITY_WEP_KEY0
 #define             NM_SETTING_WIRELESS_SECURITY_WEP_KEY1
 #define             NM_SETTING_WIRELESS_SECURITY_WEP_KEY2
 #define             NM_SETTING_WIRELESS_SECURITY_WEP_KEY3
 #define             NM_SETTING_WIRELESS_SECURITY_WEP_KEY_FLAGS
 #define             NM_SETTING_WIRELESS_SECURITY_WEP_KEY_TYPE
-#define             NM_SETTING_WIRELESS_SECURITY_WEP_TX_KEYIDX
-gboolean            nm_setting_wireless_security_add_group
-                                                        (NMSettingWirelessSecurity *setting,
-                                                         const char *group);
-gboolean            nm_setting_wireless_security_add_pairwise
+#define             NM_SETTING_WIRELESS_SECURITY_PSK
+#define             NM_SETTING_WIRELESS_SECURITY_PSK_FLAGS
+#define             NM_SETTING_WIRELESS_SECURITY_LEAP_PASSWORD
+#define             NM_SETTING_WIRELESS_SECURITY_LEAP_PASSWORD_FLAGS
+                    NMSettingWirelessSecurity;
+                    NMSettingWirelessSecurityClass;
+NMSetting *         nm_setting_wireless_security_new    (void);
+const char *        nm_setting_wireless_security_get_key_mgmt
+                                                        (NMSettingWirelessSecurity *setting);
+guint32             nm_setting_wireless_security_get_num_protos
+                                                        (NMSettingWirelessSecurity *setting);
+const char *        nm_setting_wireless_security_get_proto
                                                         (NMSettingWirelessSecurity *setting,
-                                                         const char *pairwise);
+                                                         guint32 i);
 gboolean            nm_setting_wireless_security_add_proto
                                                         (NMSettingWirelessSecurity *setting,
                                                          const char *proto);
-void                nm_setting_wireless_security_clear_groups
-                                                        (NMSettingWirelessSecurity *setting);
-void                nm_setting_wireless_security_clear_pairwise
-                                                        (NMSettingWirelessSecurity *setting);
+void                nm_setting_wireless_security_remove_proto
+                                                        (NMSettingWirelessSecurity *setting,
+                                                         guint32 i);
 void                nm_setting_wireless_security_clear_protos
                                                         (NMSettingWirelessSecurity *setting);
-GQuark              nm_setting_wireless_security_error_quark
-                                                        (void);
-const char *        nm_setting_wireless_security_get_auth_alg
+guint32             nm_setting_wireless_security_get_num_pairwise
                                                         (NMSettingWirelessSecurity *setting);
-const char *        nm_setting_wireless_security_get_group
+const char *        nm_setting_wireless_security_get_pairwise
                                                         (NMSettingWirelessSecurity *setting,
                                                          guint32 i);
-const char *        nm_setting_wireless_security_get_key_mgmt
-                                                        (NMSettingWirelessSecurity *setting);
-const char *        nm_setting_wireless_security_get_leap_password
-                                                        (NMSettingWirelessSecurity *setting);
-NMSettingSecretFlags nm_setting_wireless_security_get_leap_password_flags
-                                                        (NMSettingWirelessSecurity *setting);
-const char *        nm_setting_wireless_security_get_leap_username
+gboolean            nm_setting_wireless_security_add_pairwise
+                                                        (NMSettingWirelessSecurity *setting,
+                                                         const char *pairwise);
+void                nm_setting_wireless_security_remove_pairwise
+                                                        (NMSettingWirelessSecurity *setting,
+                                                         guint32 i);
+void                nm_setting_wireless_security_clear_pairwise
                                                         (NMSettingWirelessSecurity *setting);
 guint32             nm_setting_wireless_security_get_num_groups
                                                         (NMSettingWirelessSecurity *setting);
-guint32             nm_setting_wireless_security_get_num_pairwise
-                                                        (NMSettingWirelessSecurity *setting);
-guint32             nm_setting_wireless_security_get_num_protos
-                                                        (NMSettingWirelessSecurity *setting);
-const char *        nm_setting_wireless_security_get_pairwise
+const char *        nm_setting_wireless_security_get_group
                                                         (NMSettingWirelessSecurity *setting,
                                                          guint32 i);
-const char *        nm_setting_wireless_security_get_proto
+gboolean            nm_setting_wireless_security_add_group
+                                                        (NMSettingWirelessSecurity *setting,
+                                                         const char *group);
+void                nm_setting_wireless_security_remove_group
                                                         (NMSettingWirelessSecurity *setting,
                                                          guint32 i);
+void                nm_setting_wireless_security_clear_groups
+                                                        (NMSettingWirelessSecurity *setting);
 const char *        nm_setting_wireless_security_get_psk
                                                         (NMSettingWirelessSecurity *setting);
 NMSettingSecretFlags nm_setting_wireless_security_get_psk_flags
                                                         (NMSettingWirelessSecurity *setting);
-const char *        nm_setting_wireless_security_get_wep_key
-                                                        (NMSettingWirelessSecurity *setting,
-                                                         guint32 idx);
-NMSettingSecretFlags nm_setting_wireless_security_get_wep_key_flags
+const char *        nm_setting_wireless_security_get_leap_username
                                                         (NMSettingWirelessSecurity *setting);
-NMWepKeyType        nm_setting_wireless_security_get_wep_key_type
+const char *        nm_setting_wireless_security_get_leap_password
                                                         (NMSettingWirelessSecurity *setting);
-guint32             nm_setting_wireless_security_get_wep_tx_keyidx
+NMSettingSecretFlags nm_setting_wireless_security_get_leap_password_flags
                                                         (NMSettingWirelessSecurity *setting);
-NMSetting *         nm_setting_wireless_security_new    (void);
-void                nm_setting_wireless_security_remove_group
-                                                        (NMSettingWirelessSecurity *setting,
-                                                         guint32 i);
-void                nm_setting_wireless_security_remove_pairwise
-                                                        (NMSettingWirelessSecurity *setting,
-                                                         guint32 i);
-void                nm_setting_wireless_security_remove_proto
+const char *        nm_setting_wireless_security_get_wep_key
                                                         (NMSettingWirelessSecurity *setting,
-                                                         guint32 i);
+                                                         guint32 idx);
 void                nm_setting_wireless_security_set_wep_key
                                                         (NMSettingWirelessSecurity *setting,
                                                          guint32 idx,
                                                          const char *key);
+guint32             nm_setting_wireless_security_get_wep_tx_keyidx
+                                                        (NMSettingWirelessSecurity *setting);
+const char *        nm_setting_wireless_security_get_auth_alg
+                                                        (NMSettingWirelessSecurity *setting);
+NMSettingSecretFlags nm_setting_wireless_security_get_wep_key_flags
+                                                        (NMSettingWirelessSecurity *setting);
+NMWepKeyType        nm_setting_wireless_security_get_wep_key_type
+                                                        (NMSettingWirelessSecurity *setting);
 

Object Hierarchy

-
-  GObject
-   +----NMSetting
-         +----NMSettingWirelessSecurity
-
   GEnum
    +----NMSettingWirelessSecurityError
@@ -154,6 +149,11 @@ const char *        
+  GObject
+   +----NMSetting
+         +----NMSettingWirelessSecurity
+

Properties

@@ -203,23 +203,8 @@ of how WiFi security works, you may want to get copies of the following books.

Details

-

NMSettingWirelessSecurity

-
typedef struct _NMSettingWirelessSecurity NMSettingWirelessSecurity;
-

-

-
-
-
-

NMSettingWirelessSecurityClass

-
typedef struct {
-	NMSettingClass parent;
-
-	/* Padding for future expansion */
-	void (*_reserved1) (void);
-	void (*_reserved2) (void);
-	void (*_reserved3) (void);
-	void (*_reserved4) (void);
-} NMSettingWirelessSecurityClass;
+

NM_SETTING_WIRELESS_SECURITY_SETTING_NAME

+
#define NM_SETTING_WIRELESS_SECURITY_SETTING_NAME "802-11-wireless-security"
 

@@ -237,8 +222,11 @@ of how WiFi security works, you may want to get copies of the following books. NM_SETTING_WIRELESS_SECURITY_ERROR_SHARED_KEY_REQUIRES_WEP /*< nick=SharedKeyRequiresWEP >*/ } NMSettingWirelessSecurityError;
-
+
+++ @@ -286,6 +274,33 @@ encryption protocol
+

NM_SETTING_WIRELESS_SECURITY_ERROR

+
#define NM_SETTING_WIRELESS_SECURITY_ERROR nm_setting_wireless_security_error_quark ()
+
+

+

+
+
+
+

nm_setting_wireless_security_error_quark ()

+
GQuark              nm_setting_wireless_security_error_quark
+                                                        (void);
+

+Registers an error quark for NMSettingWired if necessary. +

+

NM_SETTING_WIRELESS_SECURITY_ERROR_UNKNOWN

++++ + + + + +

Returns :

the error quark used for NMSettingWired errors.
+
+
+

enum NMWepKeyType

typedef enum {
 	NM_WEP_KEY_TYPE_UNKNOWN = 0,
@@ -306,8 +321,11 @@ ASCII keys are also valid WEP passphrases, but since passphrases and ASCII
 keys are hashed differently to determine the actual WEP key the type must be
 specified.
 

-
+
+++ @@ -340,48 +358,48 @@ the actual WEP key using the MD5 hash algorithm.
-

NM_SETTING_WIRELESS_SECURITY_AUTH_ALG

-
#define NM_SETTING_WIRELESS_SECURITY_AUTH_ALG "auth-alg"
+

NM_SETTING_WIRELESS_SECURITY_KEY_MGMT

+
#define NM_SETTING_WIRELESS_SECURITY_KEY_MGMT "key-mgmt"
 


-

NM_SETTING_WIRELESS_SECURITY_ERROR

-
#define NM_SETTING_WIRELESS_SECURITY_ERROR nm_setting_wireless_security_error_quark ()
+

NM_SETTING_WIRELESS_SECURITY_WEP_TX_KEYIDX

+
#define NM_SETTING_WIRELESS_SECURITY_WEP_TX_KEYIDX "wep-tx-keyidx"
 


-

NM_SETTING_WIRELESS_SECURITY_GROUP

-
#define NM_SETTING_WIRELESS_SECURITY_GROUP "group"
+

NM_SETTING_WIRELESS_SECURITY_AUTH_ALG

+
#define NM_SETTING_WIRELESS_SECURITY_AUTH_ALG "auth-alg"
 


-

NM_SETTING_WIRELESS_SECURITY_KEY_MGMT

-
#define NM_SETTING_WIRELESS_SECURITY_KEY_MGMT "key-mgmt"
+

NM_SETTING_WIRELESS_SECURITY_PROTO

+
#define NM_SETTING_WIRELESS_SECURITY_PROTO "proto"
 


-

NM_SETTING_WIRELESS_SECURITY_LEAP_PASSWORD

-
#define NM_SETTING_WIRELESS_SECURITY_LEAP_PASSWORD "leap-password"
+

NM_SETTING_WIRELESS_SECURITY_PAIRWISE

+
#define NM_SETTING_WIRELESS_SECURITY_PAIRWISE "pairwise"
 


-

NM_SETTING_WIRELESS_SECURITY_LEAP_PASSWORD_FLAGS

-
#define NM_SETTING_WIRELESS_SECURITY_LEAP_PASSWORD_FLAGS "leap-password-flags"
+

NM_SETTING_WIRELESS_SECURITY_GROUP

+
#define NM_SETTING_WIRELESS_SECURITY_GROUP "group"
 

@@ -396,148 +414,184 @@ the actual WEP key using the MD5 hash algorithm.

-

NM_SETTING_WIRELESS_SECURITY_PAIRWISE

-
#define NM_SETTING_WIRELESS_SECURITY_PAIRWISE "pairwise"
+

NM_SETTING_WIRELESS_SECURITY_WEP_KEY0

+
#define NM_SETTING_WIRELESS_SECURITY_WEP_KEY0 "wep-key0"
 


-

NM_SETTING_WIRELESS_SECURITY_PROTO

-
#define NM_SETTING_WIRELESS_SECURITY_PROTO "proto"
+

NM_SETTING_WIRELESS_SECURITY_WEP_KEY1

+
#define NM_SETTING_WIRELESS_SECURITY_WEP_KEY1 "wep-key1"
 


-

NM_SETTING_WIRELESS_SECURITY_PSK

-
#define NM_SETTING_WIRELESS_SECURITY_PSK "psk"
+

NM_SETTING_WIRELESS_SECURITY_WEP_KEY2

+
#define NM_SETTING_WIRELESS_SECURITY_WEP_KEY2 "wep-key2"
 


-

NM_SETTING_WIRELESS_SECURITY_PSK_FLAGS

-
#define NM_SETTING_WIRELESS_SECURITY_PSK_FLAGS "psk-flags"
+

NM_SETTING_WIRELESS_SECURITY_WEP_KEY3

+
#define NM_SETTING_WIRELESS_SECURITY_WEP_KEY3 "wep-key3"
 


-

NM_SETTING_WIRELESS_SECURITY_SETTING_NAME

-
#define NM_SETTING_WIRELESS_SECURITY_SETTING_NAME "802-11-wireless-security"
+

NM_SETTING_WIRELESS_SECURITY_WEP_KEY_FLAGS

+
#define NM_SETTING_WIRELESS_SECURITY_WEP_KEY_FLAGS "wep-key-flags"
 


-

NM_SETTING_WIRELESS_SECURITY_WEP_KEY0

-
#define NM_SETTING_WIRELESS_SECURITY_WEP_KEY0 "wep-key0"
+

NM_SETTING_WIRELESS_SECURITY_WEP_KEY_TYPE

+
#define NM_SETTING_WIRELESS_SECURITY_WEP_KEY_TYPE "wep-key-type"
 


-

NM_SETTING_WIRELESS_SECURITY_WEP_KEY1

-
#define NM_SETTING_WIRELESS_SECURITY_WEP_KEY1 "wep-key1"
+

NM_SETTING_WIRELESS_SECURITY_PSK

+
#define NM_SETTING_WIRELESS_SECURITY_PSK "psk"
 


-

NM_SETTING_WIRELESS_SECURITY_WEP_KEY2

-
#define NM_SETTING_WIRELESS_SECURITY_WEP_KEY2 "wep-key2"
+

NM_SETTING_WIRELESS_SECURITY_PSK_FLAGS

+
#define NM_SETTING_WIRELESS_SECURITY_PSK_FLAGS "psk-flags"
 


-

NM_SETTING_WIRELESS_SECURITY_WEP_KEY3

-
#define NM_SETTING_WIRELESS_SECURITY_WEP_KEY3 "wep-key3"
+

NM_SETTING_WIRELESS_SECURITY_LEAP_PASSWORD

+
#define NM_SETTING_WIRELESS_SECURITY_LEAP_PASSWORD "leap-password"
 


-

NM_SETTING_WIRELESS_SECURITY_WEP_KEY_FLAGS

-
#define NM_SETTING_WIRELESS_SECURITY_WEP_KEY_FLAGS "wep-key-flags"
+

NM_SETTING_WIRELESS_SECURITY_LEAP_PASSWORD_FLAGS

+
#define NM_SETTING_WIRELESS_SECURITY_LEAP_PASSWORD_FLAGS "leap-password-flags"
 


-

NM_SETTING_WIRELESS_SECURITY_WEP_KEY_TYPE

-
#define NM_SETTING_WIRELESS_SECURITY_WEP_KEY_TYPE "wep-key-type"
-
+

NMSettingWirelessSecurity

+
typedef struct _NMSettingWirelessSecurity NMSettingWirelessSecurity;


-

NM_SETTING_WIRELESS_SECURITY_WEP_TX_KEYIDX

-
#define NM_SETTING_WIRELESS_SECURITY_WEP_TX_KEYIDX "wep-tx-keyidx"
+

NMSettingWirelessSecurityClass

+
typedef struct {
+	NMSettingClass parent;
+
+	/* Padding for future expansion */
+	void (*_reserved1) (void);
+	void (*_reserved2) (void);
+	void (*_reserved3) (void);
+	void (*_reserved4) (void);
+} NMSettingWirelessSecurityClass;
 


-

nm_setting_wireless_security_add_group ()

-
gboolean            nm_setting_wireless_security_add_group
-                                                        (NMSettingWirelessSecurity *setting,
-                                                         const char *group);
+

nm_setting_wireless_security_new ()

+
NMSetting *         nm_setting_wireless_security_new    (void);

-Adds an encryption algorithm to the list of allowed groupwise encryption -algorithms. If the list is not empty, then only access points that support -one or more of the encryption algorithms in the list will be considered -compatible with this connection. +Creates a new NMSettingWirelessSecurity object with default values.

-

NM_WEP_KEY_TYPE_UNKNOWN

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

setting :

the NMSettingWirelessSecurity -

Returns :

the new empty NMSettingWirelessSecurity object. [transfer full] +
+
+
+
+

nm_setting_wireless_security_get_key_mgmt ()

+
const char *        nm_setting_wireless_security_get_key_mgmt
+                                                        (NMSettingWirelessSecurity *setting);
+
++++ + - - + + - +

group :

the encryption algorithm to add, one of "wep40", "wep104", -"tkip", or "ccmp"

setting :

the NMSettingWirelessSecurity +

Returns :

-TRUE if the algorithm was added to the list, FALSE if it was -already in the listthe "key-mgmt" property of the setting

-

nm_setting_wireless_security_add_pairwise ()

-
gboolean            nm_setting_wireless_security_add_pairwise
+

nm_setting_wireless_security_get_num_protos ()

+
guint32             nm_setting_wireless_security_get_num_protos
+                                                        (NMSettingWirelessSecurity *setting);
+
++++ + + + + + + + + + + +

setting :

the NMSettingWirelessSecurity +

Returns :

the number of security protocols this connection allows when +connecting to secure WiFi networks
+
+
+
+

nm_setting_wireless_security_get_proto ()

+
const char *        nm_setting_wireless_security_get_proto
                                                         (NMSettingWirelessSecurity *setting,
-                                                         const char *pairwise);
-

-Adds an encryption algorithm to the list of allowed pairwise encryption -algorithms. If the list is not empty, then only access points that support -one or more of the encryption algorithms in the list will be considered -compatible with this connection. -

-
+ guint32 i); +
+++ @@ -545,15 +599,13 @@ compatible with this connection. - - + + - +

setting :

pairwise :

the encryption algorithm to add, one of "wep40", "wep104", -"tkip", or "ccmp"

i :

an index into the protocol list

Returns :

-TRUE if the algorithm was added to the list, FALSE if it was -already in the listthe protocol at index i +
@@ -572,8 +624,11 @@ protocol list contains only "wpa" but the access point for the SSID specified by this connection only supports WPA2/RSN, the connection cannot be used with the access point.

-
+
+++ @@ -595,38 +650,29 @@ protocol list, or -

nm_setting_wireless_security_clear_groups ()

-
void                nm_setting_wireless_security_clear_groups
-                                                        (NMSettingWirelessSecurity *setting);
-

-Removes all algorithms from the allowed list. If there are no algorithms -specified then all groupwise encryption algorithms are allowed. -

-

setting :

-- - - - -

setting :

the NMSettingWirelessSecurity -
-
-
-
-

nm_setting_wireless_security_clear_pairwise ()

-
void                nm_setting_wireless_security_clear_pairwise
-                                                        (NMSettingWirelessSecurity *setting);
+

nm_setting_wireless_security_remove_proto ()

+
void                nm_setting_wireless_security_remove_proto
+                                                        (NMSettingWirelessSecurity *setting,
+                                                         guint32 i);

-Removes all algorithms from the allowed list. If there are no algorithms -specified then all pairwise encryption algorithms are allowed. +Removes a protocol from the allowed protocol list.

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

setting :

the NMSettingWirelessSecurity

i :

index of the protocol to remove

@@ -638,8 +684,11 @@ specified then all pairwise encryption algorithms are allowed. Removes all protocols from the allowed list. If there are no protocols specified then all protocols are allowed.

-
+
+++

setting :

the NMSettingWirelessSecurity @@ -649,27 +698,14 @@ specified then all protocols are allowed.
-

nm_setting_wireless_security_error_quark ()

-
GQuark              nm_setting_wireless_security_error_quark
-                                                        (void);
-

-Registers an error quark for NMSettingWired if necessary. -

-
-- - - - -

Returns :

the error quark used for NMSettingWired errors.
-
-
-
-

nm_setting_wireless_security_get_auth_alg ()

-
const char *        nm_setting_wireless_security_get_auth_alg
+

nm_setting_wireless_security_get_num_pairwise ()

+
guint32             nm_setting_wireless_security_get_num_pairwise
                                                         (NMSettingWirelessSecurity *setting);
-
+
+++ @@ -678,23 +714,26 @@ Registers an error quark for Returns :

-
+

setting :

the "auth-alg" property of the settingthe number of pairwise encryption algorithms in the allowed list

-

nm_setting_wireless_security_get_group ()

-
const char *        nm_setting_wireless_security_get_group
+

nm_setting_wireless_security_get_pairwise ()

+
const char *        nm_setting_wireless_security_get_pairwise
                                                         (NMSettingWirelessSecurity *setting,
                                                          guint32 i);

-Returns the allowed groupwise encryption algorithm from allowed algorithm +Returns the allowed pairwise encryption algorithm from allowed algorithm list.

-
+
+++ @@ -703,11 +742,11 @@ list. - + - @@ -715,11 +754,21 @@ list.
-

nm_setting_wireless_security_get_key_mgmt ()

-
const char *        nm_setting_wireless_security_get_key_mgmt
-                                                        (NMSettingWirelessSecurity *setting);
-

setting :

i :

index of an item in the allowed groupwise encryption algorithm listindex of an item in the allowed pairwise encryption algorithm list

Returns :

the groupwise encryption algorithm at index i +the pairwise encryption algorithm at index i
+

nm_setting_wireless_security_add_pairwise ()

+
gboolean            nm_setting_wireless_security_add_pairwise
+                                                        (NMSettingWirelessSecurity *setting,
+                                                         const char *pairwise);
+

+Adds an encryption algorithm to the list of allowed pairwise encryption +algorithms. If the list is not empty, then only access points that support +one or more of the encryption algorithms in the list will be considered +compatible with this connection. +

+
+++ @@ -727,39 +776,34 @@ list. - - - - -

setting :

Returns :

the "key-mgmt" property of the setting
-
-
-
-

nm_setting_wireless_security_get_leap_password ()

-
const char *        nm_setting_wireless_security_get_leap_password
-                                                        (NMSettingWirelessSecurity *setting);
-
-- - - - + + - +

setting :

the NMSettingWirelessSecurity -

pairwise :

the encryption algorithm to add, one of "wep40", "wep104", +"tkip", or "ccmp"

Returns :

the "leap-password" property of the setting +TRUE if the algorithm was added to the list, FALSE if it was +already in the list

-

nm_setting_wireless_security_get_leap_password_flags ()

-
NMSettingSecretFlags nm_setting_wireless_security_get_leap_password_flags
-                                                        (NMSettingWirelessSecurity *setting);
-
+

nm_setting_wireless_security_remove_pairwise ()

+
void                nm_setting_wireless_security_remove_pairwise
+                                                        (NMSettingWirelessSecurity *setting,
+                                                         guint32 i);
+

+Removes an encryption algorithm from the allowed pairwise encryption +algorithm list. +

+
+++ @@ -767,32 +811,31 @@ list. - - + +

setting :

Returns :

the NMSettingSecretFlags pertaining to the -"leap-password" -

i :

the index of an item in the allowed pairwise encryption algorithm list

-

nm_setting_wireless_security_get_leap_username ()

-
const char *        nm_setting_wireless_security_get_leap_username
+

nm_setting_wireless_security_clear_pairwise ()

+
void                nm_setting_wireless_security_clear_pairwise
                                                         (NMSettingWirelessSecurity *setting);
-
+

+Removes all algorithms from the allowed list. If there are no algorithms +specified then all pairwise encryption algorithms are allowed. +

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

setting :

the NMSettingWirelessSecurity

Returns :

the "leap-username" property of the setting

@@ -800,8 +843,11 @@ list.

nm_setting_wireless_security_get_num_groups ()

guint32             nm_setting_wireless_security_get_num_groups
                                                         (NMSettingWirelessSecurity *setting);
-
+
+++ @@ -817,11 +863,19 @@ list.
-

nm_setting_wireless_security_get_num_pairwise ()

-
guint32             nm_setting_wireless_security_get_num_pairwise
-                                                        (NMSettingWirelessSecurity *setting);
-

setting :

+

nm_setting_wireless_security_get_group ()

+
const char *        nm_setting_wireless_security_get_group
+                                                        (NMSettingWirelessSecurity *setting,
+                                                         guint32 i);
+

+Returns the allowed groupwise encryption algorithm from allowed algorithm +list. +

+
+++ @@ -829,19 +883,34 @@ list. + + + + - +

setting :

i :

index of an item in the allowed groupwise encryption algorithm list

Returns :

the number of pairwise encryption algorithms in the allowed listthe groupwise encryption algorithm at index i +

-

nm_setting_wireless_security_get_num_protos ()

-
guint32             nm_setting_wireless_security_get_num_protos
-                                                        (NMSettingWirelessSecurity *setting);
-
+

nm_setting_wireless_security_add_group ()

+
gboolean            nm_setting_wireless_security_add_group
+                                                        (NMSettingWirelessSecurity *setting,
+                                                         const char *group);
+

+Adds an encryption algorithm to the list of allowed groupwise encryption +algorithms. If the list is not empty, then only access points that support +one or more of the encryption algorithms in the list will be considered +compatible with this connection. +

+
+++ @@ -849,25 +918,34 @@ list. + + + + - +

setting :

group :

the encryption algorithm to add, one of "wep40", "wep104", +"tkip", or "ccmp"

Returns :

the number of security protocols this connection allows when -connecting to secure WiFi networks +TRUE if the algorithm was added to the list, FALSE if it was +already in the list

-

nm_setting_wireless_security_get_pairwise ()

-
const char *        nm_setting_wireless_security_get_pairwise
+

nm_setting_wireless_security_remove_group ()

+
void                nm_setting_wireless_security_remove_group
                                                         (NMSettingWirelessSecurity *setting,
                                                          guint32 i);

-Returns the allowed pairwise encryption algorithm from allowed algorithm -list. +Removes an encryption algorithm from the allowed groupwise encryption +algorithm list.

-
+
+++ @@ -876,40 +954,30 @@ list. - - - - - +

setting :

i :

index of an item in the allowed pairwise encryption algorithm list

Returns :

the pairwise encryption algorithm at index i -the index of an item in the allowed groupwise encryption algorithm list

-

nm_setting_wireless_security_get_proto ()

-
const char *        nm_setting_wireless_security_get_proto
-                                                        (NMSettingWirelessSecurity *setting,
-                                                         guint32 i);
-
+

nm_setting_wireless_security_clear_groups ()

+
void                nm_setting_wireless_security_clear_groups
+                                                        (NMSettingWirelessSecurity *setting);
+

+Removes all algorithms from the allowed list. If there are no algorithms +specified then all groupwise encryption algorithms are allowed. +

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

setting :

the NMSettingWirelessSecurity

i :

an index into the protocol list

Returns :

the protocol at index i -

@@ -917,8 +985,11 @@ list.

nm_setting_wireless_security_get_psk ()

const char *        nm_setting_wireless_security_get_psk
                                                         (NMSettingWirelessSecurity *setting);
-
+
+++ @@ -937,8 +1008,11 @@ list.

nm_setting_wireless_security_get_psk_flags ()

NMSettingSecretFlags nm_setting_wireless_security_get_psk_flags
                                                         (NMSettingWirelessSecurity *setting);
-

setting :

+
+++ @@ -956,12 +1030,14 @@ list.
-

nm_setting_wireless_security_get_wep_key ()

-
const char *        nm_setting_wireless_security_get_wep_key
-                                                        (NMSettingWirelessSecurity *setting,
-                                                         guint32 idx);
-

setting :

+

nm_setting_wireless_security_get_leap_username ()

+
const char *        nm_setting_wireless_security_get_leap_username
+                                                        (NMSettingWirelessSecurity *setting);
+
+++ @@ -969,23 +1045,22 @@ list. - - - - - +

setting :

idx :

the WEP key index (0..3 inclusive)

Returns :

the WEP key at the given indexthe "leap-username" property of the setting

-

nm_setting_wireless_security_get_wep_key_flags ()

-
NMSettingSecretFlags nm_setting_wireless_security_get_wep_key_flags
+

nm_setting_wireless_security_get_leap_password ()

+
const char *        nm_setting_wireless_security_get_leap_password
                                                         (NMSettingWirelessSecurity *setting);
-
+
+++ @@ -994,18 +1069,21 @@ list. - +

setting :

Returns :

the NMSettingSecretFlags pertaining to the all WEP keysthe "leap-password" property of the setting

-

nm_setting_wireless_security_get_wep_key_type ()

-
NMWepKeyType        nm_setting_wireless_security_get_wep_key_type
+

nm_setting_wireless_security_get_leap_password_flags ()

+
NMSettingSecretFlags nm_setting_wireless_security_get_leap_password_flags
                                                         (NMSettingWirelessSecurity *setting);
-
+
+++ @@ -1014,18 +1092,24 @@ list. - +

setting :

Returns :

the "wep-key-type" property of the settingthe NMSettingSecretFlags pertaining to the +"leap-password" +

-

nm_setting_wireless_security_get_wep_tx_keyidx ()

-
guint32             nm_setting_wireless_security_get_wep_tx_keyidx
-                                                        (NMSettingWirelessSecurity *setting);
-
+

nm_setting_wireless_security_get_wep_key ()

+
const char *        nm_setting_wireless_security_get_wep_key
+                                                        (NMSettingWirelessSecurity *setting,
+                                                         guint32 idx);
+
+++ @@ -1033,40 +1117,60 @@ list. + + + + - +

setting :

idx :

the WEP key index (0..3 inclusive)

Returns :

the "wep-tx-keyidx" property of the settingthe WEP key at the given index

-

nm_setting_wireless_security_new ()

-
NMSetting *         nm_setting_wireless_security_new    (void);
+

nm_setting_wireless_security_set_wep_key ()

+
void                nm_setting_wireless_security_set_wep_key
+                                                        (NMSettingWirelessSecurity *setting,
+                                                         guint32 idx,
+                                                         const char *key);

-Creates a new NMSettingWirelessSecurity object with default values. +Sets a WEP key in the given index.

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

Returns :

the new empty NMSettingWirelessSecurity object. [transfer full] +

setting :

the NMSettingWirelessSecurity

idx :

the index of the key (0..3 inclusive)

key :

the WEP key as a string, in either hexadecimal, ASCII, or passphrase +form as determiend by the value of the "wep-key-type" +property.

-

nm_setting_wireless_security_remove_group ()

-
void                nm_setting_wireless_security_remove_group
-                                                        (NMSettingWirelessSecurity *setting,
-                                                         guint32 i);
-

-Removes an encryption algorithm from the allowed groupwise encryption -algorithm list. -

-
+

nm_setting_wireless_security_get_wep_tx_keyidx ()

+
guint32             nm_setting_wireless_security_get_wep_tx_keyidx
+                                                        (NMSettingWirelessSecurity *setting);
+
+++ @@ -1074,24 +1178,22 @@ algorithm list. - - + +

setting :

i :

the index of an item in the allowed groupwise encryption algorithm list

Returns :

the "wep-tx-keyidx" property of the setting

-

nm_setting_wireless_security_remove_pairwise ()

-
void                nm_setting_wireless_security_remove_pairwise
-                                                        (NMSettingWirelessSecurity *setting,
-                                                         guint32 i);
-

-Removes an encryption algorithm from the allowed pairwise encryption -algorithm list. -

-
+

nm_setting_wireless_security_get_auth_alg ()

+
const char *        nm_setting_wireless_security_get_auth_alg
+                                                        (NMSettingWirelessSecurity *setting);
+
+++ @@ -1099,23 +1201,22 @@ algorithm list. - - + +

setting :

i :

the index of an item in the allowed pairwise encryption algorithm list

Returns :

the "auth-alg" property of the setting

-

nm_setting_wireless_security_remove_proto ()

-
void                nm_setting_wireless_security_remove_proto
-                                                        (NMSettingWirelessSecurity *setting,
-                                                         guint32 i);
-

-Removes a protocol from the allowed protocol list. -

-
+

nm_setting_wireless_security_get_wep_key_flags ()

+
NMSettingSecretFlags nm_setting_wireless_security_get_wep_key_flags
+                                                        (NMSettingWirelessSecurity *setting);
+
+++ @@ -1123,24 +1224,22 @@ Removes a protocol from the allowed protocol list. - - + +

setting :

i :

index of the protocol to remove

Returns :

the NMSettingSecretFlags pertaining to the all WEP keys

-

nm_setting_wireless_security_set_wep_key ()

-
void                nm_setting_wireless_security_set_wep_key
-                                                        (NMSettingWirelessSecurity *setting,
-                                                         guint32 idx,
-                                                         const char *key);
-

-Sets a WEP key in the given index. -

-
+

nm_setting_wireless_security_get_wep_key_type ()

+
NMWepKeyType        nm_setting_wireless_security_get_wep_key_type
+                                                        (NMSettingWirelessSecurity *setting);
+
+++ @@ -1148,14 +1247,8 @@ Sets a WEP key in the given index. - - - - - - + +

setting :

idx :

the index of the key (0..3 inclusive)

key :

the WEP key as a string, in either hexadecimal, ASCII, or passphrase -form as determiend by the value of the "wep-key-type" -property.

Returns :

the "wep-key-type" property of the setting
@@ -1180,9 +1273,10 @@ the 'leap-username' and 'leap-password' properties must be specified.

The "group" property

  "group"                    GSList_gchararray_*   : Read / Write

-If specified, will only connect to WPA networks that provide the -specified group/multicast encryption capabilities. Each element may be -one of 'wep40', 'wep104', 'tkip', or 'ccmp'. +A list of group/broadcast encryption algorithms which prevents +connections to Wi-Fi networks that do not utilize one of the algorithms +in the list. For maximum compatibility leave this property empty. Each +list element may be one of 'wep40', 'wep104', 'tkip', or 'ccmp'.


@@ -1232,9 +1326,10 @@ The login username for legacy LEAP connections (ie, key-mgmt =

The "pairwise" property

  "pairwise"                 GSList_gchararray_*   : Read / Write

-If specified, will only connect to WPA networks that provide the -specified pairwise encryption capabilities. Each element may be one of -'wep40', 'wep104', 'tkip', or 'ccmp'. +A list of pairwise encryption algorithms which prevents connections to +Wi-Fi networks that do not utilize one of the algorithms in the list. For +maximum compatibility leave this property empty. Each list element may +be one of 'wep40', 'wep104', 'tkip', or 'ccmp'.


@@ -1353,6 +1448,6 @@ Linksys WRT54G) number the keys 1 - 4. + Generated by GTK-Doc V1.19 \ No newline at end of file diff --git a/docs/libnm-util/html/annotation-glossary.html b/docs/libnm-util/html/annotation-glossary.html index b9117001..ae9452da 100644 --- a/docs/libnm-util/html/annotation-glossary.html +++ b/docs/libnm-util/html/annotation-glossary.html @@ -3,11 +3,11 @@ Annotation Glossary - + - + @@ -20,58 +20,53 @@
 
-O +I  |  A  |  - I + T  |  - E + O +  |  + S  |  T  |  - S + E  |  T
-

-Annotation Glossary

-

O

-
-out
-

Parameter for returning results. Default is transfer full.

-

A

-
-allow-none
-

NULL is ok, both for passing and for returning.

+

+Annotation Glossary

I

-
-inout
-

Parameter for input and for returning results. Default is transfer full.

-

E

-
-element-type
-

Generics and defining elements of containers and arrays.

+
inout
+

Parameter for input and for returning results. Default is transfer full.

+

A

+
allow-none
+

NULL is ok, both for passing and for returning.

T

-
-transfer container
-

Free data container after the code is done.

+
transfer container
+

Free data container after the code is done.

+

O

+
out
+

Parameter for returning results. Default is transfer full.

S

-
-scope call
-

The callback is valid only during the call to the method.

+
scope call
+

The callback is valid only during the call to the method.

+

T

+
transfer none
+

Don't free data after the code is done.

+

E

+
element-type
+

Generics and defining elements of containers and arrays.

T

-
-transfer full
-

Free data after the code is done.

-
-transfer none
-

Don't free data after the code is done.

+
transfer full
+

Free data after the code is done.

+ Generated by GTK-Doc V1.19
\ No newline at end of file diff --git a/docs/libnm-util/html/api-index-full.html b/docs/libnm-util/html/api-index-full.html index b3f8aa63..9d53c16b 100644 --- a/docs/libnm-util/html/api-index-full.html +++ b/docs/libnm-util/html/api-index-full.html @@ -3,12 +3,12 @@ API Index - + - + @@ -35,8 +35,8 @@
-

-API Index

+

+API Index

C

NMConnection, struct in NMConnection @@ -589,6 +589,14 @@
+NMSetting8021x:pin, object property in NMSetting8021x +
+
+
+NMSetting8021x:pin-flags, object property in NMSetting8021x +
+
+
NMSetting8021x:private-key, object property in NMSetting8021x
@@ -4242,6 +4250,6 @@ NM_SETTING_SECRET_FLAGS_ALL, macro in nm-setting-private
+ Generated by GTK-Doc V1.19
\ No newline at end of file diff --git a/docs/libnm-util/html/ch01.html b/docs/libnm-util/html/ch01.html index 5223862e..5b79f668 100644 --- a/docs/libnm-util/html/ch01.html +++ b/docs/libnm-util/html/ch01.html @@ -3,12 +3,12 @@ libnm-util API Reference - + - + @@ -20,9 +20,9 @@ Next
-

-libnm-util API Reference

-
+

+libnm-util API Reference

+
NMConnection — Describes a connection to specific network or provider
@@ -105,6 +105,6 @@ that require PPP to deliver IP capability
+ Generated by GTK-Doc V1.19
\ No newline at end of file diff --git a/docs/libnm-util/html/index.html b/docs/libnm-util/html/index.html index 667c695c..a7e470a3 100644 --- a/docs/libnm-util/html/index.html +++ b/docs/libnm-util/html/index.html @@ -3,10 +3,10 @@ libnm-util Reference Manual - + - + @@ -15,14 +15,14 @@

- for libnm-util 0.9.8.0 + for libnm-util 0.9.8.8 The latest version of this documentation can be found on-line at http://projects.gnome.org/NetworkManager/developers/libnm-util/09/.

-

+

Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.1 or any later @@ -46,7 +46,7 @@


-
+
libnm-util API Reference
@@ -135,6 +135,6 @@ that require PPP to deliver IP capability
+ Generated by GTK-Doc V1.19
\ No newline at end of file diff --git a/docs/libnm-util/html/index.sgml b/docs/libnm-util/html/index.sgml index 604f2d9b..203b6e1b 100644 --- a/docs/libnm-util/html/index.sgml +++ b/docs/libnm-util/html/index.sgml @@ -7,35 +7,48 @@ - - + + + + + + + - - + + + + - - - - + + + + + + + + + + + + + + - - - - @@ -46,26 +59,13 @@ - + - - - - - - - - - - - - - - + @@ -73,67 +73,67 @@ - - - + + + - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + - - - - - - - - + + + + + + + + + + + + + - - - - - - - - - + + + - + + + @@ -143,47 +143,47 @@ - - + - + - - - - - - - - + + + + + - - - - - + + + + + + - + + + + + - - - - - - - - + + + + + + + @@ -204,41 +204,41 @@ - - + - - - + + + + + + - + - - - - - - - + + + + + + + - - + + - - - + @@ -259,52 +259,52 @@ - - + + + + + - - - - + + + + - + + + + - - - - - - - - - - + + + + + - - - + + + + - - - + + + - - - + @@ -328,8 +328,7 @@ - - + @@ -338,59 +337,60 @@ + + + + - + + - - - - - - - - - - - + + + + + + + + + + - - + - - - - - - - - - - + + + + + + + + + + + + + + - - - - - - @@ -416,23 +416,23 @@ - - + - - + + - + + + - @@ -443,27 +443,27 @@ - - + + + - - - - + + + + - - + @@ -477,25 +477,25 @@ - - + + + - - - + + + + - - @@ -504,19 +504,39 @@ - + - - + + + + + + + + + + + + + + + + + + + + + + @@ -533,40 +553,20 @@ - - - - - - - - - - - - - - - - - - - - - - - + + + + + + - - - - + + - - + @@ -586,20 +586,20 @@ - - + - - - - - + + + + + + @@ -610,8 +610,7 @@ - - + @@ -619,25 +618,26 @@ + - - - - + + - - - + + + + + - - - + + + @@ -648,30 +648,30 @@ - - + - + + + + - - - - - - + + + + + + + - - - - + @@ -687,22 +687,22 @@ - - + - - - - - - - + + + + + + + + @@ -714,22 +714,22 @@ - - + + - - + + + - @@ -737,46 +737,46 @@ - + - - + + + + + + + + + + + + + + - - - - - - - - - - - - - - - - - + - + + + - + + + @@ -791,22 +791,22 @@ - - + - - - - + + + + + + + - - @@ -818,35 +818,35 @@ - - + - - - + + - + + + - - - - - - + + + + + + + - - - + - + + @@ -864,7 +864,6 @@ - @@ -874,111 +873,112 @@ - + - + + + + + + + - - - - - - - - - - - + + + + + + + + + + + - - - - - - - + + + + + - - + - - - + + + + + + - - + + + + + + + + - - - - - - - - - - - - - + - + + + - - + + + + + + + + - - - - - - - - + + + + + + - + + - - - - - - - - - - - - + + + + - + + + @@ -1005,6 +1005,8 @@ + + @@ -1012,95 +1014,95 @@ + - - - - - + + + + + + + + + - - - - - - + + - - - - - - - - - - + + + + + + - + - - - - - - - + + + + + + + - - + - - + + + + + + + + + + - - - + - - - - - - - - + - - - - - + + + - - + + + + - - - - + + + + + + + + + @@ -1116,100 +1118,100 @@ - - + + - - - - + - - - - - - - + + + - - + + - + + - + + + - - - - - - - - - + + + + + + + + + + - + - - - - - - - + + + + + + + - - + - - + + + + + + + + + + - - - + - - - - - - + - - - - - - + + + - - + + + + - - - - + + + + + + + + @@ -1229,53 +1231,53 @@ - - + - - - - - - - + - - - - + + - + + + - - - - - - - - - - + + + + + + + + + + - - - + + - + + + - + + + + + + + @@ -1302,25 +1304,25 @@ - - + - - + - - - - + + + + + - + + @@ -1333,33 +1335,33 @@ - - + - - - + - + + + + + + + + + - - - - - + + + - - - - + @@ -1371,6 +1373,14 @@ + + + + + + + + @@ -1381,52 +1391,44 @@ - + - - - - - - - - - - - + + - - - + + + - - - - - - - - - + + - + + + - - - - + + + + + + + + - + + - + + diff --git a/docs/libnm-util/html/libnm-util-nm-utils.html b/docs/libnm-util/html/libnm-util-nm-utils.html index b7ff71ec..91e04c2d 100644 --- a/docs/libnm-util/html/libnm-util-nm-utils.html +++ b/docs/libnm-util/html/libnm-util-nm-utils.html @@ -3,12 +3,12 @@ nm-utils - + - + @@ -42,77 +42,77 @@
 #include <nm-utils.h>
 
-enum                NMUtilsSecurityType;
-#define             NM_UTILS_HWADDR_LEN_MAX
-gboolean            nm_utils_ap_mode_security_valid     (NMUtilsSecurityType type,
-                                                         NMDeviceWifiCapabilities wifi_caps);
+gboolean            nm_utils_init                       (GError **error);
 void                nm_utils_deinit                     (void);
+gboolean            nm_utils_is_empty_ssid              (const guint8 *ssid,
+                                                         int len);
 const char *        nm_utils_escape_ssid                (const guint8 *ssid,
                                                          guint32 len);
-gboolean            nm_utils_file_is_pkcs12             (const char *filename);
+gboolean            nm_utils_same_ssid                  (const GByteArray *ssid1,
+                                                         const GByteArray *ssid2,
+                                                         gboolean ignore_trailing_null);
+char *              nm_utils_ssid_to_utf8               (const GByteArray *ssid);
 GHashTable *        nm_utils_gvalue_hash_dup            (GHashTable *hash);
-GByteArray *        nm_utils_hwaddr_atoba               (const char *asc,
-                                                         int type);
-guint8 *            nm_utils_hwaddr_aton                (const char *asc,
-                                                         int type,
-                                                         gpointer buffer);
-int                 nm_utils_hwaddr_len                 (int type);
-char *              nm_utils_hwaddr_ntoa                (gconstpointer addr,
-                                                         int type);
-int                 nm_utils_hwaddr_type                (int len);
-gboolean            nm_utils_iface_valid_name           (const char *name);
-gboolean            nm_utils_init                       (GError **error);
+void                nm_utils_slist_free                 (GSList *list,
+                                                         GDestroyNotify elem_destroy_fn);
+enum                NMUtilsSecurityType;
+gboolean            nm_utils_security_valid             (NMUtilsSecurityType type,
+                                                         NMDeviceWifiCapabilities wifi_caps,
+                                                         gboolean have_ap,
+                                                         gboolean adhoc,
+                                                         NM80211ApFlags ap_flags,
+                                                         NM80211ApSecurityFlags ap_wpa,
+                                                         NM80211ApSecurityFlags ap_rsn);
+gboolean            nm_utils_ap_mode_security_valid     (NMUtilsSecurityType type,
+                                                         NMDeviceWifiCapabilities wifi_caps);
+gboolean            nm_utils_wep_key_valid              (const char *key,
+                                                         NMWepKeyType wep_type);
+gboolean            nm_utils_wpa_psk_valid              (const char *psk);
 GSList *            nm_utils_ip4_addresses_from_gvalue  (const GValue *value);
 void                nm_utils_ip4_addresses_to_gvalue    (GSList *list,
                                                          GValue *value);
-guint32             nm_utils_ip4_get_default_prefix     (guint32 ip);
-guint32             nm_utils_ip4_netmask_to_prefix      (guint32 netmask);
-guint32             nm_utils_ip4_prefix_to_netmask      (guint32 prefix);
 GSList *            nm_utils_ip4_routes_from_gvalue     (const GValue *value);
 void                nm_utils_ip4_routes_to_gvalue       (GSList *list,
                                                          GValue *value);
+guint32             nm_utils_ip4_netmask_to_prefix      (guint32 netmask);
+guint32             nm_utils_ip4_prefix_to_netmask      (guint32 prefix);
+guint32             nm_utils_ip4_get_default_prefix     (guint32 ip);
 GSList *            nm_utils_ip6_addresses_from_gvalue  (const GValue *value);
 void                nm_utils_ip6_addresses_to_gvalue    (GSList *list,
                                                          GValue *value);
-GSList *            nm_utils_ip6_dns_from_gvalue        (const GValue *value);
-void                nm_utils_ip6_dns_to_gvalue          (GSList *list,
-                                                         GValue *value);
 GSList *            nm_utils_ip6_routes_from_gvalue     (const GValue *value);
 void                nm_utils_ip6_routes_to_gvalue       (GSList *list,
                                                          GValue *value);
-gboolean            nm_utils_is_empty_ssid              (const guint8 *ssid,
-                                                         int len);
-gboolean            nm_utils_is_uuid                    (const char *str);
+GSList *            nm_utils_ip6_dns_from_gvalue        (const GValue *value);
+void                nm_utils_ip6_dns_to_gvalue          (GSList *list,
+                                                         GValue *value);
+char *              nm_utils_uuid_generate              (void);
+char *              nm_utils_uuid_generate_from_string  (const char *s);
 GByteArray *        nm_utils_rsa_key_encrypt            (const GByteArray *data,
                                                          const char *in_password,
                                                          char **out_password,
                                                          GError **error);
-gboolean            nm_utils_same_ssid                  (const GByteArray *ssid1,
-                                                         const GByteArray *ssid2,
-                                                         gboolean ignore_trailing_null);
-gboolean            nm_utils_security_valid             (NMUtilsSecurityType type,
-                                                         NMDeviceWifiCapabilities wifi_caps,
-                                                         gboolean have_ap,
-                                                         gboolean adhoc,
-                                                         NM80211ApFlags ap_flags,
-                                                         NM80211ApSecurityFlags ap_wpa,
-                                                         NM80211ApSecurityFlags ap_rsn);
-void                nm_utils_slist_free                 (GSList *list,
-                                                         GDestroyNotify elem_destroy_fn);
-char *              nm_utils_ssid_to_utf8               (const GByteArray *ssid);
-char *              nm_utils_uuid_generate              (void);
-char *              nm_utils_uuid_generate_from_string  (const char *s);
-gboolean            nm_utils_wep_key_valid              (const char *key,
-                                                         NMWepKeyType wep_type);
+gboolean            nm_utils_file_is_pkcs12             (const char *filename);
+guint32             nm_utils_wifi_freq_to_channel       (guint32 freq);
 guint32             nm_utils_wifi_channel_to_freq       (guint32 channel,
                                                          const char *band);
 guint32             nm_utils_wifi_find_next_channel     (guint32 channel,
                                                          int direction,
                                                          char *band);
-guint32             nm_utils_wifi_freq_to_channel       (guint32 freq);
 gboolean            nm_utils_wifi_is_channel_valid      (guint32 channel,
                                                          const char *band);
-gboolean            nm_utils_wpa_psk_valid              (const char *psk);
+#define             NM_UTILS_HWADDR_LEN_MAX
+int                 nm_utils_hwaddr_len                 (int type);
+int                 nm_utils_hwaddr_type                (int len);
+char *              nm_utils_hwaddr_ntoa                (gconstpointer addr,
+                                                         int type);
+GByteArray *        nm_utils_hwaddr_atoba               (const char *asc,
+                                                         int type);
+guint8 *            nm_utils_hwaddr_aton                (const char *asc,
+                                                         int type,
+                                                         gpointer buffer);
+gboolean            nm_utils_iface_valid_name           (const char *name);
+gboolean            nm_utils_is_uuid                    (const char *str);
 
@@ -132,132 +132,74 @@ access points and devices, among other things.

Details

-

enum NMUtilsSecurityType

-
typedef enum {
-	NMU_SEC_INVALID = 0,
-	NMU_SEC_NONE,
-	NMU_SEC_STATIC_WEP,
-	NMU_SEC_LEAP,
-	NMU_SEC_DYNAMIC_WEP,
-	NMU_SEC_WPA_PSK,
-	NMU_SEC_WPA_ENTERPRISE,
-	NMU_SEC_WPA2_PSK,
-	NMU_SEC_WPA2_ENTERPRISE
-} NMUtilsSecurityType;
-
+

nm_utils_init ()

+
gboolean            nm_utils_init                       (GError **error);

-Describes generic security mechanisms that 802.11 access points may offer. -Used with nm_utils_security_valid() for checking whether a given access -point is compatible with a network device. +Initializes libnm-util; should be called when starting and program that +uses libnm-util. Sets up an atexit() handler to ensure de-initialization +is performed, but calling nm_utils_deinit() to explicitly deinitialize +libnm-util can also be done. This function can be called more than once.

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

NMU_SEC_INVALID

unknown or invalid security, placeholder and not used -

NMU_SEC_NONE

unencrypted and open -

NMU_SEC_STATIC_WEP

static WEP keys are used for encryption -

NMU_SEC_LEAP

Cisco LEAP is used for authentication and for generating the -dynamic WEP keys automatically -

NMU_SEC_DYNAMIC_WEP

standard 802.1x is used for authentication and -generating the dynamic WEP keys automatically -

NMU_SEC_WPA_PSK

WPA1 is used with Pre-Shared Keys (PSK) -

NMU_SEC_WPA_ENTERPRISE

WPA1 is used with 802.1x authentication -

NMU_SEC_WPA2_PSK

WPA2/RSN is used with Pre-Shared Keys (PSK) +

error :

location to store error, or NULL

NMU_SEC_WPA2_ENTERPRISE

WPA2 is used with 802.1x authentication -

Returns :

TRUE if the initialization was successful, FALSE on failure.

-

NM_UTILS_HWADDR_LEN_MAX

-
#define NM_UTILS_HWADDR_LEN_MAX 20 /* INFINIBAND_ALEN */
-
+

nm_utils_deinit ()

+
void                nm_utils_deinit                     (void);

-The maximum length of a hardware address of a type known by -nm_utils_hwaddr_len() or nm_utils_hwaddr_aton(). This can be used -as the size of the buffer passed to nm_utils_hwaddr_aton(). +Frees all resources used internally by libnm-util. This function is called +from an atexit() handler, set up by nm_utils_init(), but is safe to be called +more than once. Subsequent calls have no effect until nm_utils_init() is +called again.


-

nm_utils_ap_mode_security_valid ()

-
gboolean            nm_utils_ap_mode_security_valid     (NMUtilsSecurityType type,
-                                                         NMDeviceWifiCapabilities wifi_caps);
+

nm_utils_is_empty_ssid ()

+
gboolean            nm_utils_is_empty_ssid              (const guint8 *ssid,
+                                                         int len);

-Given a set of device capabilities, and a desired security type to check -against, determines whether the combination of device capabilities and -desired security type are valid for AP/Hotspot connections. +Different manufacturers use different mechanisms for not broadcasting the +AP's SSID. This function attempts to detect blank/empty SSIDs using a +number of known SSID-cloaking methods.

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

type :

the security type to check device capabilties against, -e.g. NMU_SEC_STATIC_WEP -

ssid :

pointer to a buffer containing the SSID data

wifi_caps :

bitfield of the capabilities of the specific WiFi device, e.g. -NM_WIFI_DEVICE_CAP_CIPHER_WEP40 +

len :

length of the SSID data in ssid

Returns :

TRUE if the device capabilities are compatible with the desired -type, FALSE if they are not.TRUE if the SSID is "empty", FALSE if it is not
-

Since 0.9.8

-
-
-
-

nm_utils_deinit ()

-
void                nm_utils_deinit                     (void);
-

-Frees all resources used internally by libnm-util. This function is called -from an atexit() handler, set up by nm_utils_init(), but is safe to be called -more than once. Subsequent calls have no effect until nm_utils_init() is -called again. -


@@ -270,8 +212,11 @@ replacing embedded NULLs and non-printable characters with the hexadecimal representation of that character. Intended for debugging only, should not be used for display of SSIDs.

-
+
+++ @@ -292,73 +237,89 @@ and will be overwritten by subsequent calls to this function
-

nm_utils_file_is_pkcs12 ()

-
gboolean            nm_utils_file_is_pkcs12             (const char *filename);
+

nm_utils_same_ssid ()

+
gboolean            nm_utils_same_ssid                  (const GByteArray *ssid1,
+                                                         const GByteArray *ssid2,
+                                                         gboolean ignore_trailing_null);

-Utility function to find out if the filename is in PKCS12 format. +Earlier versions of the Linux kernel added a NULL byte to the end of the +SSID to enable easy printing of the SSID on the console or in a terminal, +but this behavior was problematic (SSIDs are simply byte arrays, not strings) +and thus was changed. This function compensates for that behavior at the +cost of some compatibility with odd SSIDs that may legitimately have trailing +NULLs, even though that is functionally pointless.

-

ssid :

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

filename :

name of the file to test

ssid1 :

first SSID data to compare

Returns :

TRUE if the file is PKCS12, FALSE if it is not

ssid2 :

second SSID data to compare
-
-
-
-

nm_utils_gvalue_hash_dup ()

-
GHashTable *        nm_utils_gvalue_hash_dup            (GHashTable *hash);
-

-Utility function to duplicate a hash table of GValues. -

-
-- - - + + - +

hash :

a GHashTable mapping string:GValue

ignore_trailing_null :

TRUE to ignore one trailing NULL byte

Returns :

a newly allocated duplicated GHashTable, caller must free the -returned hash with g_hash_table_unref() or g_hash_table_destroy(). [transfer container][element-type utf8 GObject.Value] -TRUE if the SSIDs are the same, FALSE if they are not

-

nm_utils_hwaddr_atoba ()

-
GByteArray *        nm_utils_hwaddr_atoba               (const char *asc,
-                                                         int type);
+

nm_utils_ssid_to_utf8 ()

+
char *              nm_utils_ssid_to_utf8               (const GByteArray *ssid);

-Parses asc and converts it to binary form in a GByteArray. See -nm_utils_hwaddr_aton() if you don't want a GByteArray. -

-
-- - - - - +WiFi SSIDs are byte arrays, they are _not_ strings. Thus, an SSID may +contain embedded NULLs and other unprintable characters. Often it is +useful to print the SSID out for debugging purposes, but that should be the +_only_ use of this function. Do not use this function for any persistent +storage of the SSID, since the printable SSID returned from this function +cannot be converted back into the real SSID of the access point. +

+

+This function does almost everything humanly possible to convert the input +into a printable UTF-8 string, using roughly the following procedure: +

+

+1) if the input data is already UTF-8 safe, no conversion is performed +2) attempts to get the current system language from the LANG environment + variable, and depending on the language, uses a table of alternative + encodings to try. For example, if LANG=hu_HU, the table may first try + the ISO-8859-2 encoding, and if that fails, try the Windows-1250 encoding. + If all fallback encodings fail, replaces non-UTF-8 characters with '?'. +3) If the system language was unable to be determined, falls back to the + ISO-8859-1 encoding, then to the Windows-1251 encoding. +4) If step 3 fails, replaces non-UTF-8 characters with '?'. +

+

+Again, this function should be used for debugging and display purposes +_only_. +

+

asc :

the ASCII representation of a hardware address
++++ + - - + + - @@ -366,131 +327,264 @@ be parsed. [ -

nm_utils_hwaddr_aton ()

-
guint8 *            nm_utils_hwaddr_aton                (const char *asc,
-                                                         int type,
-                                                         gpointer buffer);
+

nm_utils_gvalue_hash_dup ()

+
GHashTable *        nm_utils_gvalue_hash_dup            (GHashTable *hash);

-Parses asc and converts it to binary form in buffer. See -nm_utils_hwaddr_atoba() if you'd rather have the result in a -GByteArray. +Utility function to duplicate a hash table of GValues.

-

type :

the type of address; either ARPHRD_ETHER or ARPHRD_INFINIBAND -

ssid :

a byte array containing the SSID data

Returns :

a new GByteArray, or NULL if asc couldn't -be parsed. [transfer full] +an allocated string containing a UTF-8 +representation of the SSID, which must be freed by the caller using g_free(). +Returns NULL on errors. [transfer full]
+
+++ - - + + - - + + +

asc :

the ASCII representation of a hardware address

hash :

a GHashTable mapping string:GValue

type :

the type of address; either ARPHRD_ETHER or ARPHRD_INFINIBAND +

Returns :

a newly allocated duplicated GHashTable, caller must free the +returned hash with g_hash_table_unref() or g_hash_table_destroy(). [transfer container][element-type utf8 GObject.Value]
+
+
+
+

nm_utils_slist_free ()

+
void                nm_utils_slist_free                 (GSList *list,
+                                                         GDestroyNotify elem_destroy_fn);
+

+Utility function to free a GSList. +

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

buffer :

buffer to store the result into

list :

a GSList +

Returns :

-buffer, or NULL if asc couldn't be parsed

elem_destroy_fn :

user function called for each element in list +

-

nm_utils_hwaddr_len ()

-
int                 nm_utils_hwaddr_len                 (int type);
+

enum NMUtilsSecurityType

+
typedef enum {
+	NMU_SEC_INVALID = 0,
+	NMU_SEC_NONE,
+	NMU_SEC_STATIC_WEP,
+	NMU_SEC_LEAP,
+	NMU_SEC_DYNAMIC_WEP,
+	NMU_SEC_WPA_PSK,
+	NMU_SEC_WPA_ENTERPRISE,
+	NMU_SEC_WPA2_PSK,
+	NMU_SEC_WPA2_ENTERPRISE
+} NMUtilsSecurityType;
+

-Returns the length in octets of a hardware address of type type. +Describes generic security mechanisms that 802.11 access points may offer. +Used with nm_utils_security_valid() for checking whether a given access +point is compatible with a network device.

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

type :

the type of address; either ARPHRD_ETHER or ARPHRD_INFINIBAND +

NMU_SEC_INVALID

unknown or invalid security, placeholder and not used

Returns :

the length

NMU_SEC_NONE

unencrypted and open +

NMU_SEC_STATIC_WEP

static WEP keys are used for encryption +

NMU_SEC_LEAP

Cisco LEAP is used for authentication and for generating the +dynamic WEP keys automatically +

NMU_SEC_DYNAMIC_WEP

standard 802.1x is used for authentication and +generating the dynamic WEP keys automatically +

NMU_SEC_WPA_PSK

WPA1 is used with Pre-Shared Keys (PSK) +

NMU_SEC_WPA_ENTERPRISE

WPA1 is used with 802.1x authentication +

NMU_SEC_WPA2_PSK

WPA2/RSN is used with Pre-Shared Keys (PSK) +

NMU_SEC_WPA2_ENTERPRISE

WPA2 is used with 802.1x authentication +

-

nm_utils_hwaddr_ntoa ()

-
char *              nm_utils_hwaddr_ntoa                (gconstpointer addr,
-                                                         int type);
+

nm_utils_security_valid ()

+
gboolean            nm_utils_security_valid             (NMUtilsSecurityType type,
+                                                         NMDeviceWifiCapabilities wifi_caps,
+                                                         gboolean have_ap,
+                                                         gboolean adhoc,
+                                                         NM80211ApFlags ap_flags,
+                                                         NM80211ApSecurityFlags ap_wpa,
+                                                         NM80211ApSecurityFlags ap_rsn);

-Converts addr to textual form. +Given a set of device capabilities, and a desired security type to check +against, determines whether the combination of device, desired security +type, and AP capabilities intersect. +

+

+NOTE: this function cannot handle checking security for AP/Hotspot mode; +use nm_utils_ap_mode_security_valid() instead.

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

addr :

a binary hardware address

type :

the security type to check AP flags and device capabilties against, +e.g. NMU_SEC_STATIC_WEP +

type :

the type of address; either ARPHRD_ETHER or ARPHRD_INFINIBAND +

wifi_caps :

bitfield of the capabilities of the specific WiFi device, e.g. +NM_WIFI_DEVICE_CAP_CIPHER_WEP40

Returns :

the textual form of addr. [transfer full] +

have_ap :

whether the ap_flags, ap_wpa, and ap_rsn arguments are valid

adhoc :

whether the capabilities being tested are from an Ad-Hoc AP (IBSS)

ap_flags :

bitfield of AP capabilities, e.g. NM_802_11_AP_FLAGS_PRIVACY

ap_wpa :

bitfield of AP capabilties derived from the AP's WPA beacon, +e.g. (NM_802_11_AP_SEC_PAIR_TKIP | NM_802_11_AP_SEC_KEY_MGMT_PSK)

ap_rsn :

bitfield of AP capabilties derived from the AP's RSN/WPA2 beacon, +e.g. (NM_802_11_AP_SEC_PAIR_CCMP | NM_802_11_AP_SEC_PAIR_TKIP)

Returns :

TRUE if the device capabilities and AP capabilties intersect and are +compatible with the desired type, FALSE if they are not

-

nm_utils_hwaddr_type ()

-
int                 nm_utils_hwaddr_type                (int len);
+

nm_utils_ap_mode_security_valid ()

+
gboolean            nm_utils_ap_mode_security_valid     (NMUtilsSecurityType type,
+                                                         NMDeviceWifiCapabilities wifi_caps);

-Returns the type (either ARPHRD_ETHER or ARPHRD_INFINIBAND) of the raw -address given its length. +Given a set of device capabilities, and a desired security type to check +against, determines whether the combination of device capabilities and +desired security type are valid for AP/Hotspot connections.

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

len :

the length of hardware address in bytes

type :

the security type to check device capabilties against, +e.g. NMU_SEC_STATIC_WEP +

wifi_caps :

bitfield of the capabilities of the specific WiFi device, e.g. +NM_WIFI_DEVICE_CAP_CIPHER_WEP40 +

Returns :

the type, either ARPHRD_ETHER or ARPHRD_INFINIBAND, or -1 if -the address length was not recognizedTRUE if the device capabilities are compatible with the desired +type, FALSE if they are not.
+

Since 0.9.8


-

nm_utils_iface_valid_name ()

-
gboolean            nm_utils_iface_valid_name           (const char *name);
+

nm_utils_wep_key_valid ()

+
gboolean            nm_utils_wep_key_valid              (const char *key,
+                                                         NMWepKeyType wep_type);

-This function is a 1:1 copy of the kernel's interface validation -function in net/core/dev.c. +Checks if key is a valid WEP key

-
+
+++ - - + + + + + + +TRUE if key is a WEP key, FALSE if not

name :

Name of interface

key :

a string that might be a WEP key

wep_type :

the NMWepKeyType type of the WEP key

Returns :

-TRUE if interface name is valid, otherwise FALSE is returned.
@@ -498,28 +592,29 @@ function in net/core/dev.c.

-

nm_utils_init ()

-
gboolean            nm_utils_init                       (GError **error);
+

nm_utils_wpa_psk_valid ()

+
gboolean            nm_utils_wpa_psk_valid              (const char *psk);

-Initializes libnm-util; should be called when starting and program that -uses libnm-util. Sets up an atexit() handler to ensure de-initialization -is performed, but calling nm_utils_deinit() to explicitly deinitialize -libnm-util can also be done. This function can be called more than once. +Checks if psk is a valid WPA PSK

-
+
+++ - - + + - +

error :

location to store error, or NULL -

psk :

a string that might be a WPA PSK

Returns :

TRUE if the initialization was successful, FALSE on failure. +TRUE if psk is a WPA PSK, FALSE if not
+

Since 0.9.8


@@ -532,8 +627,11 @@ and prefix) into a GSList of GArray may be extended in the future.

-
+
+++ @@ -555,83 +653,26 @@ extended in the future.

Utility function to convert a GSList of NMIP4Address objects into a GPtrArray of GArrays of guint32s representing a list of NetworkManager IPv4 -addresses (which is a tuple of address, gateway, and prefix). The specific -format of this serialization is not guaranteed to be stable and may be -extended in the future. -

-

value :

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

list :

a list of NMIP4Address objects. [element-type NMIP4Address] -

value :

a pointer to a GValue into which to place the converted addresses, -which should be unset by the caller (when no longer needed) with -g_value_unset().
-
-
-
-

nm_utils_ip4_get_default_prefix ()

-
guint32             nm_utils_ip4_get_default_prefix     (guint32 ip);
-

-When the Internet was originally set up, various ranges of IP addresses were -segmented into three network classes: A, B, and C. This function will return -a prefix that is associated with the IP address specified defining where it -falls in the predefined classes. -

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

ip :

an IPv4 address (in network byte order)

Returns :

the default class prefix for the given IP
-
-
-
-

nm_utils_ip4_netmask_to_prefix ()

-
guint32             nm_utils_ip4_netmask_to_prefix      (guint32 netmask);
-
-- - - - - - - - - - -

netmask :

an IPv4 netmask in network byte order

Returns :

the CIDR prefix represented by the netmask
-
-
-
-

nm_utils_ip4_prefix_to_netmask ()

-
guint32             nm_utils_ip4_prefix_to_netmask      (guint32 prefix);
-
+addresses (which is a tuple of address, gateway, and prefix). The specific +format of this serialization is not guaranteed to be stable and may be +extended in the future. +

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

prefix :

a CIDR prefix

list :

a list of NMIP4Address objects. [element-type NMIP4Address] +

Returns :

the netmask represented by the prefix, in network byte order

value :

a pointer to a GValue into which to place the converted addresses, +which should be unset by the caller (when no longer needed) with +g_value_unset().
@@ -647,8 +688,11 @@ prefix, and metric) into a GSList of +
+++ @@ -674,8 +718,11 @@ routes (which is a tuple of route, next hop, prefix, and metric). The specific format of this serialization is not guaranteed to be stable and may be extended in the future.

-

value :

+
+++ @@ -693,79 +740,97 @@ which should be unset by the caller (when no longer needed) with
-

nm_utils_ip6_addresses_from_gvalue ()

-
GSList *            nm_utils_ip6_addresses_from_gvalue  (const GValue *value);
-

-Utility function to convert a GPtrArray of GValueArrays of (GArray of guchars) and guint32 -representing a list of NetworkManager IPv6 addresses (which is a tuple of address, -prefix, and gateway), into a GSList of NMIP6Address objects. The specific format of -this serialization is not guaranteed to be stable and the GValueArray may be -extended in the future. -

-

list :

+

nm_utils_ip4_netmask_to_prefix ()

+
guint32             nm_utils_ip4_netmask_to_prefix      (guint32 netmask);
+
+++ - - + + - +

value :

gvalue containing a GPtrArray of GValueArrays of (GArray of guchars) and guint32

netmask :

an IPv4 netmask in network byte order

Returns :

a newly allocated GSList of NMIP6Address objects. [transfer full][element-type NetworkManager.IP6Address] -the CIDR prefix represented by the netmask

-

nm_utils_ip6_addresses_to_gvalue ()

-
void                nm_utils_ip6_addresses_to_gvalue    (GSList *list,
-                                                         GValue *value);
+

nm_utils_ip4_prefix_to_netmask ()

+
guint32             nm_utils_ip4_prefix_to_netmask      (guint32 prefix);
+
++++ + + + + + + + + + + +

prefix :

a CIDR prefix

Returns :

the netmask represented by the prefix, in network byte order
+
+
+
+

nm_utils_ip4_get_default_prefix ()

+
guint32             nm_utils_ip4_get_default_prefix     (guint32 ip);

-Utility function to convert a GSList of NMIP6Address objects into a -GPtrArray of GValueArrays representing a list of NetworkManager IPv6 addresses -(which is a tuple of address, prefix, and gateway). The specific format of -this serialization is not guaranteed to be stable and may be extended in the -future. +When the Internet was originally set up, various ranges of IP addresses were +segmented into three network classes: A, B, and C. This function will return +a prefix that is associated with the IP address specified defining where it +falls in the predefined classes.

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

list :

a list of NMIP6Address objects. [element-type NMIP6Address] -

ip :

an IPv4 address (in network byte order)

value :

a pointer to a GValue into which to place the converted addresses, -which should be unset by the caller (when no longer needed) with -g_value_unset().

Returns :

the default class prefix for the given IP

-

nm_utils_ip6_dns_from_gvalue ()

-
GSList *            nm_utils_ip6_dns_from_gvalue        (const GValue *value);
+

nm_utils_ip6_addresses_from_gvalue ()

+
GSList *            nm_utils_ip6_addresses_from_gvalue  (const GValue *value);

-Converts a GValue containing a GPtrArray of IP6 DNS, represented as -GByteArrays into a GSList of in6_addrs. +Utility function to convert a GPtrArray of GValueArrays of (GArray of guchars) and guint32 +representing a list of NetworkManager IPv6 addresses (which is a tuple of address, +prefix, and gateway), into a GSList of NMIP6Address objects. The specific format of +this serialization is not guaranteed to be stable and the GValueArray may be +extended in the future.

-
+
+++ - + - @@ -773,26 +838,31 @@ addresses. [ -

nm_utils_ip6_dns_to_gvalue ()

-
void                nm_utils_ip6_dns_to_gvalue          (GSList *list,
+

nm_utils_ip6_addresses_to_gvalue ()

+
void                nm_utils_ip6_addresses_to_gvalue    (GSList *list,
                                                          GValue *value);

-Utility function to convert a GSList of 'struct in6_addr' structs into a -GPtrArray of GByteArrays representing each server's IPv6 addresses in -network byte order. The specific format of this serialization is not -guaranteed to be stable and may be extended in the future. +Utility function to convert a GSList of NMIP6Address objects into a +GPtrArray of GValueArrays representing a list of NetworkManager IPv6 addresses +(which is a tuple of address, prefix, and gateway). The specific format of +this serialization is not guaranteed to be stable and may be extended in the +future.

-

value :

a GValue -gvalue containing a GPtrArray of GValueArrays of (GArray of guchars) and guint32

Returns :

a GSList of IP6 -addresses. [transfer full][element-type Posix.in6_addr] +a newly allocated GSList of NMIP6Address objects. [transfer full][element-type NetworkManager.IP6Address]
+
+++ - + - @@ -809,8 +879,11 @@ routes (which is a tuple of destination, prefix, next hop, and metric) into a GSList of NMIP6Route objects. The specific format of this serialization is not guaranteed to be stable and may be extended in the future.

-

list :

a list of NMIP6Route objectsa list of NMIP6Address objects. [element-type NMIP6Address] +

value :

a pointer to a GValue into which to place the converted DNS server -addresses, which should be unset by the caller (when no longer needed) with +a pointer to a GValue into which to place the converted addresses, +which should be unset by the caller (when no longer needed) with g_value_unset().
+
+++ @@ -837,8 +910,11 @@ representing a list of NetworkManager IPv6 routes (which is a tuple of destinati prefix, next hop, and metric). The specific format of this serialization is not guaranteed to be stable and may be extended in the future.

-

value :

+
+++ @@ -856,55 +932,103 @@ which should be unset by the caller (when no longer needed) with
-

nm_utils_is_empty_ssid ()

-
gboolean            nm_utils_is_empty_ssid              (const guint8 *ssid,
-                                                         int len);
+

nm_utils_ip6_dns_from_gvalue ()

+
GSList *            nm_utils_ip6_dns_from_gvalue        (const GValue *value);

-Different manufacturers use different mechanisms for not broadcasting the -AP's SSID. This function attempts to detect blank/empty SSIDs using a -number of known SSID-cloaking methods. +Converts a GValue containing a GPtrArray of IP6 DNS, represented as +GByteArrays into a GSList of in6_addrs.

-

list :

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

ssid :

pointer to a buffer containing the SSID data

value :

a GValue +

len :

length of the SSID data in ssid +

Returns :

a GSList of IP6 +addresses. [transfer full][element-type Posix.in6_addr]
+
+
+
+

nm_utils_ip6_dns_to_gvalue ()

+
void                nm_utils_ip6_dns_to_gvalue          (GSList *list,
+                                                         GValue *value);
+

+Utility function to convert a GSList of 'struct in6_addr' structs into a +GPtrArray of GByteArrays representing each server's IPv6 addresses in +network byte order. The specific format of this serialization is not +guaranteed to be stable and may be extended in the future. +

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

list :

a list of NMIP6Route objects

Returns :

TRUE if the SSID is "empty", FALSE if it is not

value :

a pointer to a GValue into which to place the converted DNS server +addresses, which should be unset by the caller (when no longer needed) with +g_value_unset().

-

nm_utils_is_uuid ()

-
gboolean            nm_utils_is_uuid                    (const char *str);
+

nm_utils_uuid_generate ()

+
char *              nm_utils_uuid_generate              (void);
+
++++ + + + + +

Returns :

a newly allocated UUID suitable for use as the NMSettingConnection +object's "id": property. Should be freed with g_free() +
+
+
+
+

nm_utils_uuid_generate_from_string ()

+
char *              nm_utils_uuid_generate_from_string  (const char *s);

-Checks if str is a UUID +For a given s, this function will always return the same UUID.

-
+
+++ - - + + - +

str :

a string that might be a UUID

s :

a string to use as the seed for the UUID

Returns :

-TRUE if str is a UUID, FALSE if nota newly allocated UUID suitable for use as the NMSettingConnection +object's "id": property
-

Since 0.9.8


@@ -918,8 +1042,11 @@ Encrypts the given RSA private key data with the given password (or generates a password if no password was given) and converts the data to PEM format suitable for writing to a file.

-
+
+++ @@ -932,7 +1059,7 @@ suitable for writing to a file. - @@ -951,365 +1078,358 @@ certificate/private key file. [ -

nm_utils_same_ssid ()

-
gboolean            nm_utils_same_ssid                  (const GByteArray *ssid1,
-                                                         const GByteArray *ssid2,
-                                                         gboolean ignore_trailing_null);
+

nm_utils_file_is_pkcs12 ()

+
gboolean            nm_utils_file_is_pkcs12             (const char *filename);

-Earlier versions of the Linux kernel added a NULL byte to the end of the -SSID to enable easy printing of the SSID on the console or in a terminal, -but this behavior was problematic (SSIDs are simply byte arrays, not strings) -and thus was changed. This function compensates for that behavior at the -cost of some compatibility with odd SSIDs that may legitimately have trailing -NULLs, even though that is functionally pointless. +Utility function to find out if the filename is in PKCS12 format.

-

data :

out_password :

if in_password was NULL, a random password will be generated +if in_password was NULL, a random password will be generated and returned in this argument. [out][allow-none]
+
+++ - - - - - - - - - - + + - +

ssid1 :

first SSID data to compare

ssid2 :

second SSID data to compare

ignore_trailing_null :

TRUE to ignore one trailing NULL byte

filename :

name of the file to test

Returns :

TRUE if the SSIDs are the same, FALSE if they are notTRUE if the file is PKCS12, FALSE if it is not

-

nm_utils_security_valid ()

-
gboolean            nm_utils_security_valid             (NMUtilsSecurityType type,
-                                                         NMDeviceWifiCapabilities wifi_caps,
-                                                         gboolean have_ap,
-                                                         gboolean adhoc,
-                                                         NM80211ApFlags ap_flags,
-                                                         NM80211ApSecurityFlags ap_wpa,
-                                                         NM80211ApSecurityFlags ap_rsn);
-

-Given a set of device capabilities, and a desired security type to check -against, determines whether the combination of device, desired security -type, and AP capabilities intersect. -

+

nm_utils_wifi_freq_to_channel ()

+
guint32             nm_utils_wifi_freq_to_channel       (guint32 freq);

-NOTE: this function cannot handle checking security for AP/Hotspot mode; -use nm_utils_ap_mode_security_valid() instead. +Utility function to translate a WiFi frequency to its corresponding channel.

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

type :

the security type to check AP flags and device capabilties against, -e.g. NMU_SEC_STATIC_WEP -

wifi_caps :

bitfield of the capabilities of the specific WiFi device, e.g. -NM_WIFI_DEVICE_CAP_CIPHER_WEP40 -

have_ap :

whether the ap_flags, ap_wpa, and ap_rsn arguments are valid

adhoc :

whether the capabilities being tested are from an Ad-Hoc AP (IBSS)

freq :

frequency

ap_flags :

bitfield of AP capabilities, e.g. NM_802_11_AP_FLAGS_PRIVACY -

Returns :

the channel represented by the frequency or 0
+
+
+
+

nm_utils_wifi_channel_to_freq ()

+
guint32             nm_utils_wifi_channel_to_freq       (guint32 channel,
+                                                         const char *band);
+

+Utility function to translate a WiFi channel to its corresponding frequency. +

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

ap_wpa :

bitfield of AP capabilties derived from the AP's WPA beacon, -e.g. (NM_802_11_AP_SEC_PAIR_TKIP | NM_802_11_AP_SEC_KEY_MGMT_PSK)

channel :

channel

ap_rsn :

bitfield of AP capabilties derived from the AP's RSN/WPA2 beacon, -e.g. (NM_802_11_AP_SEC_PAIR_CCMP | NM_802_11_AP_SEC_PAIR_TKIP)

band :

frequency band for wireless ("a" or "bg")

Returns :

TRUE if the device capabilities and AP capabilties intersect and are -compatible with the desired type, FALSE if they are notthe frequency represented by the channel of the band, +or -1 when the freq is invalid, or 0 when the band +is invalid

-

nm_utils_slist_free ()

-
void                nm_utils_slist_free                 (GSList *list,
-                                                         GDestroyNotify elem_destroy_fn);
+

nm_utils_wifi_find_next_channel ()

+
guint32             nm_utils_wifi_find_next_channel     (guint32 channel,
+                                                         int direction,
+                                                         char *band);

-Utility function to free a GSList. +Utility function to find out next/previous WiFi channel for a channel.

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

list :

a GSList -

channel :

current channel

elem_destroy_fn :

user function called for each element in list -

direction :

whether going downward (0 or less) or upward (1 or more)

band :

frequency band for wireless ("a" or "bg")

Returns :

the next channel in the specified direction or 0

-

nm_utils_ssid_to_utf8 ()

-
char *              nm_utils_ssid_to_utf8               (const GByteArray *ssid);
-

-WiFi SSIDs are byte arrays, they are _not_ strings. Thus, an SSID may -contain embedded NULLs and other unprintable characters. Often it is -useful to print the SSID out for debugging purposes, but that should be the -_only_ use of this function. Do not use this function for any persistent -storage of the SSID, since the printable SSID returned from this function -cannot be converted back into the real SSID of the access point. -

-

-This function does almost everything humanly possible to convert the input -into a printable UTF-8 string, using roughly the following procedure: -

-

-1) if the input data is already UTF-8 safe, no conversion is performed -2) attempts to get the current system language from the LANG environment - variable, and depending on the language, uses a table of alternative - encodings to try. For example, if LANG=hu_HU, the table may first try - the ISO-8859-2 encoding, and if that fails, try the Windows-1250 encoding. - If all fallback encodings fail, replaces non-UTF-8 characters with '?'. -3) If the system language was unable to be determined, falls back to the - ISO-8859-1 encoding, then to the Windows-1251 encoding. -4) If step 3 fails, replaces non-UTF-8 characters with '?'. -

+

nm_utils_wifi_is_channel_valid ()

+
gboolean            nm_utils_wifi_is_channel_valid      (guint32 channel,
+                                                         const char *band);

-Again, this function should be used for debugging and display purposes -_only_. +Utility function to verify WiFi channel validity.

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

ssid :

a byte array containing the SSID data

channel :

channel

band :

frequency band for wireless ("a" or "bg")

Returns :

an allocated string containing a UTF-8 -representation of the SSID, which must be freed by the caller using g_free(). -Returns NULL on errors. [transfer full] -TRUE or FALSE

-

nm_utils_uuid_generate ()

-
char *              nm_utils_uuid_generate              (void);
-
-- - - - -

Returns :

a newly allocated UUID suitable for use as the NMSettingConnection -object's "id": property. Should be freed with g_free() -
+

NM_UTILS_HWADDR_LEN_MAX

+
#define NM_UTILS_HWADDR_LEN_MAX 20 /* INFINIBAND_ALEN */
+
+

+The maximum length of a hardware address of a type known by +nm_utils_hwaddr_len() or nm_utils_hwaddr_aton(). This can be used +as the size of the buffer passed to nm_utils_hwaddr_aton(). +


-

nm_utils_uuid_generate_from_string ()

-
char *              nm_utils_uuid_generate_from_string  (const char *s);
+

nm_utils_hwaddr_len ()

+
int                 nm_utils_hwaddr_len                 (int type);

-For a given s, this function will always return the same UUID. +Returns the length in octets of a hardware address of type type.

-
+
+++ - - + + - +

s :

a string to use as the seed for the UUID

type :

the type of address; either ARPHRD_ETHER or ARPHRD_INFINIBAND +

Returns :

a newly allocated UUID suitable for use as the NMSettingConnection -object's "id": propertythe length

-

nm_utils_wep_key_valid ()

-
gboolean            nm_utils_wep_key_valid              (const char *key,
-                                                         NMWepKeyType wep_type);
+

nm_utils_hwaddr_type ()

+
int                 nm_utils_hwaddr_type                (int len);

-Checks if key is a valid WEP key +Returns the type (either ARPHRD_ETHER or ARPHRD_INFINIBAND) of the raw +address given its length.

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

key :

a string that might be a WEP key

wep_type :

the NMWepKeyType type of the WEP key

len :

the length of hardware address in bytes

Returns :

-TRUE if key is a WEP key, FALSE if notthe type, either ARPHRD_ETHER or ARPHRD_INFINIBAND, or -1 if +the address length was not recognized
-

Since 0.9.8


-

nm_utils_wifi_channel_to_freq ()

-
guint32             nm_utils_wifi_channel_to_freq       (guint32 channel,
-                                                         const char *band);
+

nm_utils_hwaddr_ntoa ()

+
char *              nm_utils_hwaddr_ntoa                (gconstpointer addr,
+                                                         int type);

-Utility function to translate a WiFi channel to its corresponding frequency. +Converts addr to textual form.

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

channel :

channel

addr :

a binary hardware address

band :

frequency band for wireless ("a" or "bg")

type :

the type of address; either ARPHRD_ETHER or ARPHRD_INFINIBAND +

Returns :

the frequency represented by the channel of the band, -or -1 when the freq is invalid, or 0 when the band -is invalidthe textual form of addr. [transfer full] +

-

nm_utils_wifi_find_next_channel ()

-
guint32             nm_utils_wifi_find_next_channel     (guint32 channel,
-                                                         int direction,
-                                                         char *band);
+

nm_utils_hwaddr_atoba ()

+
GByteArray *        nm_utils_hwaddr_atoba               (const char *asc,
+                                                         int type);

-Utility function to find out next/previous WiFi channel for a channel. +Parses asc and converts it to binary form in a GByteArray. See +nm_utils_hwaddr_aton() if you don't want a GByteArray.

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

channel :

current channel

direction :

whether going downward (0 or less) or upward (1 or more)

asc :

the ASCII representation of a hardware address

band :

frequency band for wireless ("a" or "bg")

type :

the type of address; either ARPHRD_ETHER or ARPHRD_INFINIBAND +

Returns :

the next channel in the specified direction or 0a new GByteArray, or NULL if asc couldn't +be parsed. [transfer full] +

-

nm_utils_wifi_freq_to_channel ()

-
guint32             nm_utils_wifi_freq_to_channel       (guint32 freq);
+

nm_utils_hwaddr_aton ()

+
guint8 *            nm_utils_hwaddr_aton                (const char *asc,
+                                                         int type,
+                                                         gpointer buffer);

-Utility function to translate a WiFi frequency to its corresponding channel. +Parses asc and converts it to binary form in buffer. See +nm_utils_hwaddr_atoba() if you'd rather have the result in a +GByteArray.

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

freq :

frequency

asc :

the ASCII representation of a hardware address

type :

the type of address; either ARPHRD_ETHER or ARPHRD_INFINIBAND +

buffer :

buffer to store the result into

Returns :

the channel represented by the frequency or 0 +buffer, or NULL if asc couldn't be parsed

-

nm_utils_wifi_is_channel_valid ()

-
gboolean            nm_utils_wifi_is_channel_valid      (guint32 channel,
-                                                         const char *band);
+

nm_utils_iface_valid_name ()

+
gboolean            nm_utils_iface_valid_name           (const char *name);

-Utility function to verify WiFi channel validity. +This function is a 1:1 copy of the kernel's interface validation +function in net/core/dev.c.

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

channel :

channel

band :

frequency band for wireless ("a" or "bg")

name :

Name of interface

Returns :

TRUE or FALSE +TRUE if interface name is valid, otherwise FALSE is returned.
+

Since 0.9.8


-

nm_utils_wpa_psk_valid ()

-
gboolean            nm_utils_wpa_psk_valid              (const char *psk);
+

nm_utils_is_uuid ()

+
gboolean            nm_utils_is_uuid                    (const char *str);

-Checks if psk is a valid WPA PSK +Checks if str is a UUID

-
+
+++ - - + + +TRUE if str is a UUID, FALSE if not

psk :

a string that might be a WPA PSK

str :

a string that might be a UUID

Returns :

-TRUE if psk is a WPA PSK, FALSE if not
@@ -1319,6 +1439,6 @@ Checks if psk is a valid WPA PSK
+ Generated by GTK-Doc V1.19
\ No newline at end of file diff --git a/docs/libnm-util/html/libnm-util.devhelp2 b/docs/libnm-util/html/libnm-util.devhelp2 index 9f00e53a..f1daa3d4 100644 --- a/docs/libnm-util/html/libnm-util.devhelp2 +++ b/docs/libnm-util/html/libnm-util.devhelp2 @@ -34,31 +34,44 @@ - - + + + + + + + - - + + + + - - - - + + + + + + + + + + + + + + - - - - @@ -69,98 +82,85 @@ - + - - - - - - - - - - - - - - + - - - - - - - - - - + + - - - + + + + + + + + + + + + + + + - - - - - - - - - + + + - + + + - - + - + - - - - - - - - + + + + + - - - - - + + + + + + - + + + + + - - - - - - - - + + + + + + + @@ -173,38 +173,38 @@ - - + - - - + + + + + + - + - - - - - - - + + + + + + + - - + + - - - + @@ -217,47 +217,47 @@ - - + + + + + - - - - + + + + - + + + + - - - - - - - - - - + + + + + - - - + + + + - - - + + + - - - + @@ -272,58 +272,58 @@ - - + + + + + - + + - - - - - - - - - - - + + + + + + + + + + - - + - - - - - - - - - - + + + + + + + + + + + + + + - - - - - - @@ -341,93 +341,93 @@ - - + - - + + - + + + - - - + + + - - - - + + + + - - + - - + + + - - - + + + + - - - - + - - - - - - - + + + + + + - - - - + + + + + + + + + - - - - + + - - + @@ -439,65 +439,65 @@ - - + - - - - - + + + + + + - - + + - - - - + + - - - + + + + + - - - + + + - - + - + + + + - - - - - - + + + + + + + - - - - + @@ -505,111 +505,111 @@ - - + - - - - - - - + + + + + + + + - - + + - - + + + - - - + - - - - - - + - - - - - - - + + + + + + + + + - + + + - + + + - - + - - - - + + + + + + + - - - - + - - - + + - + + + - - - - - - + + + + + + + - - - + - + + @@ -617,111 +617,111 @@ - - + - + + + + + + + - - - - - - - - - - - + + + + + + + + + + + - - - - - - - + + + + + - - + - - - + + + + + + - - + + + + + + + + - - - - - - - - - - - - - + - + + + - - + + + + + + + + - - - - - - - - + + + + + + - + + - - - - - - - - - - - - + + + + - + + + @@ -747,89 +747,91 @@ + + - - - - + - - - - + + + - - + + + + + + + - - - - - - - - - - + + + + + + - + - - - - - - - + + + + + + + - - + - - + + + + + + + + + + - - - + - - - - - - - - + - - - - - + + + - - + + + + - - - - + + + + + + + + + @@ -842,84 +844,84 @@ - - - - + - - - + + + - - + + - + + - + + + - - - - - - - - - + + + + + + - + - - - - - - - + + + + + + + - - + - - + + + + + + + + + + - - - + - - - - - - + - - - - - - + + + - - + + + + - - - - + + + + + + + + @@ -931,49 +933,49 @@ - - + - - - - - - - + - - - - + + - + + + - - - - - - - - - - + + + + + + + + + + - - - + + - + + + - + + + + + + + @@ -992,119 +994,119 @@ - - + - - + - - - - + + + + + - + + - - + - - - + - + + + + + + + + + - - - - - + + + - - - - + - - - + + - + + - - - - - - - + + + + + + - - - + + + - - - - - - - - - + + - + + + - - + + + + + + + + + + + + + + + + - - - - - - - - - - - + + + @@ -1145,6 +1147,13 @@ + + + + + + + @@ -1160,13 +1169,6 @@ - - - - - - - @@ -1188,11 +1190,11 @@ + + - - diff --git a/docs/libnm-util/html/object-tree.html b/docs/libnm-util/html/object-tree.html index e6ea328c..df07ca9f 100644 --- a/docs/libnm-util/html/object-tree.html +++ b/docs/libnm-util/html/object-tree.html @@ -3,12 +3,12 @@ Object Hierarchy - + - + @@ -20,8 +20,8 @@ Next
-

-Object Hierarchy

+

+Object Hierarchy

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