From 263bf4c0c89bb88dc995acd9a6a2de9095fbd461 Mon Sep 17 00:00:00 2001 From: Michael Biebl Date: Tue, 23 Aug 2011 19:16:47 +0200 Subject: Imported Upstream version 0.9.0 --- docs/libnm-util/html/NMConnection.html | 37 +- docs/libnm-util/html/NMSetting.html | 150 ++-- docs/libnm-util/html/NMSetting8021x.html | 457 ++++++++++- docs/libnm-util/html/NMSettingBluetooth.html | 102 ++- docs/libnm-util/html/NMSettingCdma.html | 32 +- docs/libnm-util/html/NMSettingConnection.html | 2 +- docs/libnm-util/html/NMSettingGsm.html | 342 +++++++- docs/libnm-util/html/NMSettingIP4Config.html | 885 ++++++++++++++++++++- docs/libnm-util/html/NMSettingIP6Config.html | 843 +++++++++++++++++++- docs/libnm-util/html/NMSettingOlpcMesh.html | 4 +- docs/libnm-util/html/NMSettingPPP.html | 60 +- docs/libnm-util/html/NMSettingPPPOE.html | 75 +- docs/libnm-util/html/NMSettingSerial.html | 140 +++- docs/libnm-util/html/NMSettingVPN.html | 229 +++++- docs/libnm-util/html/NMSettingWimax.html | 288 +++++++ docs/libnm-util/html/NMSettingWired.html | 225 +++++- docs/libnm-util/html/NMSettingWireless.html | 401 +++++++++- .../libnm-util/html/NMSettingWirelessSecurity.html | 549 ++++++++++++- docs/libnm-util/html/api-index-full.html | 549 ++++++++++++- docs/libnm-util/html/ch01.html | 30 +- docs/libnm-util/html/index.html | 28 +- docs/libnm-util/html/index.sgml | 151 +++- docs/libnm-util/html/libnm-util-nm-utils.html | 75 +- docs/libnm-util/html/libnm-util.devhelp | 44 +- docs/libnm-util/html/libnm-util.devhelp2 | 142 +++- docs/libnm-util/html/object-tree.html | 4 +- 26 files changed, 5460 insertions(+), 384 deletions(-) create mode 100644 docs/libnm-util/html/NMSettingWimax.html (limited to 'docs/libnm-util/html') diff --git a/docs/libnm-util/html/NMConnection.html b/docs/libnm-util/html/NMConnection.html index 489a2fd6..c700c0d9 100644 --- a/docs/libnm-util/html/NMConnection.html +++ b/docs/libnm-util/html/NMConnection.html @@ -84,7 +84,7 @@ const char * void nm_connection_clear_secrets (NMConnection *connection); gboolean nm_connection_update_secrets (NMConnection *connection, const char *setting_name, - GHashTable *setting_secrets, + GHashTable *secrets, GError **error); void nm_connection_set_path (NMConnection *connection, const char *path); @@ -123,7 +123,7 @@ const char * NMConnection *connection); NMSettingVPN * nm_connection_get_setting_vpn (NMConnection *connection); -NMSettingWimax * nm_connection_get_setting_wimax +NMSettingWimax * nm_connection_get_setting_wimax (NMConnection *connection); NMSettingWired * nm_connection_get_setting_wired (NMConnection *connection); @@ -182,7 +182,8 @@ parameters (MTU, SSID, APN, channel, rate, etc) and IP-level parameters { NM_CONNECTION_ERROR_UNKNOWN = 0, NM_CONNECTION_ERROR_CONNECTION_SETTING_NOT_FOUND, - NM_CONNECTION_ERROR_CONNECTION_TYPE_INVALID + NM_CONNECTION_ERROR_CONNECTION_TYPE_INVALID, + NM_CONNECTION_ERROR_SETTING_NOT_FOUND } NMConnectionError;

@@ -211,6 +212,12 @@ Describes errors that may result from operations involving a NMSettingWireless. + +

NM_CONNECTION_ERROR_SETTING_NOT_FOUND

+the NMConnection object + did not contain the specified NMSetting object + + @@ -505,7 +512,7 @@ added to the

error :

-location to store error, or
NULL +location to store error, or NULL @@ -626,7 +633,7 @@ setting and which property failed validation, and how it failed validation.

error :

-location to store error, or NULL +location to store error, or NULL @@ -696,13 +703,15 @@ keeping secret data in memory when not needed.

nm_connection_update_secrets ()

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

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

@@ -717,21 +726,21 @@ be returned from the setting object name to which the secrets apply - + - +TRUE if the secrets were successfully updated, FALSE if the update +failed (tried to update secrets for a setting that doesn't exist, etc)

setting_secrets :

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 +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 connection
@@ -1226,10 +1235,10 @@ A shortcut to return any

nm_connection_get_setting_wimax ()

-
NMSettingWimax *            nm_connection_get_setting_wimax
+
NMSettingWimax *            nm_connection_get_setting_wimax
                                                         (NMConnection *connection);

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

@@ -1241,7 +1250,7 @@ A shortcut to return any NMSettingWimax the connection - diff --git a/docs/libnm-util/html/NMSetting.html b/docs/libnm-util/html/NMSetting.html index b9c258d2..0cc1fd03 100644 --- a/docs/libnm-util/html/NMSetting.html +++ b/docs/libnm-util/html/NMSetting.html @@ -54,6 +54,7 @@ enum NMSetti #define NM_SETTING_PARAM_FUZZY_IGNORE #define NM_SETTING_NAME enum NMSettingSecretFlags; +enum NMSettingCompareFlags; NMSetting; NMSettingClass; void (*NMSettingValueIterFn) (NMSetting *setting, @@ -72,7 +73,6 @@ const char * gbooleannm_setting_verify (NMSetting *setting, GSList *all_settings, GError **error); -enum NMSettingCompareFlags; gbooleannm_setting_compare (NMSetting *a, NMSetting *b, NMSettingCompareFlags flags); @@ -122,7 +122,7 @@ enum NMSettingPPPOE +----NMSettingSerial +----NMSettingVPN - +----NMSettingWimax + +----NMSettingWimax +----NMSettingWired +----NMSettingWireless +----NMSettingWirelessSecurity @@ -313,6 +313,64 @@ secret is not required
+

enum NMSettingCompareFlags

+
typedef enum {
+	NM_SETTING_COMPARE_FLAG_EXACT = 0x00000000,
+	NM_SETTING_COMPARE_FLAG_FUZZY = 0x00000001,
+	NM_SETTING_COMPARE_FLAG_IGNORE_ID = 0x00000002,
+	NM_SETTING_COMPARE_FLAG_IGNORE_SECRETS = 0x00000004,
+	NM_SETTING_COMPARE_FLAG_IGNORE_AGENT_OWNED_SECRETS = 0x00000008,
+	NM_SETTING_COMPARE_FLAG_IGNORE_NOT_SAVED_SECRETS = 0x00000010
+} NMSettingCompareFlags;
+
+

+These flags modify the comparison behavior when comparing two settings or +two connections. +

+

Returns :

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

NM_SETTING_COMPARE_FLAG_EXACT

match all properties exactly +

NM_SETTING_COMPARE_FLAG_FUZZY

match only important attributes, like SSID, + type, security settings, etc. Does not match, for example, connection ID + or UUID. +

NM_SETTING_COMPARE_FLAG_IGNORE_ID

ignore the connection's ID +

NM_SETTING_COMPARE_FLAG_IGNORE_SECRETS

ignore all secrets +

NM_SETTING_COMPARE_FLAG_IGNORE_AGENT_OWNED_SECRETS

ignore secrets for which +the secret's flags indicate the secret is owned by a user secret agent +(ie, the secret's flag includes NM_SETTING_SECRET_FLAG_AGENT_OWNED) +

NM_SETTING_COMPARE_FLAG_IGNORE_NOT_SAVED_SECRETS

ignore secrets for which +the secret's flags indicate the secret should not be saved to persistent +storage (ie, the secret's flag includes NM_SETTING_SECRET_FLAG_NOT_SAVED) +
+ +
+

NMSetting

typedef struct _NMSetting NMSetting;

@@ -350,11 +408,16 @@ It should only be accessed through the functions described below. 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); + /* Padding for future expansion */ void (*_reserved1) (void); void (*_reserved2) (void); void (*_reserved3) (void); - void (*_reserved4) (void); } NMSettingClass;

@@ -368,8 +431,35 @@ It should only be accessed through the functions described below. const GValue *value, GParamFlags flags, gpointer user_data); -

-

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

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

flags :

The property's flags, like NM_SETTING_PARAM_SECRET +

user_data :

User data passed to nm_setting_enumerate_values() +

@@ -550,7 +640,7 @@ came

error :

-location to store error, or NULL +location to store error, or NULL @@ -563,48 +653,6 @@ came

-

enum NMSettingCompareFlags

-
typedef enum {
-	NM_SETTING_COMPARE_FLAG_EXACT = 0x00000000,
-	NM_SETTING_COMPARE_FLAG_FUZZY = 0x00000001,
-	NM_SETTING_COMPARE_FLAG_IGNORE_ID = 0x00000002,
-	NM_SETTING_COMPARE_FLAG_IGNORE_SECRETS = 0x00000004
-} NMSettingCompareFlags;
-
-

-These flags modify the comparison behavior when comparing two settings or -two connections. -

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

NM_SETTING_COMPARE_FLAG_EXACT

match all properties exactly -

NM_SETTING_COMPARE_FLAG_FUZZY

match only important attributes, like SSID, - type, security settings, etc. Does not match, for example, connection ID - or UUID. -

NM_SETTING_COMPARE_FLAG_IGNORE_ID

ignore the connection's ID -

NM_SETTING_COMPARE_FLAG_IGNORE_SECRETS

ignore secrets -
-
-
-

nm_setting_compare ()

gboolean            nm_setting_compare                  (NMSetting *a,
                                                          NMSetting *b,
@@ -856,7 +904,7 @@ string to error :

-location to store error, or
NULL +location to store error, or NULL @@ -897,7 +945,7 @@ handle that secret.

error :

-location to store error, or NULL +location to store error, or NULL @@ -937,7 +985,7 @@ handle that secret.

error :

-location to store error, or NULL +location to store error, or NULL diff --git a/docs/libnm-util/html/NMSetting8021x.html b/docs/libnm-util/html/NMSetting8021x.html index c9e533b5..1d7216b1 100644 --- a/docs/libnm-util/html/NMSetting8021x.html +++ b/docs/libnm-util/html/NMSetting8021x.html @@ -56,6 +56,8 @@ enum NM_SETTING_802_1X_ANONYMOUS_IDENTITY #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_PHASE1_PEAPVER #define NM_SETTING_802_1X_PHASE1_PEAPLABEL @@ -64,6 +66,8 @@ enum 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 @@ -108,6 +112,20 @@ const char * 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); +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); NMSetting8021xCKScheme nm_setting_802_1x_get_client_cert_scheme (NMSetting8021x *setting); const GByteArray * nm_setting_802_1x_get_client_cert_blob @@ -140,6 +158,21 @@ const char * NMSetting8021xCKScheme scheme, NMSetting8021xCKFormat *out_format, GError **error); +const char * nm_setting_802_1x_get_phase2_subject_match + (NMSetting8021x *setting); +guint32 nm_setting_802_1x_get_num_phase2_altsubject_matches + (NMSetting8021x *setting); +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_client_cert_blob @@ -211,6 +244,7 @@ const char *

Properties

+  "altsubject-matches"       GSList_gchararray_*   : Read / Write
   "anonymous-identity"       gchar*                : Read / Write
   "ca-cert"                  GArray_guchar_*       : Read / Write
   "ca-path"                  gchar*                : Read / Write
@@ -222,6 +256,7 @@ const char *            phase1-fast-provisioning" gchar*                : Read / Write
   "phase1-peaplabel"         gchar*                : Read / Write
   "phase1-peapver"           gchar*                : Read / Write
+  "phase2-altsubject-matches" GSList_gchararray_*   : Read / Write
   "phase2-auth"              gchar*                : Read / Write
   "phase2-autheap"           gchar*                : Read / Write
   "phase2-ca-cert"           GArray_guchar_*       : Read / Write
@@ -230,9 +265,11 @@ const char *            phase2-private-key"       GArray_guchar_*       : Read / Write
   "phase2-private-key-password" gchar*                : Read / Write
   "phase2-private-key-password-flags" guint                 : Read / Write
+  "phase2-subject-match"     gchar*                : Read / Write
   "private-key"              GArray_guchar_*       : Read / Write
   "private-key-password"     gchar*                : Read / Write
   "private-key-password-flags" guint                 : Read / Write
+  "subject-match"            gchar*                : Read / Write
   "system-ca-certs"          gboolean              : Read / Write / Construct
 
@@ -359,15 +396,33 @@ to a file containing the certificate or key data

enum NMSetting8021xError

-
typedef enum
-{
+
typedef enum {
 	NM_SETTING_802_1X_ERROR_UNKNOWN = 0,
 	NM_SETTING_802_1X_ERROR_INVALID_PROPERTY,
 	NM_SETTING_802_1X_ERROR_MISSING_PROPERTY
 } NMSetting8021xError;
 
-

-

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

NM_SETTING_802_1X_ERROR_UNKNOWN

unknown or unclassified error +

NM_SETTING_802_1X_ERROR_INVALID_PROPERTY

the property was invalid +

NM_SETTING_802_1X_ERROR_MISSING_PROPERTY

the property was missing and is +required +

@@ -442,6 +497,22 @@ Registers an error quark for +

NM_SETTING_802_1X_SUBJECT_MATCH

+
#define NM_SETTING_802_1X_SUBJECT_MATCH "subject-match"
+
+

+

+
+
+
+

NM_SETTING_802_1X_ALTSUBJECT_MATCHES

+
#define NM_SETTING_802_1X_ALTSUBJECT_MATCHES "altsubject-matches"
+
+

+

+
+
+

NM_SETTING_802_1X_CLIENT_CERT

#define NM_SETTING_802_1X_CLIENT_CERT "client-cert"
 
@@ -506,6 +577,22 @@ Registers an error quark for +

NM_SETTING_802_1X_PHASE2_SUBJECT_MATCH

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

+

+
+
+
+

NM_SETTING_802_1X_PHASE2_ALTSUBJECT_MATCHES

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

+

+
+
+

NM_SETTING_802_1X_PHASE2_CLIENT_CERT

#define NM_SETTING_802_1X_PHASE2_CLIENT_CERT "phase2-client-cert"
 
@@ -1031,6 +1118,153 @@ clears the CA certificate.

+

nm_setting_802_1x_get_subject_match ()

+
const char *        nm_setting_802_1x_get_subject_match (NMSetting8021x *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_num_altsubject_matches ()

+
guint32             nm_setting_802_1x_get_num_altsubject_matches
+                                                        (NMSetting8021x *setting);
+

+Returns the number of entries in the +"altsubject-matches" property of this setting. +

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

setting :

the NMSetting8021x +

Returns :

the number of altsubject-matches entries.
+
+
+
+

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

nm_setting_802_1x_add_altsubject_match ()

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

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

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

setting :

the NMSetting8021x +

altsubject_match :

the altSubjectName to allow for this connection

Returns :

TRUE if the alternative subject name match was +successfully added, FALSE if it was already allowed.
+
+
+
+

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

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

setting :

the NMSetting8021x +

i :

the index of the altSubjectName match to remove
+
+
+
+

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);
@@ -1401,6 +1635,155 @@ clears the "phase2" CA certificate.

+

nm_setting_802_1x_get_phase2_subject_match ()

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

setting :

the NMSetting8021x +

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

nm_setting_802_1x_get_num_phase2_altsubject_matches ()

+
guint32             nm_setting_802_1x_get_num_phase2_altsubject_matches
+                                                        (NMSetting8021x *setting);
+

+Returns the number of entries in the +"phase2-altsubject-matches" property of this setting. +

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

setting :

the NMSetting8021x +

Returns :

the number of phase2-altsubject-matches entries.
+
+
+
+

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

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

setting :

the NMSettingConnection +

i :

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

Returns :

the "phase 2" altSubjectName match at index i +
+
+
+
+

nm_setting_802_1x_add_phase2_altsubject_match ()

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

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

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

setting :

the NMSetting8021x +

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

nm_setting_802_1x_remove_phase2_altsubject_match ()

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

+Removes the allowed "phase 2" altSubjectName at the specified index. +

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

setting :

the NMSetting8021x +

i :

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

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

NMSetting8021xCKScheme  nm_setting_802_1x_get_phase2_client_cert_scheme
                                                         (NMSetting8021x *setting);
@@ -1748,7 +2131,7 @@ 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. @@ -1787,8 +2170,7 @@ an error is returned.

Returns :

the private key password used to decrypt the private key if -previously set with nm_setting_802_1x_set_private_key_from_file(), -nm_setting_802_1x_set_private_key_path(), or the +previously set with nm_setting_802_1x_set_private_key(), or the "private-key-password" property. @@ -1973,7 +2355,7 @@ use 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. @@ -2012,8 +2394,7 @@ 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_from_file(), -nm_setting_802_1x_set_phase2_private_key_path(), or the +previously set with nm_setting_802_1x_set_phase2_private_key() or the "phase2-private-key-password" property. @@ -2066,6 +2447,17 @@ previously set with nm_setting_802_1x_set_phase2_private_

Property Details

+

The "altsubject-matches" property

+
  "altsubject-matches"       GSList_gchararray_*   : Read / Write
+

+List of strings to be matched against the altSubjectName of the +certificate presented by the authentication server. If the list +is empty, no verification of the server certificate's +altSubjectName is performed. +

+
+
+

The "anonymous-identity" property

  "anonymous-identity"       gchar*                : Read / Write

@@ -2189,6 +2581,18 @@ version.


+

The "phase2-altsubject-matches" property

+
  "phase2-altsubject-matches" GSList_gchararray_*   : Read / Write
+

+List of strings to be matched against the altSubjectName of the +certificate presented by the authentication server during the +inner "phase 2" authentication. If the list is empty, no +verification of the server certificate's altSubjectName is +performed. +

+
+
+

The "phase2-auth" property

  "phase2-auth"              gchar*                : Read / Write

@@ -2256,8 +2660,8 @@ properties. Setting this property directly is discouraged; use the Private key data used by "phase 2" inner authentication methods.

-Contains the "phase 2" inner private key if the "auth" or -"phase2-autheap" property is set to 'tls'. Setting this +Contains the "phase 2" inner private key if the "phase2-auth" +or "phase2-autheap" property is set to 'tls'. Setting this property directly is discouraged; use the nm_setting_802_1x_set_phase2_private_key() function instead.

@@ -2288,6 +2692,18 @@ Flags indicating how to handle +

The "phase2-subject-match" property

+
  "phase2-subject-match"     gchar*                : Read / Write
+

+Substring to be matched against the subject of the certificate +presented by the authentication server during the inner "phase +2" authentication. When unset, no verification of the +authentication server certificate's subject is performed. +

+

Default value: NULL

+
+
+

The "private-key" property

  "private-key"              GArray_guchar_*       : Read / Write

@@ -2329,6 +2745,18 @@ Flags indicating how to handle +

The "subject-match" property

+
  "subject-match"            gchar*                : Read / Write
+

+Substring to be matched against the subject of the certificate +presented by the authentication server. When unset, no +verification of the authentication server certificate's subject +is performed. +

+

Default value: NULL

+
+
+

The "system-ca-certs" property

  "system-ca-certs"          gboolean              : Read / Write / Construct

@@ -2336,9 +2764,8 @@ When TRUE, overrides "phase2-ca-path" properties using the system CA directory specified at configure time with the --system-ca-path switch. The certificates in this directory are added to the verification chain in -addition to any certificates specified by the "ca-cert", -"ca-cert-path", "phase2-ca-cert" and -"phase2-ca-cert-path" properties. +addition to any certificates specified by the "ca-cert" +and "phase2-ca-cert" properties.

Default value: FALSE

diff --git a/docs/libnm-util/html/NMSettingBluetooth.html b/docs/libnm-util/html/NMSettingBluetooth.html index a6eae7b9..0e024c2b 100644 --- a/docs/libnm-util/html/NMSettingBluetooth.html +++ b/docs/libnm-util/html/NMSettingBluetooth.html @@ -35,13 +35,16 @@

NMSettingBluetooth

-

NMSettingBluetooth

+

NMSettingBluetooth — Describes Bluetooth connection properties

Synopsis

-
#define             NM_SETTING_BLUETOOTH_SETTING_NAME
+
+#include <nm-setting-bluetooth.h>
+
+#define             NM_SETTING_BLUETOOTH_SETTING_NAME
 enum                NMSettingBluetoothError;
 #define             NM_TYPE_SETTING_BLUETOOTH_ERROR
 #define             NM_SETTING_BLUETOOTH_ERROR
@@ -81,6 +84,10 @@ const char *        
 

Description

+The NMSettingBluetooth object is a NMSetting subclass that describes +properties necessary for connection to devices that provide network +connections via the Bluetooth Dial-Up Networking (DUN) and Network Access +Point (NAP) profiles.

@@ -95,16 +102,41 @@ const char *

enum NMSettingBluetoothError

-
typedef enum
-{
+
typedef enum {
 	NM_SETTING_BLUETOOTH_ERROR_UNKNOWN = 0,
 	NM_SETTING_BLUETOOTH_ERROR_INVALID_PROPERTY,
 	NM_SETTING_BLUETOOTH_ERROR_MISSING_PROPERTY,
 	NM_SETTING_BLUETOOTH_ERROR_TYPE_SETTING_NOT_FOUND,
 } NMSettingBluetoothError;
 
-

-

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

NM_SETTING_BLUETOOTH_ERROR_UNKNOWN

unknown or unclassified error +

NM_SETTING_BLUETOOTH_ERROR_INVALID_PROPERTY

the property was invalid +

NM_SETTING_BLUETOOTH_ERROR_MISSING_PROPERTY

the property was missing and is +required +

NM_SETTING_BLUETOOTH_ERROR_TYPE_SETTING_NOT_FOUND

the connection +did not contain a required type setting, ie for DUN connections the connection +must also contain an NMSettingGsm or NMSettingCdma as appropriate +

@@ -127,7 +159,15 @@ const char *

nm_setting_bluetooth_error_quark ()

GQuark              nm_setting_bluetooth_error_quark    (void);

+Registers an error quark for NMSettingBluetooth if necessary.

+
++ + + + +

Returns :

the error quark used for NMSettingBluetooth errors.


@@ -159,6 +201,8 @@ const char *
#define NM_SETTING_BLUETOOTH_TYPE_PANU "panu"

+Connection type describing a connection to devices that support the Bluetooth +NAP (Network Access Point) protocol, which accepts connections via PANU.


@@ -196,14 +240,39 @@ const char *

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

nm_setting_bluetooth_get_bdaddr ()

const GByteArray *  nm_setting_bluetooth_get_bdaddr     (NMSettingBluetooth *setting);

+Gets the Bluetooth address of the remote device which this setting +describes a connection to.

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

setting :

the NMSettingBluetooth +

Returns :

the Bluetooth address

@@ -211,7 +280,24 @@ const char * const char * nm_setting_bluetooth_get_connection_type (NMSettingBluetooth *setting);

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

the NMSettingBluetooth +

Returns :

the type, either NM_SETTING_BLUETOOTH_PANU or NM_SETTING_BLUETOOTH_DUN +
@@ -228,8 +314,8 @@ The Bluetooth address of the device.

The "type" property

  "type"                     gchar*                : Read / Write

-Either 'dun' for Dial-Up Networking connections (not yet supported) or -'panu' for Personal Area Networking connections. +Either 'dun' for Dial-Up Networking connections or 'panu' for Personal +Area Networking connections to devices supporting the NAP profile.

Default value: NULL

diff --git a/docs/libnm-util/html/NMSettingCdma.html b/docs/libnm-util/html/NMSettingCdma.html index 3dc4a712..1c93803d 100644 --- a/docs/libnm-util/html/NMSettingCdma.html +++ b/docs/libnm-util/html/NMSettingCdma.html @@ -105,16 +105,40 @@ networks, including those using CDMA2000/EVDO technology.

enum NMSettingCdmaError

-
typedef enum
-{
+
typedef enum {
 	NM_SETTING_CDMA_ERROR_UNKNOWN = 0,
 	NM_SETTING_CDMA_ERROR_INVALID_PROPERTY,
 	NM_SETTING_CDMA_ERROR_MISSING_PROPERTY,
 	NM_SETTING_CDMA_ERROR_MISSING_SERIAL_SETTING
 } NMSettingCdmaError;
 
-

-

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

NM_SETTING_CDMA_ERROR_UNKNOWN

unknown or unclassified error +

NM_SETTING_CDMA_ERROR_INVALID_PROPERTY

the property was invalid +

NM_SETTING_CDMA_ERROR_MISSING_PROPERTY

the property was missing and is +required +

NM_SETTING_CDMA_ERROR_MISSING_SERIAL_SETTING

the required NMSettingSerial +is missing in the connection +

diff --git a/docs/libnm-util/html/NMSettingConnection.html b/docs/libnm-util/html/NMSettingConnection.html index 2b113d2d..e0085a7c 100644 --- a/docs/libnm-util/html/NMSettingConnection.html +++ b/docs/libnm-util/html/NMSettingConnection.html @@ -577,7 +577,7 @@ the "user" permission type is supported, and pitem

detail :

-unused at this time; must be NULL. [allow-none] +unused at this time; must be NULL. [allow-none] diff --git a/docs/libnm-util/html/NMSettingGsm.html b/docs/libnm-util/html/NMSettingGsm.html index 4a2d7925..439dea0d 100644 --- a/docs/libnm-util/html/NMSettingGsm.html +++ b/docs/libnm-util/html/NMSettingGsm.html @@ -7,7 +7,7 @@ - + @@ -18,7 +18,7 @@ Up Home libnm-util Reference Manual -Next +Next Top @@ -35,13 +35,16 @@

NMSettingGsm

-

NMSettingGsm

+

NMSettingGsm — Describes GSM/3GPP-based mobile broadband properties

Synopsis

-
#define             NM_SETTING_GSM_SETTING_NAME
+
+#include <nm-setting-gsm.h>
+
+#define             NM_SETTING_GSM_SETTING_NAME
 enum                NMSettingGsmError;
 #define             NM_TYPE_SETTING_GSM_ERROR
 #define             NM_SETTING_GSM_ERROR
@@ -107,6 +110,9 @@ const char *        
 

Description

+The NMSettingGsm object is a NMSetting subclass that describes +properties that allow connections to 3GPP-based mobile broadband +networks, including those using GPRS/EDGE and UMTS/HSPA technology.

@@ -121,16 +127,40 @@ const char *

enum NMSettingGsmError

-
typedef enum
-{
+
typedef enum {
 	NM_SETTING_GSM_ERROR_UNKNOWN = 0,
 	NM_SETTING_GSM_ERROR_INVALID_PROPERTY,
 	NM_SETTING_GSM_ERROR_MISSING_PROPERTY,
 	NM_SETTING_GSM_ERROR_MISSING_SERIAL_SETTING
 } NMSettingGsmError;
 
-

-

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

NM_SETTING_GSM_ERROR_UNKNOWN

unknown or unclassified error +

NM_SETTING_GSM_ERROR_INVALID_PROPERTY

the property was invalid +

NM_SETTING_GSM_ERROR_MISSING_PROPERTY

the property was missing and is +required +

NM_SETTING_GSM_ERROR_MISSING_SERIAL_SETTING

the required NMSettingSerial +is missing in the connection +

@@ -153,7 +183,15 @@ const char *

nm_setting_gsm_error_quark ()

GQuark              nm_setting_gsm_error_quark          (void);

+Registers an error quark for NMSettingGsm if necessary.

+
++ + + + +

Returns :

the error quark used for NMSettingGsm errors.

@@ -255,7 +293,43 @@ const char * 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 +

@@ -275,10 +349,93 @@ const char * NMSettingGsmNetworkBand values indicate the allowed frequency bands +the device may use when connecting to this network.

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

NM_SETTING_GSM_BAND_UNKNOWN

unknown or no band specified +

NM_SETTING_GSM_BAND_ANY

any band is allowed +

NM_SETTING_GSM_BAND_EGSM

900 MHz original GSM band +

NM_SETTING_GSM_BAND_DCS

1800 MHz DCS band +

NM_SETTING_GSM_BAND_PCS

US 1900 MHz PCS band +

NM_SETTING_GSM_BAND_G850

US 850 MHz Cellular band +

NM_SETTING_GSM_BAND_U2100

WCDMA 3GPP UMTS 2100 MHz (Class I) +

NM_SETTING_GSM_BAND_U1800

WCDMA 3GPP UMTS 1800 MHz (Class III) +

NM_SETTING_GSM_BAND_U17IV

WCDMA 3GPP AWS 1700/2100 MHz (Class IV) +

NM_SETTING_GSM_BAND_U800

WCDMA 3GPP UMTS 800 MHz (Class VI) +

NM_SETTING_GSM_BAND_U850

WCDMA 3GPP UMTS 850 MHz (Class V) +

NM_SETTING_GSM_BAND_U900

WCDMA 3GPP UMTS 900 MHz (Class VIII) +

NM_SETTING_GSM_BAND_U17IX

WCDMA 3GPP UMTS 1700 MHz (Class IX) +

NM_SETTING_GSM_BAND_U1900

WCDMA 3GPP UMTS 1900 MHz (Class II) +

NM_SETTING_GSM_BAND_U2600

WCDMA 3GPP UMTS 2600 MHz (Class VII, internal) +

@@ -315,70 +472,186 @@ const char *

nm_setting_gsm_new ()

NMSetting *         nm_setting_gsm_new                  (void);

+Creates a new NMSettingGsm object with default values.

+
++ + + + +

Returns :

the new empty NMSettingGsm object

nm_setting_gsm_get_number ()

const char *        nm_setting_gsm_get_number           (NMSettingGsm *setting);
-

-

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

setting :

the NMSettingGsm +

Returns :

the "number" property of the setting

nm_setting_gsm_get_username ()

const char *        nm_setting_gsm_get_username         (NMSettingGsm *setting);
-

-

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

setting :

the NMSettingGsm +

Returns :

the "username" property of the setting

nm_setting_gsm_get_password ()

const char *        nm_setting_gsm_get_password         (NMSettingGsm *setting);
-

-

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

setting :

the NMSettingGsm +

Returns :

the "password" property of the setting

nm_setting_gsm_get_apn ()

const char *        nm_setting_gsm_get_apn              (NMSettingGsm *setting);
-

-

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

setting :

the NMSettingGsm +

Returns :

the "apn" property of the setting

nm_setting_gsm_get_network_id ()

const char *        nm_setting_gsm_get_network_id       (NMSettingGsm *setting);
-

-

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

setting :

the NMSettingGsm +

Returns :

the "network-id" property of the setting

nm_setting_gsm_get_network_type ()

int                 nm_setting_gsm_get_network_type     (NMSettingGsm *setting);
-

-

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

setting :

the NMSettingGsm +

Returns :

the "network-type" property of the setting

nm_setting_gsm_get_allowed_bands ()

guint32             nm_setting_gsm_get_allowed_bands    (NMSettingGsm *setting);
-

-

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

setting :

the NMSettingGsm +

Returns :

the "allowed-bands" property of the setting

nm_setting_gsm_get_pin ()

const char *        nm_setting_gsm_get_pin              (NMSettingGsm *setting);
-

-

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

setting :

the NMSettingGsm +

Returns :

the "pin" property of the setting

nm_setting_gsm_get_home_only ()

gboolean            nm_setting_gsm_get_home_only        (NMSettingGsm *setting);
-

-

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

setting :

the NMSettingGsm +

Returns :

the "home-only" property of the setting

@@ -428,7 +701,8 @@ const char * "allowed-bands" guint : Read / Write / Construct

Bitfield of allowed frequency bands. Note that not all devices allow -frequency band control. +frequency band control. Permitted values are those specified by +NMSettingGsmNetworkBand.

Allowed values: <= 1

Default value: 1

@@ -477,9 +751,9 @@ roaming control of the device is not otherwise possible.
  "network-type"             gint                  : Read / Write / Construct

Network preference to force the device to only use specific network -technologies. The permitted values are: -1: any, 0: 3G only, -1: GPRS/EDGE only, 2: prefer 3G, and 3: prefer 2G. Note that not all -devices allow network preference control. +technologies. Permitted values are those specified by +NMSettingGsmNetworkType. Note that not all devices allow network +preference control.

Allowed values: [G_MAXULONG,3]

Default value: -1

@@ -490,9 +764,9 @@ devices allow network preference control.
  "number"                   gchar*                : Read / Write

Number to dial when establishing a PPP data session with the GSM-based -mobile broadband network. In most cases, leave the number blank and a -number selecting the APN specified in the 'apn' property will be used -automatically when required. +mobile broadband network. Many modems do not require PPP for connections +to the mobile network and thus this property should be left blank, which +allows NetworkManager to select the appropriate settings automatically.

Default value: NULL

@@ -533,7 +807,7 @@ the device.

The "pin-flags" property

  "pin-flags"                guint                 : Read / Write

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

Allowed values: <= 7

Default value: 0

diff --git a/docs/libnm-util/html/NMSettingIP4Config.html b/docs/libnm-util/html/NMSettingIP4Config.html index 6a701adf..488f842a 100644 --- a/docs/libnm-util/html/NMSettingIP4Config.html +++ b/docs/libnm-util/html/NMSettingIP4Config.html @@ -35,13 +35,16 @@

NMSettingIP4Config

-

NMSettingIP4Config

+

NMSettingIP4Config — Describes IPv4 addressing, routing, and name service properties

Synopsis

-
#define             NM_SETTING_IP4_CONFIG_SETTING_NAME
+
+#include <nm-setting-ip4-config.h>
+
+#define             NM_SETTING_IP4_CONFIG_SETTING_NAME
 enum                NMSettingIP4ConfigError;
 #define             NM_TYPE_SETTING_IP4_CONFIG_ERROR
 #define             NM_SETTING_IP4_CONFIG_ERROR
@@ -83,7 +86,7 @@ typedef             
 typedef             NMIP4Route;
 GType               nm_ip4_route_get_type               (void);
 NMIP4Route *        nm_ip4_route_new                    (void);
-NMIP4Route *        nm_ip4_route_dup                    (NMIP4Route *route);
+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,
@@ -201,6 +204,8 @@ const char *        
 

Description

+The NMSettingIP4Config object is a NMSetting subclass that describes +properties related to IPv4 addressing, routing, and Domain Name Service

@@ -215,16 +220,40 @@ const char *

enum NMSettingIP4ConfigError

-
typedef enum
-{
+
typedef enum {
 	NM_SETTING_IP4_CONFIG_ERROR_UNKNOWN = 0,
 	NM_SETTING_IP4_CONFIG_ERROR_INVALID_PROPERTY,
 	NM_SETTING_IP4_CONFIG_ERROR_MISSING_PROPERTY,
 	NM_SETTING_IP4_CONFIG_ERROR_NOT_ALLOWED_FOR_METHOD
 } NMSettingIP4ConfigError;
 
-

-

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

NM_SETTING_IP4_CONFIG_ERROR_UNKNOWN

unknown or unclassified error +

NM_SETTING_IP4_CONFIG_ERROR_INVALID_PROPERTY

the property was invalid +

NM_SETTING_IP4_CONFIG_ERROR_MISSING_PROPERTY

the property was missing and is +required +

NM_SETTING_IP4_CONFIG_ERROR_NOT_ALLOWED_FOR_METHOD

the property's value is +not valid with the given IP4 method +

@@ -247,7 +276,15 @@ const char *

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.


@@ -359,6 +399,8 @@ const char *
#define NM_SETTING_IP4_CONFIG_METHOD_LINK_LOCAL "link-local"

+IPv4 configuration should be automatically configured for link-local-only +operation.


@@ -367,6 +409,8 @@ const char *
#define NM_SETTING_IP4_CONFIG_METHOD_MANUAL "manual"

+All necessary IPv4 configuration (addresses, prefix, DNS, etc) is specified +in the setting's properties.


@@ -375,6 +419,12 @@ const char *
#define NM_SETTING_IP4_CONFIG_METHOD_SHARED "shared"

+This connection specifies configuration that allows other computers to +connect through it to the default network (usually the Internet). The +connection's interface will be assigned a private address, and a DHCP server, +caching DNS server, and Network Address Translation (NAT) functionality will +be started on this connection's interface to allow other devices to connect +through that interface to the default network.


@@ -383,6 +433,7 @@ const char *
#define NM_SETTING_IP4_CONFIG_METHOD_DISABLED "disabled"

+This connection does not use or require IPv4 address and it should be disabled.


@@ -405,28 +456,71 @@ const char *

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

NMIP4Address *      nm_ip4_address_dup                  (NMIP4Address *source);

+Copies a given NMIP4Address object and returns the copy.

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

source :

the NMIP4Address object to copy

Returns :

the copy of the given NMIP4Address copy. [transfer full] +

nm_ip4_address_ref ()

void                nm_ip4_address_ref                  (NMIP4Address *address);

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

@@ -434,14 +528,49 @@ const char * gboolean nm_ip4_address_compare (NMIP4Address *address, NMIP4Address *other);

+Determines if two NMIP4Address objects contain the same values.

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

address :

the NMIP4Address +

other :

the NMIP4Address to compare address to.

Returns :

+TRUE if the objects contain the same values, FALSE if they do not.

nm_ip4_address_get_address ()

guint32             nm_ip4_address_get_address          (NMIP4Address *address);

+Gets the IPv4 address property of this address object.

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

address :

the NMIP4Address +

Returns :

the IPv4 address in network byte order

@@ -449,14 +578,45 @@ const char * void nm_ip4_address_set_address (NMIP4Address *address, guint32 addr);

+Sets the IPv4 address property of this object.

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

address :

the NMIP4Address +

addr :

the IPv4 address in network byte order

nm_ip4_address_get_prefix ()

guint32             nm_ip4_address_get_prefix           (NMIP4Address *address);

+Gets the IPv4 address prefix (ie "24" or "30" etc) property of this address +object.

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

address :

the NMIP4Address +

Returns :

the IPv4 address prefix

@@ -464,14 +624,44 @@ const char * void nm_ip4_address_set_prefix (NMIP4Address *address, guint32 prefix);

+Sets the IPv4 address prefix.

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

address :

the NMIP4Address +

prefix :

the address prefix, a number between 1 and 32 inclusive

nm_ip4_address_get_gateway ()

guint32             nm_ip4_address_get_gateway          (NMIP4Address *address);

+Gets the IPv4 default gateway property of this address object.

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

address :

the NMIP4Address +

Returns :

the IPv4 gateway address in network byte order

@@ -479,7 +669,22 @@ const char * void nm_ip4_address_set_gateway (NMIP4Address *address, guint32 gateway);

+Sets the IPv4 default gateway property of this address object.

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

address :

the NMIP4Address +

gateway :

the IPv4 default gateway in network byte order

@@ -501,28 +706,71 @@ const char *

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 *route);
+
NMIP4Route *        nm_ip4_route_dup                    (NMIP4Route *source);

+Copies a given NMIP4Route object and returns the copy.

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

source :

the NMIP4Route object to copy

Returns :

the copy of the given NMIP4Route copy. [transfer full] +

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.

+
++ + + + +

route :

the NMIP4Route +

@@ -530,14 +778,49 @@ const char * gboolean nm_ip4_route_compare (NMIP4Route *route, NMIP4Route *other);

+Determines if two NMIP4Route objects contain the same values.

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

route :

the NMIP4Route +

other :

the NMIP4Route to compare route to.

Returns :

+TRUE if the objects contain the same values, FALSE if they do not.

nm_ip4_route_get_dest ()

guint32             nm_ip4_route_get_dest               (NMIP4Route *route);

+Gets the IPv4 destination address property of this route object.

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

route :

the NMIP4Route +

Returns :

the IPv4 address in network byte order

@@ -545,14 +828,44 @@ const char * void nm_ip4_route_set_dest (NMIP4Route *route, guint32 dest);

+Sets the IPv4 destination address property of this route object.

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

route :

the NMIP4Route +

dest :

the destination address in network byte order

nm_ip4_route_get_prefix ()

guint32             nm_ip4_route_get_prefix             (NMIP4Route *route);

+Gets the IPv4 prefix (ie "24" or "30" etc) of this route.

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

route :

the NMIP4Route +

Returns :

the IPv4 prefix

@@ -560,14 +873,44 @@ const char * void nm_ip4_route_set_prefix (NMIP4Route *route, guint32 prefix);

+Sets the IPv4 prefix of this route.

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

route :

the NMIP4Route +

prefix :

the prefix, a number between 1 and 32 inclusive

nm_ip4_route_get_next_hop ()

guint32             nm_ip4_route_get_next_hop           (NMIP4Route *route);

+Gets the IPv4 address of the next hop of this route.

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

route :

the NMIP4Route +

Returns :

the IPv4 address in network byte order

@@ -575,14 +918,45 @@ const char * void nm_ip4_route_set_next_hop (NMIP4Route *route, guint32 next_hop);

+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_get_metric ()

guint32             nm_ip4_route_get_metric             (NMIP4Route *route);

+Gets the route metric property of this route object; lower values indicate +"better" or more preferred routes.

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

route :

the NMIP4Route +

Returns :

the route metric

@@ -590,7 +964,23 @@ const char * void nm_ip4_route_set_metric (NMIP4Route *route, guint32 metric);

+Sets the route metric property of this route object; lower values indicate +"better" or more preferred routes.

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

route :

the NMIP4Route +

metric :

the route metric

@@ -627,29 +1017,80 @@ const char *

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

const char *        nm_setting_ip4_config_get_method    (NMSettingIP4Config *setting);
-

-

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

setting :

the NMSettingIP4Config +

Returns :

the "method" property of the setting

nm_setting_ip4_config_get_num_dns ()

guint32             nm_setting_ip4_config_get_num_dns   (NMSettingIP4Config *setting);
-

-

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

setting :

the NMSettingIP4Config +

Returns :

the number of configured DNS servers

nm_setting_ip4_config_get_dns ()

guint32             nm_setting_ip4_config_get_dns       (NMSettingIP4Config *setting,
                                                          guint32 i);
-

-

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

setting :

the NMSettingIP4Config +

i :

index number of the DNS server to return

Returns :

the IPv4 address (network byte order) of the DNS server at index +i +

@@ -657,7 +1098,28 @@ const char * gboolean nm_setting_ip4_config_add_dns (NMSettingIP4Config *setting, guint32 dns);

+Adds a new DNS server to the setting.

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

setting :

the NMSettingIP4Config +

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

@@ -665,22 +1127,58 @@ const char * void nm_setting_ip4_config_remove_dns (NMSettingIP4Config *setting, guint32 i);

+Removes the DNS server at index i.

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

setting :

the NMSettingIP4Config +

i :

index number of the DNS server to remove

nm_setting_ip4_config_clear_dns ()

void                nm_setting_ip4_config_clear_dns     (NMSettingIP4Config *setting);

+Removes all configured DNS servers.

+
++ + + + +

setting :

the NMSettingIP4Config +

nm_setting_ip4_config_get_num_dns_searches ()

guint32             nm_setting_ip4_config_get_num_dns_searches
                                                         (NMSettingIP4Config *setting);
-

-

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

setting :

the NMSettingIP4Config +

Returns :

the number of configured DNS search domains

@@ -688,8 +1186,25 @@ const char * const char * nm_setting_ip4_config_get_dns_search (NMSettingIP4Config *setting, guint32 i); -

-

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

setting :

the NMSettingIP4Config +

i :

index number of the DNS search domain to return

Returns :

the DNS search domain at index i +

@@ -698,7 +1213,28 @@ const char * NMSettingIP4Config *setting, const char *dns_search);

+Adds a new DNS search domain to the setting.

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

setting :

the NMSettingIP4Config +

dns_search :

the search domain to add

Returns :

+TRUE if the DNS search domain was added; FALSE if the search +domain was already known

@@ -707,7 +1243,22 @@ const char * NMSettingIP4Config *setting, guint32 i);

+Removes the DNS search domain at index i.

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

setting :

the NMSettingIP4Config +

i :

index number of the DNS search domain

@@ -715,23 +1266,61 @@ const char * void nm_setting_ip4_config_clear_dns_searches (NMSettingIP4Config *setting);

+Removes all configured DNS search domains.

+
++ + + + +

setting :

the NMSettingIP4Config +

nm_setting_ip4_config_get_num_addresses ()

guint32             nm_setting_ip4_config_get_num_addresses
                                                         (NMSettingIP4Config *setting);
-

-

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

setting :

the NMSettingIP4Config +

Returns :

the number of configured addresses

nm_setting_ip4_config_get_address ()

NMIP4Address *      nm_setting_ip4_config_get_address   (NMSettingIP4Config *setting,
                                                          guint32 i);
-

-

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

setting :

the NMSettingIP4Config +

i :

index number of the address to return

Returns :

the address at index i +

@@ -739,7 +1328,29 @@ const char * 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.

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

setting :

the NMSettingIP4Config +

address :

the new address to add

Returns :

+TRUE if the address was added; FALSE if the address was already +known.

@@ -748,7 +1359,22 @@ const char * NMSettingIP4Config *setting, guint32 i);

+Removes the address at index i.

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

setting :

the NMSettingIP4Config +

i :

index number of the address to remove

@@ -756,23 +1382,61 @@ const char * void nm_setting_ip4_config_clear_addresses (NMSettingIP4Config *setting);

+Removes all configured addresses.

+
++ + + + +

setting :

the NMSettingIP4Config +

nm_setting_ip4_config_get_num_routes ()

guint32             nm_setting_ip4_config_get_num_routes
                                                         (NMSettingIP4Config *setting);
-

-

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

setting :

the NMSettingIP4Config +

Returns :

the number of configured routes

nm_setting_ip4_config_get_route ()

NMIP4Route *        nm_setting_ip4_config_get_route     (NMSettingIP4Config *setting,
                                                          guint32 i);
-

-

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

setting :

the NMSettingIP4Config +

i :

index number of the route to return

Returns :

the route at index i +

@@ -780,7 +1444,28 @@ const char * gboolean nm_setting_ip4_config_add_route (NMSettingIP4Config *setting, NMIP4Route *route);

+Adds a new IPv4 route and associated information to the setting. The +given route is duplicated internally and is not changed by this function.

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

setting :

the NMSettingIP4Config +

route :

the route to add

Returns :

+TRUE if the route was added; FALSE if the route was already known.

@@ -788,14 +1473,38 @@ const char * void nm_setting_ip4_config_remove_route (NMSettingIP4Config *setting, guint32 i);

+Removes the route at index i.

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

setting :

the NMSettingIP4Config +

i :

index number of the route

nm_setting_ip4_config_clear_routes ()

void                nm_setting_ip4_config_clear_routes  (NMSettingIP4Config *setting);

+Removes all configured routes.

+
++ + + + +

setting :

the NMSettingIP4Config +

@@ -803,7 +1512,25 @@ const char * gboolean nm_setting_ip4_config_get_ignore_auto_routes (NMSettingIP4Config *setting);

+Returns the value contained in the "ignore-auto-routes" +property.

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

setting :

the NMSettingIP4Config +

Returns :

+TRUE if automatically configured (ie via DHCP) routes should be +ignored.

@@ -811,7 +1538,25 @@ const char * gboolean nm_setting_ip4_config_get_ignore_auto_dns (NMSettingIP4Config *setting);

+Returns the value contained in the "ignore-auto-dns" +property.

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

setting :

the NMSettingIP4Config +

Returns :

+TRUE if automatically configured (ie via DHCP) DNS information +should be ignored.

@@ -819,7 +1564,24 @@ const char * const char * nm_setting_ip4_config_get_dhcp_client_id (NMSettingIP4Config *setting);

+Returns the value contained in the "dhcp-client-id" +property.

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

setting :

the NMSettingIP4Config +

Returns :

the configured Client ID to send to the DHCP server when requesting +addresses via DHCP.

@@ -827,7 +1589,26 @@ const char * gboolean nm_setting_ip4_config_get_dhcp_send_hostname (NMSettingIP4Config *setting);

+Returns the value contained in the "dhcp-send-hostname" +property.

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

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.

@@ -835,7 +1616,23 @@ const char * const char * nm_setting_ip4_config_get_dhcp_hostname (NMSettingIP4Config *setting);

+Returns the value contained in the "dhcp-hostname" +property.

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

setting :

the NMSettingIP4Config +

Returns :

the configured hostname to send to the DHCP server

@@ -843,14 +1640,50 @@ const char * gboolean nm_setting_ip4_config_get_never_default (NMSettingIP4Config *setting);

+Returns the value contained in the "never-default" +property.

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

setting :

the NMSettingIP4Config +

Returns :

+TRUE if this connection should never be the default connection +for IPv4 addressing

nm_setting_ip4_config_get_may_fail ()

gboolean            nm_setting_ip4_config_get_may_fail  (NMSettingIP4Config *setting);

+Returns the value contained in the "may-fail" +property.

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

setting :

the NMSettingIP4Config +

Returns :

+TRUE if this connection doesn't require IPv4 addressing to complete +for the connection to succeed.
diff --git a/docs/libnm-util/html/NMSettingIP6Config.html b/docs/libnm-util/html/NMSettingIP6Config.html index 060c80fe..0fe4cc5b 100644 --- a/docs/libnm-util/html/NMSettingIP6Config.html +++ b/docs/libnm-util/html/NMSettingIP6Config.html @@ -35,13 +35,16 @@

NMSettingIP6Config

-

NMSettingIP6Config

+

NMSettingIP6Config — Describes IPv6 addressing, routing, and name service properties

Synopsis

-
#define             NM_SETTING_IP6_CONFIG_SETTING_NAME
+
+#include <nm-setting-ip6-config.h>
+
+#define             NM_SETTING_IP6_CONFIG_SETTING_NAME
 enum                NMSettingIP6ConfigError;
 #define             NM_TYPE_SETTING_IP6_CONFIG_ERROR
 #define             NM_SETTING_IP6_CONFIG_ERROR
@@ -77,11 +80,11 @@ const struct in6_addr * guint32 prefix);
 const struct in6_addr * nm_ip6_address_get_gateway      (NMIP6Address *address);
 void                nm_ip6_address_set_gateway          (NMIP6Address *address,
-                                                         const struct in6_addr *gw);
+                                                         const struct in6_addr *gateway);
 typedef             NMIP6Route;
 GType               nm_ip6_route_get_type               (void);
 NMIP6Route *            nm_ip6_route_new                (void);
-NMIP6Route *            nm_ip6_route_dup                (NMIP6Route *route);
+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,
@@ -192,6 +195,8 @@ const char *            
 

Description

+The NMSettingIP6Config object is a NMSetting subclass that describes +properties related to IPv6 addressing, routing, and Domain Name Service

@@ -206,16 +211,40 @@ const char *

enum NMSettingIP6ConfigError

-
typedef enum
-{
+
typedef enum {
 	NM_SETTING_IP6_CONFIG_ERROR_UNKNOWN = 0,
 	NM_SETTING_IP6_CONFIG_ERROR_INVALID_PROPERTY,
 	NM_SETTING_IP6_CONFIG_ERROR_MISSING_PROPERTY,
 	NM_SETTING_IP6_CONFIG_ERROR_NOT_ALLOWED_FOR_METHOD
 } NMSettingIP6ConfigError;
 
-

-

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

NM_SETTING_IP6_CONFIG_ERROR_UNKNOWN

unknown or unclassified error +

NM_SETTING_IP6_CONFIG_ERROR_INVALID_PROPERTY

the property was invalid +

NM_SETTING_IP6_CONFIG_ERROR_MISSING_PROPERTY

the property was missing and is +required +

NM_SETTING_IP6_CONFIG_ERROR_NOT_ALLOWED_FOR_METHOD

the property's value is +not valid with the given IPv6 method +

@@ -238,7 +267,15 @@ const char *

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.


@@ -326,6 +365,9 @@ const char *
#define NM_SETTING_IP6_CONFIG_METHOD_AUTO "auto"

+IPv6 configuration should be automatically determined via a method appropriate +for the hardware interface, ie router advertisements, DHCP, or PPP or some +other device-specific manner.


@@ -334,6 +376,8 @@ const char *
#define NM_SETTING_IP6_CONFIG_METHOD_DHCP "dhcp"

+IPv6 configuration should be automatically determined via DHCPv6 only and +router advertisements should be ignored.


@@ -342,6 +386,8 @@ const char *
#define NM_SETTING_IP6_CONFIG_METHOD_LINK_LOCAL "link-local"

+IPv6 configuration should be automatically configured for link-local-only +operation.


@@ -350,6 +396,8 @@ const char *
#define NM_SETTING_IP6_CONFIG_METHOD_MANUAL "manual"

+All necessary IPv6 configuration (addresses, prefix, DNS, etc) is specified +in the setting's properties.


@@ -358,6 +406,13 @@ const char *
#define NM_SETTING_IP6_CONFIG_METHOD_SHARED "shared"

+This connection specifies configuration that allows other computers to +connect through it to the default network (usually the Internet). The +connection's interface will be assigned a private address, and router +advertisements, a caching DNS server, and Network Address Translation (NAT) +functionality will be started on this connection's interface to allow other +devices to connect through that interface to the default network. (not yet +supported for IPv6)


@@ -380,28 +435,71 @@ const char *

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 +

@@ -409,14 +507,50 @@ const char * gboolean nm_ip6_address_compare (NMIP6Address *address, NMIP6Address *other);

+Determines if two NMIP6Address objects contain the same values.

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

address :

the NMIP6Address +

other :

the NMIP6Address to compare address to.

Returns :

+TRUE if the objects contain the same values, FALSE if they do not.

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.

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

address :

the NMIP6Address +

Returns :

the IPv6 address. [transfer none] +

@@ -424,14 +558,44 @@ const char * void nm_ip6_address_set_address (NMIP6Address *address, const struct in6_addr *addr);

+Sets the IPv6 address property of this object.

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

address :

the NMIP6Address +

addr :

the IPv6 address

nm_ip6_address_get_prefix ()

guint32             nm_ip6_address_get_prefix           (NMIP6Address *address);

+Gets the IPv6 address prefix property of this address object.

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

address :

the NMIP6Address +

Returns :

the IPv6 address prefix

@@ -439,22 +603,68 @@ const char * void nm_ip6_address_set_prefix (NMIP6Address *address, guint32 prefix);

+Sets the IPv6 address prefix.

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

address :

the NMIP6Address +

prefix :

the address prefix, a number between 0 and 128 inclusive

nm_ip6_address_get_gateway ()

const struct in6_addr * nm_ip6_address_get_gateway      (NMIP6Address *address);

+Gets the IPv6 default gateway property of this address object.

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

address :

the NMIP6Address +

Returns :

the IPv6 gateway address. [transfer none] +

nm_ip6_address_set_gateway ()

void                nm_ip6_address_set_gateway          (NMIP6Address *address,
-                                                         const struct in6_addr *gw);
+ const struct in6_addr *gateway);

+Sets the IPv6 default gateway property of this address object.

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

address :

the NMIP6Address +

gateway :

the IPv6 default gateway

@@ -476,28 +686,71 @@ const char *

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 *route);
+
NMIP6Route *            nm_ip6_route_dup                (NMIP6Route *source);

+Copies a given NMIP6Route object and returns the copy.

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

source :

the NMIP6Route object to copy

Returns :

the copy of the given NMIP6Route copy. [transfer full] +

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.

+
++ + + + +

route :

the NMIP6Route +

@@ -505,14 +758,49 @@ const char * gboolean nm_ip6_route_compare (NMIP6Route *route, NMIP6Route *other);

+Determines if two NMIP6Route objects contain the same values.

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

route :

the NMIP6Route +

other :

the NMIP6Route to compare route to.

Returns :

+TRUE if the objects contain the same values, FALSE if they do not.

nm_ip6_route_get_dest ()

const struct in6_addr * nm_ip6_route_get_dest           (NMIP6Route *route);

+Gets the IPv6 destination address property of this route object.

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

route :

the NMIP6Route +

Returns :

the IPv6 address

@@ -520,14 +808,44 @@ const char * void nm_ip6_route_set_dest (NMIP6Route *route, const struct in6_addr *dest);

+Sets the IPv6 destination address property of this route object.

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

route :

the NMIP6Route +

dest :

the destination address

nm_ip6_route_get_prefix ()

guint32             nm_ip6_route_get_prefix             (NMIP6Route *route);

+Gets the IPv6 prefix (ie "32" or "64" etc) of this route.

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

route :

the NMIP6Route +

Returns :

the IPv6 prefix

@@ -535,14 +853,44 @@ const char * void nm_ip6_route_set_prefix (NMIP6Route *route, guint32 prefix);

+Sets the IPv6 prefix of this route.

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

route :

the NMIP6Route +

prefix :

the prefix, a number between 1 and 128 inclusive

nm_ip6_route_get_next_hop ()

const struct in6_addr * nm_ip6_route_get_next_hop       (NMIP6Route *route);

+Gets the IPv6 address of the next hop of this route.

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

route :

the NMIP6Route +

Returns :

the IPv6 address

@@ -550,14 +898,45 @@ const char * void nm_ip6_route_set_next_hop (NMIP6Route *route, const struct in6_addr *next_hop);

+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_get_metric ()

guint32             nm_ip6_route_get_metric             (NMIP6Route *route);

+Gets the route metric property of this route object; lower values indicate +"better" or more preferred routes.

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

route :

the NMIP6Route +

Returns :

the route metric

@@ -565,7 +944,23 @@ const char * void nm_ip6_route_set_metric (NMIP6Route *route, guint32 metric);

+Sets the route metric property of this route object; lower values indicate +"better" or more preferred routes.

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

route :

the NMIP6Route +

metric :

the route metric

@@ -602,30 +997,80 @@ const char *

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

const char *            nm_setting_ip6_config_get_method
                                                         (NMSettingIP6Config *setting);
-

-

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

setting :

the NMSettingIP6Config +

Returns :

the "method" property of the setting

nm_setting_ip6_config_get_num_dns ()

guint32             nm_setting_ip6_config_get_num_dns   (NMSettingIP6Config *setting);
-

-

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

setting :

the NMSettingIP6Config +

Returns :

the number of configured DNS servers

nm_setting_ip6_config_get_dns ()

const struct in6_addr * nm_setting_ip6_config_get_dns   (NMSettingIP6Config *setting,
                                                          guint32 i);
-

-

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

setting :

the NMSettingIP6Config +

i :

index number of the DNS server to return

Returns :

the IPv6 address of the DNS server at index i. [transfer none] +

@@ -633,7 +1078,28 @@ const char * gboolean nm_setting_ip6_config_add_dns (NMSettingIP6Config *setting, const struct in6_addr *dns);

+Adds a new DNS server to the setting.

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

setting :

the NMSettingIP6Config +

dns :

the IPv6 address of the DNS server to add

Returns :

+TRUE if the DNS server was added; FALSE if the server was already +known

@@ -641,22 +1107,58 @@ const char * void nm_setting_ip6_config_remove_dns (NMSettingIP6Config *setting, guint32 i);

+Removes the DNS server at index i.

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

setting :

the NMSettingIP6Config +

i :

index number of the DNS server to remove

nm_setting_ip6_config_clear_dns ()

void                nm_setting_ip6_config_clear_dns     (NMSettingIP6Config *setting);

+Removes all configured DNS servers.

+
++ + + + +

setting :

the NMSettingIP6Config +

nm_setting_ip6_config_get_num_dns_searches ()

guint32             nm_setting_ip6_config_get_num_dns_searches
                                                         (NMSettingIP6Config *setting);
-

-

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

setting :

the NMSettingIP6Config +

Returns :

the number of configured DNS search domains

@@ -664,8 +1166,25 @@ const char * 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 +

@@ -674,7 +1193,28 @@ const char * NMSettingIP6Config *setting, const char *dns_search);

+Adds a new DNS search domain to the setting.

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

setting :

the NMSettingIP6Config +

dns_search :

the search domain to add

Returns :

+TRUE if the DNS search domain was added; FALSE if the search +domain was already known

@@ -683,7 +1223,22 @@ const char * NMSettingIP6Config *setting, guint32 i);

+Removes the DNS search domain at index i.

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

setting :

the NMSettingIP6Config +

i :

index number of the DNS search domain

@@ -691,15 +1246,36 @@ const char * 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);
-

-

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

setting :

the NMSettingIP6Config +

Returns :

the number of configured addresses

@@ -707,8 +1283,25 @@ const char * NMIP6Address * nm_setting_ip6_config_get_address (NMSettingIP6Config *setting, guint32 i); -

-

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

setting :

the NMSettingIP6Config +

i :

index number of the address to return

Returns :

the address at index i +

@@ -716,7 +1309,29 @@ const char * 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.

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

setting :

the NMSettingIP6Config +

address :

the new address to add

Returns :

+TRUE if the address was added; FALSE if the address was already +known.

@@ -725,7 +1340,22 @@ const char * NMSettingIP6Config *setting, guint32 i);

+Removes the address at index i.

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

setting :

the NMSettingIP6Config +

i :

index number of the address to remove

@@ -733,23 +1363,61 @@ const char * void nm_setting_ip6_config_clear_addresses (NMSettingIP6Config *setting);

+Removes all configured addresses.

+
++ + + + +

setting :

the NMSettingIP6Config +

nm_setting_ip6_config_get_num_routes ()

guint32             nm_setting_ip6_config_get_num_routes
                                                         (NMSettingIP6Config *setting);
-

-

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

setting :

the NMSettingIP6Config +

Returns :

the number of configured routes

nm_setting_ip6_config_get_route ()

NMIP6Route *            nm_setting_ip6_config_get_route (NMSettingIP6Config *setting,
                                                          guint32 i);
-

-

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

setting :

the NMSettingIP6Config +

i :

index number of the route to return

Returns :

the route at index i +

@@ -757,7 +1425,28 @@ const char * gboolean nm_setting_ip6_config_add_route (NMSettingIP6Config *setting, NMIP6Route *route);

+Adds a new IPv6 route and associated information to the setting. The +given route is duplicated internally and is not changed by this function.

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

setting :

the NMSettingIP6Config +

route :

the route to add

Returns :

+TRUE if the route was added; FALSE if the route was already known.

@@ -765,14 +1454,38 @@ const char * void nm_setting_ip6_config_remove_route (NMSettingIP6Config *setting, guint32 i);

+Removes the route at index i.

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

setting :

the NMSettingIP6Config +

i :

index number of the route

nm_setting_ip6_config_clear_routes ()

void                nm_setting_ip6_config_clear_routes  (NMSettingIP6Config *setting);

+Removes all configured routes.

+
++ + + + +

setting :

the NMSettingIP6Config +

@@ -780,7 +1493,25 @@ const char * gboolean nm_setting_ip6_config_get_ignore_auto_routes (NMSettingIP6Config *setting);

+Returns the value contained in the "ignore-auto-routes" +property.

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

setting :

the NMSettingIP6Config +

Returns :

+TRUE if automatically configured (ie via DHCP) routes should be +ignored.

@@ -788,7 +1519,25 @@ const char * gboolean nm_setting_ip6_config_get_ignore_auto_dns (NMSettingIP6Config *setting);

+Returns the value contained in the "ignore-auto-dns" +property.

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

setting :

the NMSettingIP6Config +

Returns :

+TRUE if automatically configured (ie via DHCP or router +advertisements) DNS information should be ignored.

@@ -796,14 +1545,50 @@ const char * gboolean nm_setting_ip6_config_get_never_default (NMSettingIP6Config *setting);

+Returns the value contained in the "never-default" +property.

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

setting :

the NMSettingIP6Config +

Returns :

+TRUE if this connection should never be the default connection +for IPv6 addressing

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.

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

setting :

the NMSettingIP6Config +

Returns :

+TRUE if this connection doesn't require IPv6 addressing to complete +for the connection to succeed.
@@ -886,7 +1671,7 @@ example, in IPv4-only networks, setting this property to TRUE allows the overall network configuration to succeed if IPv6 configuration fails but IPv4 configuration completes successfully.

-

Default value: FALSE

+

Default value: TRUE


diff --git a/docs/libnm-util/html/NMSettingOlpcMesh.html b/docs/libnm-util/html/NMSettingOlpcMesh.html index 43ea8d27..03a1fd22 100644 --- a/docs/libnm-util/html/NMSettingOlpcMesh.html +++ b/docs/libnm-util/html/NMSettingOlpcMesh.html @@ -6,7 +6,7 @@ - + @@ -14,7 +14,7 @@ - + diff --git a/docs/libnm-util/html/NMSettingPPP.html b/docs/libnm-util/html/NMSettingPPP.html index eade54a5..ea9a7c78 100644 --- a/docs/libnm-util/html/NMSettingPPP.html +++ b/docs/libnm-util/html/NMSettingPPP.html @@ -35,13 +35,17 @@

NMSettingPPP

-

NMSettingPPP

+

NMSettingPPP — Describes connection properties for devices/networks +that require PPP to deliver IP capability

Synopsis

-
#define             NM_SETTING_PPP_SETTING_NAME
+
+#include <nm-setting-ppp.h>
+
+#define             NM_SETTING_PPP_SETTING_NAME
 enum                NMSettingPPPError;
 #define             NM_TYPE_SETTING_PPP_ERROR
 #define             NM_SETTING_PPP_ERROR
@@ -127,6 +131,9 @@ enum                N
 

Description

+The NMSettingPPP object is a NMSetting subclass that describes properties +necessary for connection to networks that require PPP transport, like PPPoE +cable and DSL modems and some mobile broadband devices.

@@ -141,16 +148,40 @@ enum N

enum NMSettingPPPError

-
typedef enum
-{
+
typedef enum {
 	NM_SETTING_PPP_ERROR_UNKNOWN = 0,
 	NM_SETTING_PPP_ERROR_INVALID_PROPERTY,
 	NM_SETTING_PPP_ERROR_MISSING_PROPERTY,
 	NM_SETTING_PPP_ERROR_REQUIRE_MPPE_NOT_ALLOWED
 } NMSettingPPPError;
 
-

-

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

NM_SETTING_PPP_ERROR_UNKNOWN

unknown or unclassified error +

NM_SETTING_PPP_ERROR_INVALID_PROPERTY

the property was invalid +

NM_SETTING_PPP_ERROR_MISSING_PROPERTY

the property was missing and is +required +

NM_SETTING_PPP_ERROR_REQUIRE_MPPE_NOT_ALLOWED

requiring MPPE is not compatible +with other setting configuration parameters +

@@ -173,7 +204,15 @@ enum N

nm_setting_ppp_error_quark ()

GQuark              nm_setting_ppp_error_quark          (void);

+Registers an error quark for NMSettingPPP if necessary.

+
++ + + + +

Returns :

the error quark used for NMSettingPPP errors.

@@ -354,7 +393,16 @@ enum N

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

diff --git a/docs/libnm-util/html/NMSettingPPPOE.html b/docs/libnm-util/html/NMSettingPPPOE.html index 87669254..6ea0af49 100644 --- a/docs/libnm-util/html/NMSettingPPPOE.html +++ b/docs/libnm-util/html/NMSettingPPPOE.html @@ -35,13 +35,16 @@

NMSettingPPPOE

-

NMSettingPPPOE

+

NMSettingPPPOE — Describes PPPoE connection properties

Synopsis

-
#define             NM_SETTING_PPPOE_SETTING_NAME
+
+#include <nm-setting-pppoe.h>
+
+#define             NM_SETTING_PPPOE_SETTING_NAME
 enum                NMSettingPPPOEError;
 #define             NM_TYPE_SETTING_PPPOE_ERROR
 #define             NM_SETTING_PPPOE_ERROR
@@ -85,6 +88,9 @@ const char *        
 

Description

+The NMSettingPPPOE object is a NMSetting subclass that describes +properties necessary for connection to networks that require PPPoE connections +to provide IP transport, for example cable or DSL modems.

@@ -99,16 +105,40 @@ const char *

enum NMSettingPPPOEError

-
typedef enum
-{
+
typedef enum {
 	NM_SETTING_PPPOE_ERROR_UNKNOWN = 0,
 	NM_SETTING_PPPOE_ERROR_INVALID_PROPERTY,
 	NM_SETTING_PPPOE_ERROR_MISSING_PROPERTY,
 	NM_SETTING_PPPOE_ERROR_MISSING_PPP_SETTING
 } NMSettingPPPOEError;
 
-

-

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

NM_SETTING_PPPOE_ERROR_UNKNOWN

unknown or unclassified error +

NM_SETTING_PPPOE_ERROR_INVALID_PROPERTY

the property was invalid +

NM_SETTING_PPPOE_ERROR_MISSING_PROPERTY

the property was missing and is +required +

NM_SETTING_PPPOE_ERROR_MISSING_PPP_SETTING

the connection +did not contain a required PPP setting for PPP related options +

@@ -131,7 +161,15 @@ const char *

nm_setting_pppoe_error_quark ()

GQuark              nm_setting_pppoe_error_quark        (void);

+Registers an error quark for NMSettingPPPOE if necessary.

+
++ + + + +

Returns :

the error quark used for NMSettingPPPOE errors.

@@ -200,14 +238,35 @@ const char *

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

nm_setting_pppoe_get_service ()

const char *        nm_setting_pppoe_get_service        (NMSettingPPPOE *setting);
-

-

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

setting :

the NMSettingPPPOE +

Returns :

the "password" property of the setting

diff --git a/docs/libnm-util/html/NMSettingSerial.html b/docs/libnm-util/html/NMSettingSerial.html index 5e5483ec..0340eb26 100644 --- a/docs/libnm-util/html/NMSettingSerial.html +++ b/docs/libnm-util/html/NMSettingSerial.html @@ -35,13 +35,17 @@

NMSettingSerial

-

NMSettingSerial

+

NMSettingSerial — Describes connection properties for devices that use +serial communications

Synopsis

-
#define             NM_SETTING_SERIAL_SETTING_NAME
+
+#include <nm-setting-serial.h>
+
+#define             NM_SETTING_SERIAL_SETTING_NAME
 enum                NMSettingSerialError;
 #define             NM_TYPE_SETTING_SERIAL_ERROR
 #define             NM_SETTING_SERIAL_ERROR
@@ -87,6 +91,9 @@ enum                
 

Description

+The NMSettingSerial object is a NMSetting subclass that describes +properties necessary for connections that may use serial communications, +such as mobile broadband or analog telephone connections.

@@ -101,16 +108,40 @@ enum

enum NMSettingSerialError

-
typedef enum
-{
+
typedef enum {
 	NM_SETTING_SERIAL_ERROR_UNKNOWN = 0,
 	NM_SETTING_SERIAL_ERROR_INVALID_PROPERTY,
 	NM_SETTING_SERIAL_ERROR_MISSING_PROPERTY,
 	NM_SETTING_SERIAL_ERROR_MISSING_PPP_SETTING
 } NMSettingSerialError;
 
-

-

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

NM_SETTING_SERIAL_ERROR_UNKNOWN

unknown or unclassified error +

NM_SETTING_SERIAL_ERROR_INVALID_PROPERTY

the property was invalid +

NM_SETTING_SERIAL_ERROR_MISSING_PROPERTY

the property was missing and is +required +

NM_SETTING_SERIAL_ERROR_MISSING_PPP_SETTING

one of the properties of the +setting requires the connection to contain an NMSettingPPP setting +

@@ -133,7 +164,15 @@ enum

nm_setting_serial_error_quark ()

GQuark              nm_setting_serial_error_quark       (void);

+Registers an error quark for NMSettingSerial if necessary.

+
++ + + + +

Returns :

the error quark used for NMSettingSerial errors.

@@ -210,42 +249,111 @@ enum

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

nm_setting_serial_get_baud ()

guint               nm_setting_serial_get_baud          (NMSettingSerial *setting);
-

-

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

setting :

the NMSettingSerial +

Returns :

the "baud" property of the setting

nm_setting_serial_get_bits ()

guint               nm_setting_serial_get_bits          (NMSettingSerial *setting);
-

-

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

setting :

the NMSettingSerial +

Returns :

the "bits" property of the setting

nm_setting_serial_get_parity ()

char                nm_setting_serial_get_parity        (NMSettingSerial *setting);
-

-

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

setting :

the NMSettingSerial +

Returns :

the "parity" property of the setting

nm_setting_serial_get_stopbits ()

guint               nm_setting_serial_get_stopbits      (NMSettingSerial *setting);
-

-

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

setting :

the NMSettingSerial +

Returns :

the "stopbits" property of the setting

nm_setting_serial_get_send_delay ()

guint64             nm_setting_serial_get_send_delay    (NMSettingSerial *setting);
-

-

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

setting :

the NMSettingSerial +

Returns :

the "send-delay" property of the setting
diff --git a/docs/libnm-util/html/NMSettingVPN.html b/docs/libnm-util/html/NMSettingVPN.html index c2e4ce52..1c6264d0 100644 --- a/docs/libnm-util/html/NMSettingVPN.html +++ b/docs/libnm-util/html/NMSettingVPN.html @@ -35,13 +35,16 @@

NMSettingVPN

-

NMSettingVPN

+

NMSettingVPN — Describes connection properties for Virtual Private Networks

Synopsis

-
#define             NM_SETTING_VPN_SETTING_NAME
+
+#include <nm-setting-vpn.h>
+
+#define             NM_SETTING_VPN_SETTING_NAME
 enum                NMSettingVpnError;
 #define             NM_TYPE_SETTING_VPN_ERROR
 #define             NM_SETTING_VPN_ERROR
@@ -105,6 +108,13 @@ const char *        
 

Description

+The NMSettingVPN object is a NMSetting subclass that describes properties +necessary for connection to Virtual Private Networks. NetworkManager uses +a plugin architecture to allow easier use of new VPN types, and this +setting abstracts the configuration for those plugins. Since the configuration +options are only known to the VPN plugins themselves, the VPN configuration +options are stored as key/value pairs of strings rather than GObject +properties.

@@ -119,15 +129,33 @@ const char *

enum NMSettingVpnError

-
typedef enum
-{
+
typedef enum {
 	NM_SETTING_VPN_ERROR_UNKNOWN = 0,
 	NM_SETTING_VPN_ERROR_INVALID_PROPERTY,
 	NM_SETTING_VPN_ERROR_MISSING_PROPERTY,
 } NMSettingVpnError;
 
-

-

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

NM_SETTING_VPN_ERROR_UNKNOWN

unknown or unclassified error +

NM_SETTING_VPN_ERROR_INVALID_PROPERTY

the property was invalid +

NM_SETTING_VPN_ERROR_MISSING_PROPERTY

the property was missing and is +required +

@@ -150,7 +178,15 @@ const char *

nm_setting_vpn_error_quark ()

GQuark              nm_setting_vpn_error_quark          (void);

+Registers an error quark for NMSettingVPN if necessary.

+
++ + + + +

Returns :

the error quark used for NMSettingVPN errors.

@@ -213,8 +249,25 @@ const char * void (*NMVPNIterFunc) (const char *key, const char *value, gpointer user_data);
-

-

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

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

@@ -228,21 +281,58 @@ const char *

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

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

setting :

the NMSettingVPN +

Returns :

the VPN plugin's service name

nm_setting_vpn_get_user_name ()

const char *        nm_setting_vpn_get_user_name        (NMSettingVPN *setting);
-

-

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

setting :

the NMSettingVPN +

Returns :

the "user-name" property of the setting

@@ -251,7 +341,30 @@ const char * 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.

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

setting :

the NMSettingVPN +

key :

a name that uniquely identifies the given value item +

item :

the value to be referenced by key +

@@ -259,7 +372,27 @@ const char * const char * nm_setting_vpn_get_data_item (NMSettingVPN *setting, const char *key);

+Retrieves the data item of a key/value relationship previously established +by nm_setting_vpn_add_data_item().

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

setting :

the NMSettingVPN +

key :

the name of the data item to retrieve

Returns :

the data item, if any

@@ -267,7 +400,23 @@ const char * void nm_setting_vpn_remove_data_item (NMSettingVPN *setting, const char *key);

+Deletes a key/value relationship previously established by +nm_setting_vpn_add_data_item().

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

setting :

the NMSettingVPN +

key :

the name of the data item to remove

@@ -308,7 +457,29 @@ during iteration will not be part of the iteration. const char *key, const char *secret);

+Establishes a relationship between key and secret internally in the +setting which may be retrieved later.

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

setting :

the NMSettingVPN +

key :

a name that uniquely identifies the given secret secret +

secret :

the secret to be referenced by key +

@@ -316,7 +487,27 @@ during iteration will not be part of the iteration.
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().

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

setting :

the NMSettingVPN +

key :

the name of the secret to retrieve

Returns :

the secret, if any

@@ -324,7 +515,23 @@ during iteration will not be part of the iteration.
void                nm_setting_vpn_remove_secret        (NMSettingVPN *setting,
                                                          const char *key);

+Deletes a key/value relationship previously established by +nm_setting_vpn_add_secret().

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

setting :

the NMSettingVPN +

key :

the name of the secret to remove

@@ -393,7 +600,7 @@ plugin.

The "user-name" property

  "user-name"                gchar*                : Read / Write
-

User name of the currently logged in user for connections provided by the user settings service. This name is provided to the VPN plugin to use in lieu of a custom username provided by that VPN plugins specific configuration. The VPN plugin itself decides which user name to use.

+

If the VPN connection requires a user name for authentication, that name should be provided here. If the connection is available to more than one user, and the VPN requires each user to supply a different name, then leave this property empty. If this property is empty, NetworkManager will automatically supply the username of the user which requested the VPN connection.

Default value: NULL

diff --git a/docs/libnm-util/html/NMSettingWimax.html b/docs/libnm-util/html/NMSettingWimax.html new file mode 100644 index 00000000..919c9b0a --- /dev/null +++ b/docs/libnm-util/html/NMSettingWimax.html @@ -0,0 +1,288 @@ + + + + +NMSettingWimax + + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+

NMSettingWimax

+

NMSettingWimax — Describes 802.16e Mobile WiMAX connection properties

+
+ +
+

Object Hierarchy

+
+  GEnum
+   +----NMSettingWimaxError
+
+
+  GObject
+   +----NMSetting
+         +----NMSettingWimax
+
+
+
+

Properties

+
+  "mac-address"              GArray_guchar_*       : Read / Write
+  "network-name"             gchar*                : Read / Write
+
+
+
+

Description

+

+The NMSettingWimax object is a NMSetting subclass that describes properties +necessary for connection to 802.16e Mobile WiMAX networks. +

+
+
+

Details

+
+

NM_SETTING_WIMAX_SETTING_NAME

+
#define NM_SETTING_WIMAX_SETTING_NAME "wimax"
+
+

+

+
+
+
+

enum NMSettingWimaxError

+
typedef enum {
+	NM_SETTING_WIMAX_ERROR_UNKNOWN = 0,
+	NM_SETTING_WIMAX_ERROR_INVALID_PROPERTY,
+	NM_SETTING_WIMAX_ERROR_MISSING_PROPERTY
+} NMSettingWimaxError;
+
+
++ + + + + + + + + + + + + + +

NM_SETTING_WIMAX_ERROR_UNKNOWN

unknown or unclassified error +

NM_SETTING_WIMAX_ERROR_INVALID_PROPERTY

the property was invalid +

NM_SETTING_WIMAX_ERROR_MISSING_PROPERTY

the property was missing and is +required +
+
+
+
+

NM_TYPE_SETTING_WIMAX_ERROR

+
#define NM_TYPE_SETTING_WIMAX_ERROR (nm_setting_wimax_error_get_type ()) 
+
+

+

+
+
+
+

NM_SETTING_WIMAX_ERROR

+
#define NM_SETTING_WIMAX_ERROR nm_setting_wimax_error_quark ()
+
+

+

+
+
+
+

nm_setting_wimax_error_quark ()

+
GQuark              nm_setting_wimax_error_quark        (void);
+

+Registers an error quark for NMSettingWimax if necessary. +

+
++ + + + +

Returns :

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

NM_SETTING_WIMAX_NETWORK_NAME

+
#define NM_SETTING_WIMAX_NETWORK_NAME "network-name"
+
+

+

+
+
+
+

NM_SETTING_WIMAX_MAC_ADDRESS

+
#define NM_SETTING_WIMAX_MAC_ADDRESS  "mac-address"
+
+

+

+
+
+
+

NMSettingWimax

+
typedef struct _NMSettingWimax NMSettingWimax;
+

+

+
+
+
+

NMSettingWimaxClass

+
typedef struct {
+	NMSettingClass parent;
+} NMSettingWimaxClass;
+
+

+

+
+
+
+

nm_setting_wimax_get_type ()

+
GType               nm_setting_wimax_get_type           (void);
+

+

+
+
+
+

nm_setting_wimax_new ()

+
NMSetting *         nm_setting_wimax_new                (void);
+

+Creates a new NMSettingWimax object with default values. +

+
++ + + + +

Returns :

the new empty NMSettingWimax object
+
+
+
+

nm_setting_wimax_get_network_name ()

+
const char *        nm_setting_wimax_get_network_name   (NMSettingWimax *setting);
+

+Returns the WiMAX NSP name (ex "Sprint" or "CLEAR") which identifies the +specific WiMAX network this setting describes a connection to. +

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

setting :

the NMSettingWimax +

Returns :

the WiMAX NSP name
+
+
+
+

nm_setting_wimax_get_mac_address ()

+
const GByteArray *  nm_setting_wimax_get_mac_address    (NMSettingWimax *setting);
+

+Returns the MAC address of a WiMAX device which this connection is locked +to. +

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

setting :

the NMSettingWimax +

Returns :

the MAC address
+
+
+
+

Property Details

+
+

The "mac-address" property

+
  "mac-address"              GArray_guchar_*       : Read / Write
+

+If specified, this connection will only apply to the WiMAX device +whose MAC address matches. This property does not change the MAC address +of the device (known as MAC spoofing). +

+
+
+
+

The "network-name" property

+
  "network-name"             gchar*                : Read / Write
+

+Network Service Provider (NSP) name of the WiMAX network this connection +should use. +

+

Default value: NULL

+
+
+
+ + + \ No newline at end of file diff --git a/docs/libnm-util/html/NMSettingWired.html b/docs/libnm-util/html/NMSettingWired.html index d079de3a..dc01f965 100644 --- a/docs/libnm-util/html/NMSettingWired.html +++ b/docs/libnm-util/html/NMSettingWired.html @@ -35,13 +35,16 @@

NMSettingWired

-

NMSettingWired

+

NMSettingWired — Describes connection properties for Ethernet-based networks

Synopsis

-
#define             NM_SETTING_WIRED_SETTING_NAME
+
+#include <nm-setting-wired.h>
+
+#define             NM_SETTING_WIRED_SETTING_NAME
 enum                NMSettingWiredError;
 #define             NM_TYPE_SETTING_WIRED_ERROR
 #define             NM_SETTING_WIRED_ERROR
@@ -52,6 +55,7 @@ enum                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_S390_SUBCHANNELS
 #define             NM_SETTING_WIRED_S390_NETTYPE
@@ -67,6 +71,8 @@ const char *        GByteArray *  nm_setting_wired_get_mac_address    (NMSettingWired *setting);
 const GByteArray *  nm_setting_wired_get_cloned_mac_address
                                                         (NMSettingWired *setting);
+const GSList *      nm_setting_wired_get_mac_address_blacklist
+                                                        (NMSettingWired *setting);
 guint32             nm_setting_wired_get_mtu            (NMSettingWired *setting);
 const GPtrArray *   nm_setting_wired_get_s390_subchannels
                                                         (NMSettingWired *setting);
@@ -106,6 +112,7 @@ const char *        cloned-mac-address"       GArray_guchar_*       : Read / Write
   "duplex"                   gchar*                : Read / Write
   "mac-address"              GArray_guchar_*       : Read / Write
+  "mac-address-blacklist"    GSList_gchararray_*   : Read / Write
   "mtu"                      guint                 : Read / Write / Construct
   "port"                     gchar*                : Read / Write
   "s390-nettype"             gchar*                : Read / Write
@@ -117,6 +124,8 @@ const char *        
 

Description

+The NMSettingWired object is a NMSetting subclass that describes properties +necessary for connection to Ethernet networks.

@@ -131,15 +140,33 @@ const char *

enum NMSettingWiredError

-
typedef enum
-{
+
typedef enum {
 	NM_SETTING_WIRED_ERROR_UNKNOWN = 0,
 	NM_SETTING_WIRED_ERROR_INVALID_PROPERTY,
 	NM_SETTING_WIRED_ERROR_MISSING_PROPERTY
 } NMSettingWiredError;
 
-

-

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

NM_SETTING_WIRED_ERROR_UNKNOWN

unknown or unclassified error +

NM_SETTING_WIRED_ERROR_INVALID_PROPERTY

the property was invalid +

NM_SETTING_WIRED_ERROR_MISSING_PROPERTY

the property was missing and is +required +

@@ -162,7 +189,15 @@ const char *

nm_setting_wired_error_quark ()

GQuark              nm_setting_wired_error_quark        (void);

+Registers an error quark for NMSettingWired if necessary.

+
++ + + + +

Returns :

the error quark used for NMSettingWired errors.

@@ -214,6 +249,14 @@ const char * +

NM_SETTING_WIRED_MAC_ADDRESS_BLACKLIST

+
#define NM_SETTING_WIRED_MAC_ADDRESS_BLACKLIST "mac-address-blacklist"
+
+

+

+
+
+

NM_SETTING_WIRED_MTU

#define NM_SETTING_WIRED_MTU "mtu"
 
@@ -279,57 +322,172 @@ const char *

nm_setting_wired_new ()

NMSetting *         nm_setting_wired_new                (void);

+Creates a new NMSettingWired object with default values.

+
++ + + + +

Returns :

the new empty NMSettingWired object. [transfer full] +

nm_setting_wired_get_port ()

const char *        nm_setting_wired_get_port           (NMSettingWired *setting);
-

-

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

setting :

the NMSettingWired +

Returns :

the "port" property of the setting

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

const char *        nm_setting_wired_get_duplex         (NMSettingWired *setting);
-

-

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

setting :

the NMSettingWired +

Returns :

the "duplex" property of the setting

nm_setting_wired_get_auto_negotiate ()

gboolean            nm_setting_wired_get_auto_negotiate (NMSettingWired *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);
-

-

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

setting :

the NMSettingWired +

Returns :

the "mac-address" property of the setting

nm_setting_wired_get_cloned_mac_address ()

const GByteArray *  nm_setting_wired_get_cloned_mac_address
                                                         (NMSettingWired *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);
+
++ + + + + + + + + + +

setting :

the NMSettingWired +

Returns :

the "mac-address-blacklist" +property of the setting. [element-type GLib.ByteArray] +

nm_setting_wired_get_mtu ()

guint32             nm_setting_wired_get_mtu            (NMSettingWired *setting);
-

-

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

setting :

the NMSettingWired +

Returns :

the "mtu" property of the setting

@@ -351,8 +509,10 @@ conjunction with that device.

Returns :

-a GPtrArray of strings, each specifying one subchannel the -s390 device uses to communicate to the host. + +GPtrArray of strings, each specifying one +subchannel the s390 device uses to communicate to the host. [element-type utf8] +
@@ -434,13 +594,15 @@ such as during option iteration.

out_key :

-on return, the key name of the s390 specific option; this value is -owned by the setting and should not be modified +on return, the key name of the s390 specific option; this +value is owned by the setting and should not be modified. [out] +

out_value :

-on return, the value of the key of the s390 specific option; this -value is owned by the setting and should not be modified +on return, the value of the key of the s390 specific +option; this value is owned by the setting and should not be modified. [out] +

Returns :

@@ -539,6 +701,17 @@ 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 ethernet 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). +

+
+
+

The "mtu" property

  "mtu"                      guint                 : Read / Write / Construct

diff --git a/docs/libnm-util/html/NMSettingWireless.html b/docs/libnm-util/html/NMSettingWireless.html index 21d51d29..c719a248 100644 --- a/docs/libnm-util/html/NMSettingWireless.html +++ b/docs/libnm-util/html/NMSettingWireless.html @@ -35,13 +35,16 @@

NMSettingWireless

-

NMSettingWireless

+

NMSettingWireless — Describes connection properties for 802.11 WiFi networks

Synopsis

-
#define             NM_SETTING_WIRELESS_SETTING_NAME
+
+#include <nm-setting-wireless.h>
+
+#define             NM_SETTING_WIRELESS_SETTING_NAME
 enum                NMSettingWirelessError;
 #define             NM_TYPE_SETTING_WIRELESS_ERROR
 #define             NM_SETTING_WIRELESS_ERROR
@@ -55,6 +58,7 @@ enum                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_MTU
 #define             NM_SETTING_WIRELESS_SEEN_BSSIDS
 #define             NM_SETTING_WIRELESS_SEC
@@ -74,6 +78,8 @@ const GByteArray *  nm_setting_wireless_get_mac_address (NMSettingWireless *setting);
 const GByteArray *  nm_setting_wireless_get_cloned_mac_address
                                                         (NMSettingWireless *setting);
+const GSList *      nm_setting_wireless_get_mac_address_blacklist
+                                                        (NMSettingWireless *setting);
 guint32             nm_setting_wireless_get_mtu         (NMSettingWireless *setting);
 const char *        nm_setting_wireless_get_security    (NMSettingWireless *setting);
 gboolean            nm_setting_wireless_add_seen_bssid  (NMSettingWireless *setting,
@@ -111,6 +117,7 @@ const char *        channel"                  guint                 : Read / Write / Construct
   "cloned-mac-address"       GArray_guchar_*       : Read / Write
   "mac-address"              GArray_guchar_*       : Read / Write
+  "mac-address-blacklist"    GSList_gchararray_*   : Read / Write
   "mode"                     gchar*                : Read / Write
   "mtu"                      guint                 : Read / Write / Construct
   "rate"                     guint                 : Read / Write / Construct
@@ -123,6 +130,8 @@ const char *        
 

Description

+The NMSettingWireless object is a NMSetting subclass that describes properties +necessary for connection to 802.11 WiFi networks.


@@ -170,7 +209,15 @@ const char *

nm_setting_wireless_error_quark ()

GQuark              nm_setting_wireless_error_quark     (void);

+Registers an error quark for NMSettingWireless if necessary.

+
++ + + + +

Returns :

the error quark used for NMSettingWireless errors.

@@ -246,6 +293,14 @@ const char * +

NM_SETTING_WIRELESS_MAC_ADDRESS_BLACKLIST

+
#define NM_SETTING_WIRELESS_MAC_ADDRESS_BLACKLIST "mac-address-blacklist"
+
+

+

+
+
+

NM_SETTING_WIRELESS_MTU

#define NM_SETTING_WIRELESS_MTU         "mtu"
 
@@ -274,6 +329,7 @@ const char * #define NM_SETTING_WIRELESS_MODE_ADHOC "adhoc"

+Indicates Ad-Hoc mode where no access point is expected to be present.


@@ -282,6 +338,8 @@ const char *
#define NM_SETTING_WIRELESS_MODE_INFRA "infrastructure"

+Indicates infrastructure mode where an access point is expected to be present +for this connection.


@@ -319,85 +377,248 @@ const char *

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

-

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

setting :

the NMSettingWireless +

Returns :

the "ssid" property of the setting

nm_setting_wireless_get_mode ()

const char *        nm_setting_wireless_get_mode        (NMSettingWireless *setting);
-

-

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

setting :

the NMSettingWireless +

Returns :

the "mode" property of the setting

nm_setting_wireless_get_band ()

const char *        nm_setting_wireless_get_band        (NMSettingWireless *setting);
-

-

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

setting :

the NMSettingWireless +

Returns :

the "band" property of the setting

nm_setting_wireless_get_channel ()

guint32             nm_setting_wireless_get_channel     (NMSettingWireless *setting);
-

-

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

setting :

the NMSettingWireless +

Returns :

the "channel" property of the setting

nm_setting_wireless_get_bssid ()

const GByteArray *  nm_setting_wireless_get_bssid       (NMSettingWireless *setting);
-

-

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

setting :

the NMSettingWireless +

Returns :

the "bssid" property of the setting

nm_setting_wireless_get_rate ()

guint32             nm_setting_wireless_get_rate        (NMSettingWireless *setting);
-

-

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

setting :

the NMSettingWireless +

Returns :

the "rate" property of the setting

nm_setting_wireless_get_tx_power ()

guint32             nm_setting_wireless_get_tx_power    (NMSettingWireless *setting);
-

-

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

setting :

the NMSettingWireless +

Returns :

the "tx-power" property of the setting

nm_setting_wireless_get_mac_address ()

const GByteArray *  nm_setting_wireless_get_mac_address (NMSettingWireless *setting);
-

-

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

setting :

the NMSettingWireless +

Returns :

the "mac-address" property of the setting

nm_setting_wireless_get_cloned_mac_address ()

const GByteArray *  nm_setting_wireless_get_cloned_mac_address
                                                         (NMSettingWireless *setting);
-

-

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

setting :

the NMSettingWireless +

Returns :

the "cloned-mac-address" property of the setting
+
+
+
+

nm_setting_wireless_get_mac_address_blacklist ()

+
const GSList *      nm_setting_wireless_get_mac_address_blacklist
+                                                        (NMSettingWireless *setting);
+
++ + + + + + + + + + +

setting :

the NMSettingWireless +

Returns :

the +"mac-address-blacklist" property of the setting. [element-type GLib.ByteArray] +

nm_setting_wireless_get_mtu ()

guint32             nm_setting_wireless_get_mtu         (NMSettingWireless *setting);
-

-

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

setting :

the NMSettingWireless +

Returns :

the "mtu" property of the setting

nm_setting_wireless_get_security ()

const char *        nm_setting_wireless_get_security    (NMSettingWireless *setting);
-

-

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

setting :

the NMSettingWireless +

Returns :

the "security" property of the setting

@@ -405,23 +626,74 @@ const char * gboolean nm_setting_wireless_add_seen_bssid (NMSettingWireless *setting, const char *bssid);

+Adds a new WiFi AP's BSSID to the previously seen BSSID list of the setting. +NetworkManager tracks previously seen BSSIDs internally so this function +no longer has much use.

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

setting :

the NMSettingWireless +

bssid :

the new BSSID to add to the list

Returns :

+TRUE if bssid was already known, FALSE if not

nm_setting_wireless_get_num_seen_bssids ()

guint32             nm_setting_wireless_get_num_seen_bssids
                                                         (NMSettingWireless *setting);
-

-

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

setting :

the NMSettingWireless +

Returns :

the number of BSSIDs in the previously seen BSSID list

nm_setting_wireless_get_seen_bssid ()

const char *        nm_setting_wireless_get_seen_bssid  (NMSettingWireless *setting,
                                                          guint32 i);
-

-

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

setting :

the NMSettingWireless +

i :

index of a BSSID in the previously seen BSSID list

Returns :

the BSSID at index i +

@@ -434,7 +706,52 @@ const char * 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. +

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

s_wireless :

a NMSettingWireless +

s_wireless_sec :

a NMSettingWirelessSecurity or NULL +

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.
@@ -496,6 +813,17 @@ 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). +

+
+
+

The "mode" property

  "mode"                     gchar*                : Read / Write

@@ -544,11 +872,8 @@ the connection contains a valid 802-11-wireless-security setting.

A list of BSSIDs (each BSSID formatted as a MAC address like '00:11:22:33:44:55') that have been detected as part of the WiFI network. -The settings service will usually populate this property by periodically -asking NetworkManager what the device's current AP is while connected -to the network (or monitoring the device's 'active-ap' property) and -adding the current AP'sBSSID to this list. This list helps NetworkManager -find hidden APs by matching up scan results with the BSSIDs in this list. +NetworkManager internally tracks previously seen BSSIDs so this property +is no longer of much use.


diff --git a/docs/libnm-util/html/NMSettingWirelessSecurity.html b/docs/libnm-util/html/NMSettingWirelessSecurity.html index 7fdbc952..0d13105c 100644 --- a/docs/libnm-util/html/NMSettingWirelessSecurity.html +++ b/docs/libnm-util/html/NMSettingWirelessSecurity.html @@ -35,13 +35,17 @@

NMSettingWirelessSecurity

-

NMSettingWirelessSecurity

+

NMSettingWirelessSecurity — Describes connection properties for WiFi networks that +use WEP, LEAP, WPA or WPA2/RSN security

Synopsis

-
#define             NM_SETTING_WIRELESS_SECURITY_SETTING_NAME
+
+#include <nm-setting-wireless-security.h>
+
+#define             NM_SETTING_WIRELESS_SECURITY_SETTING_NAME
 enum                NMSettingWirelessSecurityError;
 #define             NM_TYPE_SETTING_WIRELESS_SECURITY_ERROR
 #define             NM_SETTING_WIRELESS_SECURITY_ERROR
@@ -175,6 +179,24 @@ const char *        
 

Description

+The NMSettingWirelessSecurity object is a NMSetting subclass that describes +properties necessary for connection to encrypted WiFi networks. +

+

+It's a good idea to read up on wpa_supplicant configuration before using this +setting extensively, since most of the options here correspond closely with +the relevant wpa_supplicant configuration options. To get a better overview +of how WiFi security works, you may want to get copies of the following books. +

+

+ 802.11 Wireless Networks: The Definitive Guide, Second Edition + Author: Matthew Gast + ISBN: 978-0596100520 +

+

+ Cisco Wireless LAN Security + Authors: Krishna Sankar, Sri Sundaralingam, Darrin Miller, and Andrew Balinsky + ISBN: 978-1587051548


@@ -239,7 +304,47 @@ const char * NMWepKeyType values specify how any WEP keys present in the setting +are intepreted. There are no standards governing how to hash the various WEP +key/passphrase formats into the actual WEP key. Unfortunately some WEP keys +can be interpreted in multiple ways, requring the setting to specify how to +interpret the any WEP keys. For example, the key "732f2d712e4a394a375d366931" +is both a valid Hexadecimal WEP key and a WEP passphrase. Further, many +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.

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

NM_WEP_KEY_TYPE_UNKNOWN

unknown WEP key type +

NM_WEP_KEY_TYPE_KEY

indicates a hexadecimal or ASCII formatted WEP key. +Hex keys are either 10 or 26 hexadecimal characters (ie "5f782f2f5f" or +"732f2d712e4a394a375d366931"), while ASCII keys are either 5 or 13 ASCII +characters (ie "abcde" or "blahblah99$*1"). +

NM_WEP_KEY_TYPE_PASSPHRASE

indicates a WEP passphrase (ex "I bought a duck +on my way back from the market 235Q&^%^*%") instead of a hexadecimal or ASCII +key. Passphrases are between 8 and 64 characters inclusive and are hashed +the actual WEP key using the MD5 hash algorithm. +

NM_WEP_KEY_TYPE_LAST

placeholder value for bounds-checking +

@@ -413,23 +518,57 @@ const char *

nm_setting_wireless_security_new ()

NMSetting *         nm_setting_wireless_security_new    (void);

+Creates a new NMSettingWirelessSecurity object with default values.

+
++ + + + +

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

-

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

setting :

the NMSettingWirelessSecurity +

Returns :

the "key-mgmt" property of the setting

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

@@ -437,8 +576,25 @@ const char * const char * nm_setting_wireless_security_get_proto (NMSettingWirelessSecurity *setting, guint32 i); -

-

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

setting :

the NMSettingWirelessSecurity +

i :

an index into the protocol list

Returns :

the protocol at index i +

@@ -447,7 +603,33 @@ const char * NMSettingWirelessSecurity *setting, const char *proto);

+Adds a WiFi security protocol (one of "wpa" or "rsn") to the allowed list; +only protocols in this list will be used when finding and connecting to +the WiFi network specified by this connection. For example, if the +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.

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

setting :

the NMSettingWirelessSecurity +

proto :

the protocol to add, one of "wpa" or "rsn"

Returns :

+TRUE if the protocol was new and and was added to the allowed +protocol list, or FALSE if it was already in the list

@@ -456,7 +638,22 @@ const char * NMSettingWirelessSecurity *setting, guint32 i);

+Removes a protocol from the allowed protocol list.

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

setting :

the NMSettingWirelessSecurity +

i :

index of the protocol to remove

@@ -464,15 +661,37 @@ const char * void nm_setting_wireless_security_clear_protos (NMSettingWirelessSecurity *setting);

+Removes all protocols from the allowed list. If there are no protocols +specified then all protocols are allowed.

+
++ + + + +

setting :

the NMSettingWirelessSecurity +

nm_setting_wireless_security_get_num_pairwise ()

guint32             nm_setting_wireless_security_get_num_pairwise
                                                         (NMSettingWirelessSecurity *setting);
-

-

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

setting :

the NMSettingWirelessSecurity +

Returns :

the number of pairwise encryption algorithms in the allowed list

@@ -481,7 +700,28 @@ const char * NMSettingWirelessSecurity *setting, guint32 i);

+Returns the allowed pairwise encryption algorithm from allowed algorithm +list.

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

setting :

the NMSettingWirelessSecurity +

i :

index of an item in the allowed pairwise encryption algorithm list

Returns :

the pairwise encryption algorithm at index i +

@@ -490,7 +730,32 @@ const char * 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.

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

setting :

the NMSettingWirelessSecurity +

pairwise :

the encryption algorithm to add, one of "wep40", "wep104", +"tkip", or "ccmp"

Returns :

+TRUE if the algorithm was added to the list, FALSE if it was +already in the list

@@ -499,7 +764,23 @@ const char * NMSettingWirelessSecurity *setting, guint32 i);

+Removes an encryption algorithm from the allowed pairwise encryption +algorithm list.

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

setting :

the NMSettingWirelessSecurity +

i :

the index of an item in the allowed pairwise encryption algorithm list

@@ -507,15 +788,37 @@ const char * 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 +

nm_setting_wireless_security_get_num_groups ()

guint32             nm_setting_wireless_security_get_num_groups
                                                         (NMSettingWirelessSecurity *setting);
-

-

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

setting :

the NMSettingWirelessSecurity +

Returns :

the number of groupwise encryption algorithms in the allowed list

@@ -524,7 +827,28 @@ const char * NMSettingWirelessSecurity *setting, guint32 i);

+Returns the allowed groupwise encryption algorithm from allowed algorithm +list.

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

setting :

the NMSettingWirelessSecurity +

i :

index of an item in the allowed groupwise encryption algorithm list

Returns :

the groupwise encryption algorithm at index i +

@@ -533,7 +857,32 @@ const char * 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.

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

setting :

the NMSettingWirelessSecurity +

group :

the encryption algorithm to add, one of "wep40", "wep104", +"tkip", or "ccmp"

Returns :

+TRUE if the algorithm was added to the list, FALSE if it was +already in the list

@@ -542,7 +891,23 @@ const char * NMSettingWirelessSecurity *setting, guint32 i);

+Removes an encryption algorithm from the allowed groupwise encryption +algorithm list.

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

setting :

the NMSettingWirelessSecurity +

i :

the index of an item in the allowed groupwise encryption algorithm list

@@ -550,15 +915,37 @@ const char * 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 +

nm_setting_wireless_security_get_psk ()

const char *        nm_setting_wireless_security_get_psk
                                                         (NMSettingWirelessSecurity *setting);
-

-

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

setting :

the NMSettingWirelessSecurity +

Returns :

the "psk" property of the setting

@@ -587,16 +974,40 @@ const char *

nm_setting_wireless_security_get_leap_username ()

const char *        nm_setting_wireless_security_get_leap_username
                                                         (NMSettingWirelessSecurity *setting);
-

-

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

setting :

the NMSettingWirelessSecurity +

Returns :

the "leap-username" 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 +

Returns :

the "leap-password" property of the setting

@@ -626,8 +1037,24 @@ const char * const char * nm_setting_wireless_security_get_wep_key (NMSettingWirelessSecurity *setting, guint32 idx); -

-

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

setting :

the NMSettingWirelessSecurity +

idx :

the WEP key index (0..3 inclusive)

Returns :

the WEP key at the given index

@@ -637,23 +1064,68 @@ const char * guint32 idx, const char *key);

+Sets a WEP key in the given index.

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

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

guint32             nm_setting_wireless_security_get_wep_tx_keyidx
                                                         (NMSettingWirelessSecurity *setting);
-

-

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

setting :

the NMSettingWirelessSecurity +

Returns :

the "wep-tx-keyidx" property of the setting

nm_setting_wireless_security_get_auth_alg ()

const char *        nm_setting_wireless_security_get_auth_alg
                                                         (NMSettingWirelessSecurity *setting);
-

-

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

setting :

the NMSettingWirelessSecurity +

Returns :

the "auth-alg" property of the setting

@@ -680,8 +1152,20 @@ const char *

nm_setting_wireless_security_get_wep_key_type ()

NMWepKeyType        nm_setting_wireless_security_get_wep_key_type
                                                         (NMSettingWirelessSecurity *setting);
-

-

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

setting :

the NMSettingWirelessSecurity +

Returns :

the "wep-key-type" property of the setting
@@ -809,9 +1293,8 @@ Flags indicating how to handle

The "wep-key-type" property

  "wep-key-type"             guint                 : Read / Write / Construct

-Controls the interpretation of WEP keys. Allowed values are 1 (interpret -WEP keys as hexadecimal or ASCII keys) or 2 (interpret WEP keys as WEP -Passphrases). If set to 1 and the keys are hexadecimal, they must be +Controls the interpretation of WEP keys. Allowed values are those given +by NMWepKeyType. If set to 1 and the keys are hexadecimal, they must be either 10 or 26 characters in length. If set to 1 and the keys are ASCII keys, they must be either 5 or 13 characters in length. If set to 2, the passphrase is hashed using the de-facto MD5 method to derive the diff --git a/docs/libnm-util/html/api-index-full.html b/docs/libnm-util/html/api-index-full.html index 0ea92385..f47ea2c9 100644 --- a/docs/libnm-util/html/api-index-full.html +++ b/docs/libnm-util/html/api-index-full.html @@ -21,10 +21,20 @@ Next -C +8 +  |  + A +  |  + B +  |  + C +  |  + D  |  I  |  + M +  |  S  |  T @@ -39,7 +49,34 @@

API Index

-

C

+

8

+
+NM80211ApFlags, enum in NetworkManager +
+
+
+NM80211ApSecurityFlags, enum in NetworkManager +
+
+
+NM80211Mode, enum in NetworkManager +
+
+

A

+
+NMActiveConnectionState, enum in NetworkManager +
+
+

B

+
+NMBluetoothCapabilities, enum in NetworkManager +
+
+

C

+
+NM_CHECK_VERSION, macro in nm-version +
+
NMConnection, struct in NMConnection
@@ -232,6 +269,275 @@ nm_connection_verify, function in NMConnection
+

D

+
+NM_DBUS_IFACE_SETTINGS, macro in NetworkManager +
+
+
+NM_DBUS_IFACE_SETTINGS_CONNECTION, macro in NetworkManager +
+
+
+NM_DBUS_IFACE_SETTINGS_CONNECTION_SECRETS, macro in NetworkManager +
+
+
+NM_DBUS_INTERFACE, macro in NetworkManager +
+
+
+NM_DBUS_INTERFACE_ACCESS_POINT, macro in NetworkManager +
+
+
+NM_DBUS_INTERFACE_ACTIVE_CONNECTION, macro in NetworkManager +
+
+
+NM_DBUS_INTERFACE_AGENT_MANAGER, macro in NetworkManager +
+
+
+NM_DBUS_INTERFACE_DEVICE, macro in NetworkManager +
+
+
+NM_DBUS_INTERFACE_DEVICE_BLUETOOTH, macro in NetworkManager +
+
+
+NM_DBUS_INTERFACE_DEVICE_MODEM, macro in NetworkManager +
+
+
+NM_DBUS_INTERFACE_DEVICE_WIMAX, macro in NetworkManager +
+
+
+NM_DBUS_INTERFACE_DEVICE_WIRED, macro in NetworkManager +
+
+
+NM_DBUS_INTERFACE_DEVICE_WIRELESS, macro in NetworkManager +
+
+
+NM_DBUS_INTERFACE_DHCP4_CONFIG, macro in NetworkManager +
+
+
+NM_DBUS_INTERFACE_DHCP6_CONFIG, macro in NetworkManager +
+
+
+NM_DBUS_INTERFACE_IP4_CONFIG, macro in NetworkManager +
+
+
+NM_DBUS_INTERFACE_IP6_CONFIG, macro in NetworkManager +
+
+
+NM_DBUS_INTERFACE_SECRET_AGENT, macro in NetworkManager +
+
+
+NM_DBUS_INTERFACE_VPN, macro in NetworkManagerVPN +
+
+
+NM_DBUS_INTERFACE_VPN_CONNECTION, macro in NetworkManagerVPN +
+
+
+NM_DBUS_INTERFACE_WIMAX_NSP, macro in NetworkManager +
+
+
+NM_DBUS_INVALID_VPN_CONNECTION, macro in NetworkManagerVPN +
+
+
+NM_DBUS_NO_ACTIVE_VPN_CONNECTION, macro in NetworkManagerVPN +
+
+
+NM_DBUS_NO_VPN_CONNECTIONS, macro in NetworkManagerVPN +
+
+
+NM_DBUS_PATH, macro in NetworkManager +
+
+
+NM_DBUS_PATH_ACCESS_POINT, macro in NetworkManager +
+
+
+NM_DBUS_PATH_AGENT_MANAGER, macro in NetworkManager +
+
+
+NM_DBUS_PATH_SECRET_AGENT, macro in NetworkManager +
+
+
+NM_DBUS_PATH_SETTINGS, macro in NetworkManager +
+
+
+NM_DBUS_PATH_SETTINGS_CONNECTION, macro in NetworkManager +
+
+
+NM_DBUS_PATH_VPN, macro in NetworkManagerVPN +
+
+
+NM_DBUS_PATH_VPN_CONNECTION, macro in NetworkManagerVPN +
+
+
+NM_DBUS_PATH_WIMAX_NSP, macro in NetworkManager +
+
+
+NM_DBUS_SERVICE, macro in NetworkManager +
+
+
+DBUS_TYPE_G_ARRAY_OF_ARRAY_OF_UCHAR, macro in nm-dbus-glib-types +
+
+
+DBUS_TYPE_G_ARRAY_OF_ARRAY_OF_UINT, macro in nm-dbus-glib-types +
+
+
+DBUS_TYPE_G_ARRAY_OF_IP6_ADDRESS, macro in nm-dbus-glib-types +
+
+
+DBUS_TYPE_G_ARRAY_OF_IP6_ROUTE, macro in nm-dbus-glib-types +
+
+
+DBUS_TYPE_G_ARRAY_OF_OBJECT_PATH, macro in nm-dbus-glib-types +
+
+
+DBUS_TYPE_G_ARRAY_OF_STRING, macro in nm-dbus-glib-types +
+
+
+DBUS_TYPE_G_ARRAY_OF_UINT, macro in nm-dbus-glib-types +
+
+
+DBUS_TYPE_G_IP6_ADDRESS, macro in nm-dbus-glib-types +
+
+
+DBUS_TYPE_G_IP6_ROUTE, macro in nm-dbus-glib-types +
+
+
+DBUS_TYPE_G_LIST_OF_STRING, macro in nm-dbus-glib-types +
+
+
+DBUS_TYPE_G_MAP_OF_MAP_OF_VARIANT, macro in nm-dbus-glib-types +
+
+
+DBUS_TYPE_G_MAP_OF_STRING, macro in nm-dbus-glib-types +
+
+
+DBUS_TYPE_G_MAP_OF_VARIANT, macro in nm-dbus-glib-types +
+
+
+NM_DBUS_VPN_ALREADY_STARTED, macro in NetworkManagerVPN +
+
+
+NM_DBUS_VPN_ALREADY_STOPPED, macro in NetworkManagerVPN +
+
+
+NM_DBUS_VPN_BAD_ARGUMENTS, macro in NetworkManagerVPN +
+
+
+NM_DBUS_VPN_SIGNAL_CONNECT_FAILED, macro in NetworkManagerVPN +
+
+
+NM_DBUS_VPN_SIGNAL_IP4_CONFIG, macro in NetworkManagerVPN +
+
+
+NM_DBUS_VPN_SIGNAL_IP_CONFIG_BAD, macro in NetworkManagerVPN +
+
+
+NM_DBUS_VPN_SIGNAL_LAUNCH_FAILED, macro in NetworkManagerVPN +
+
+
+NM_DBUS_VPN_SIGNAL_LOGIN_BANNER, macro in NetworkManagerVPN +
+
+
+NM_DBUS_VPN_SIGNAL_LOGIN_FAILED, macro in NetworkManagerVPN +
+
+
+NM_DBUS_VPN_SIGNAL_STATE_CHANGE, macro in NetworkManagerVPN +
+
+
+NM_DBUS_VPN_SIGNAL_VPN_CONFIG_BAD, macro in NetworkManagerVPN +
+
+
+NM_DBUS_VPN_STARTING_IN_PROGRESS, macro in NetworkManagerVPN +
+
+
+NM_DBUS_VPN_STOPPING_IN_PROGRESS, macro in NetworkManagerVPN +
+
+
+NM_DBUS_VPN_WRONG_STATE, macro in NetworkManagerVPN +
+
+
+NMDeviceCapabilities, enum in NetworkManager +
+
+
+NMDeviceModemCapabilities, enum in NetworkManager +
+
+
+NMDeviceState, enum in NetworkManager +
+
+
+NMDeviceStateReason, enum in NetworkManager +
+
+
+NMDeviceType, enum in NetworkManager +
+
+
+NMDeviceWifiCapabilities, enum in NetworkManager +
+

I

NMIP4Address, typedef in NMSettingIP4Config @@ -457,6 +763,19 @@ nm_ip6_route_unref, function in NMSettingIP6Config
+

M

+
+NM_MAJOR_VERSION, macro in nm-version +
+
+
+NM_MICRO_VERSION, macro in nm-version +
+
+
+NM_MINOR_VERSION, macro in nm-version +
+

S

NMSetting, struct in NMSetting @@ -467,6 +786,10 @@
+NMSetting8021x:altsubject-matches, object property in NMSetting8021x +
+
+
NMSetting8021x:anonymous-identity, object property in NMSetting8021x
@@ -511,6 +834,10 @@
+NMSetting8021x:phase2-altsubject-matches, object property in NMSetting8021x +
+
+
NMSetting8021x:phase2-auth, object property in NMSetting8021x
@@ -543,6 +870,10 @@
+NMSetting8021x:phase2-subject-match, object property in NMSetting8021x +
+
+
NMSetting8021x:private-key, object property in NMSetting8021x
@@ -555,6 +886,10 @@
+NMSetting8021x:subject-match, object property in NMSetting8021x +
+
+
NMSetting8021x:system-ca-certs, object property in NMSetting8021x
@@ -1063,23 +1398,23 @@
-NMSettingWimax, struct in NMSettingWimax +NMSettingWimax, struct in NMSettingWimax
-NMSettingWimax:mac-address, object property in NMSettingWimax +NMSettingWimax:mac-address, object property in NMSettingWimax
-NMSettingWimax:network-name, object property in NMSettingWimax +NMSettingWimax:network-name, object property in NMSettingWimax
-NMSettingWimaxClass, struct in NMSettingWimax +NMSettingWimaxClass, struct in NMSettingWimax
-NMSettingWimaxError, enum in NMSettingWimax +NMSettingWimaxError, enum in NMSettingWimax
@@ -1103,6 +1438,10 @@ NMSettingWimaxError, enum in NMSettingWimax
+NMSettingWired:mac-address-blacklist, object property in NMSettingWired +
+
+
NMSettingWired:mtu, object property in NMSettingWired
@@ -1159,6 +1498,10 @@ NMSettingWimaxError, enum in NMSettingWimax
+NMSettingWireless:mac-address-blacklist, object property in NMSettingWireless +
+
+
NMSettingWireless:mode, object property in NMSettingWireless
@@ -1275,10 +1618,22 @@ NMSettingWimaxError, enum in NMSettingWimax
+nm_setting_802_1x_add_altsubject_match, function in NMSetting8021x +
+
+
nm_setting_802_1x_add_eap_method, function in NMSetting8021x
+nm_setting_802_1x_add_phase2_altsubject_match, function in NMSetting8021x +
+
+
+NM_SETTING_802_1X_ALTSUBJECT_MATCHES, macro in NMSetting8021x +
+
+
NM_SETTING_802_1X_ANONYMOUS_IDENTITY, macro in NMSetting8021x
@@ -1291,10 +1646,18 @@ NMSettingWimaxError, enum in NMSettingWimax
+nm_setting_802_1x_clear_altsubject_matches, function in NMSetting8021x +
+
+
nm_setting_802_1x_clear_eap_methods, function in NMSetting8021x
+nm_setting_802_1x_clear_phase2_altsubject_matches, function in NMSetting8021x +
+
+
NM_SETTING_802_1X_CLIENT_CERT, macro in NMSetting8021x
@@ -1311,6 +1674,10 @@ NMSettingWimaxError, enum in NMSettingWimax
+nm_setting_802_1x_get_altsubject_match, function in NMSetting8021x +
+
+
nm_setting_802_1x_get_anonymous_identity, function in NMSetting8021x
@@ -1351,10 +1718,18 @@ NMSettingWimaxError, enum in NMSettingWimax
+nm_setting_802_1x_get_num_altsubject_matches, function in NMSetting8021x +
+
+
nm_setting_802_1x_get_num_eap_methods, function in NMSetting8021x
+nm_setting_802_1x_get_num_phase2_altsubject_matches, function in NMSetting8021x +
+
+
nm_setting_802_1x_get_password, function in NMSetting8021x
@@ -1375,6 +1750,10 @@ NMSettingWimaxError, enum in NMSettingWimax
+nm_setting_802_1x_get_phase2_altsubject_match, function in NMSetting8021x +
+
+
nm_setting_802_1x_get_phase2_auth, function in NMSetting8021x
@@ -1435,6 +1814,10 @@ NMSettingWimaxError, enum in NMSettingWimax
+nm_setting_802_1x_get_phase2_subject_match, function in NMSetting8021x +
+
+
nm_setting_802_1x_get_pin, function in NMSetting8021x
@@ -1467,6 +1850,10 @@ NMSettingWimaxError, enum in NMSettingWimax
+nm_setting_802_1x_get_subject_match, function in NMSetting8021x +
+
+
nm_setting_802_1x_get_system_ca_certs, function in NMSetting8021x
@@ -1503,6 +1890,10 @@ NMSettingWimaxError, enum in NMSettingWimax
+NM_SETTING_802_1X_PHASE2_ALTSUBJECT_MATCHES, macro in NMSetting8021x +
+
+
NM_SETTING_802_1X_PHASE2_AUTH, macro in NMSetting8021x
@@ -1535,6 +1926,10 @@ NMSettingWimaxError, enum in NMSettingWimax
+NM_SETTING_802_1X_PHASE2_SUBJECT_MATCH, macro in NMSetting8021x +
+
+
NM_SETTING_802_1X_PIN, macro in NMSetting8021x
@@ -1555,10 +1950,18 @@ NMSettingWimaxError, enum in NMSettingWimax
+nm_setting_802_1x_remove_altsubject_match, function in NMSetting8021x +
+
+
nm_setting_802_1x_remove_eap_method, function in NMSetting8021x
+nm_setting_802_1x_remove_phase2_altsubject_match, function in NMSetting8021x +
+
+
NM_SETTING_802_1X_SETTING_NAME, macro in NMSetting8021x
@@ -1587,6 +1990,10 @@ NMSettingWimaxError, enum in NMSettingWimax
+NM_SETTING_802_1X_SUBJECT_MATCH, macro in NMSetting8021x +
+
+
NM_SETTING_802_1X_SYSTEM_CA_CERTS, macro in NMSetting8021x
@@ -2755,39 +3162,39 @@ NM_SETTING_SECRET_FLAGS_ALL, macro in nm-setting-private
-NM_SETTING_WIMAX_ERROR, macro in NMSettingWimax +NM_SETTING_WIMAX_ERROR, macro in NMSettingWimax
-nm_setting_wimax_error_quark, function in NMSettingWimax +nm_setting_wimax_error_quark, function in NMSettingWimax
-nm_setting_wimax_get_mac_address, function in NMSettingWimax +nm_setting_wimax_get_mac_address, function in NMSettingWimax
-nm_setting_wimax_get_network_name, function in NMSettingWimax +nm_setting_wimax_get_network_name, function in NMSettingWimax
-nm_setting_wimax_get_type, function in NMSettingWimax +nm_setting_wimax_get_type, function in NMSettingWimax
-NM_SETTING_WIMAX_MAC_ADDRESS, macro in NMSettingWimax +NM_SETTING_WIMAX_MAC_ADDRESS, macro in NMSettingWimax
-NM_SETTING_WIMAX_NETWORK_NAME, macro in NMSettingWimax +NM_SETTING_WIMAX_NETWORK_NAME, macro in NMSettingWimax
-nm_setting_wimax_new, function in NMSettingWimax +nm_setting_wimax_new, function in NMSettingWimax
-NM_SETTING_WIMAX_SETTING_NAME, macro in NMSettingWimax +NM_SETTING_WIMAX_SETTING_NAME, macro in NMSettingWimax
@@ -2831,6 +3238,10 @@ NM_SETTING_WIMAX_SETTING_NAME, macro in NMSettingWimax
+nm_setting_wired_get_mac_address_blacklist, function in NMSettingWired +
+
+
nm_setting_wired_get_mtu, function in NMSettingWired
@@ -2871,6 +3282,10 @@ NM_SETTING_WIMAX_SETTING_NAME, macro in NMSettingWimax
+NM_SETTING_WIRED_MAC_ADDRESS_BLACKLIST, macro in NMSettingWired +
+
+
NM_SETTING_WIRED_MTU, macro in NMSettingWired
@@ -2959,6 +3374,10 @@ NM_SETTING_WIMAX_SETTING_NAME, macro in NMSettingWimax
+nm_setting_wireless_get_mac_address_blacklist, function in NMSettingWireless +
+
+
nm_setting_wireless_get_mode, function in NMSettingWireless
@@ -2999,6 +3418,10 @@ NM_SETTING_WIMAX_SETTING_NAME, macro in NMSettingWimax
+NM_SETTING_WIRELESS_MAC_ADDRESS_BLACKLIST, macro in NMSettingWireless +
+
+
NM_SETTING_WIRELESS_MODE, macro in NMSettingWireless
@@ -3238,6 +3661,14 @@ NM_SETTING_WIMAX_SETTING_NAME, macro in NMSettingWimax NM_SETTING_WIRELESS_TX_POWER, macro in NMSettingWireless
+
+NMState, enum in NetworkManager +
+
+
+NM_STATE_CONNECTED, macro in NetworkManager +
+

T

NM_TYPE_CONNECTION_ERROR, macro in NMConnection @@ -3296,7 +3727,7 @@ NM_SETTING_WIMAX_SETTING_NAME, macro in NMSettingWimax
-NM_TYPE_SETTING_WIMAX_ERROR, macro in NMSettingWimax +NM_TYPE_SETTING_WIMAX_ERROR, macro in NMSettingWimax
@@ -3434,9 +3865,93 @@ NM_TYPE_SETTING_WIMAX_ERROR, macro in NMSettingWimax

V

+NMVPNConnectionState, enum in NetworkManagerVPN +
+
+
+NMVPNConnectionStateReason, enum in NetworkManagerVPN +
+
+
NMVPNIterFunc, user_function in NMSettingVPN
+
+NMVPNPluginFailure, enum in NetworkManagerVPN +
+
+
+NMVPNServiceState, enum in NetworkManagerVPN +
+
+
+NM_VPN_DBUS_PLUGIN_INTERFACE, macro in NetworkManagerVPN +
+
+
+NM_VPN_DBUS_PLUGIN_PATH, macro in NetworkManagerVPN +
+
+
+NM_VPN_PLUGIN_IP4_CONFIG_ADDRESS, macro in NetworkManagerVPN +
+
+
+NM_VPN_PLUGIN_IP4_CONFIG_BANNER, macro in NetworkManagerVPN +
+
+
+NM_VPN_PLUGIN_IP4_CONFIG_DNS, macro in NetworkManagerVPN +
+
+
+NM_VPN_PLUGIN_IP4_CONFIG_DOMAIN, macro in NetworkManagerVPN +
+
+
+NM_VPN_PLUGIN_IP4_CONFIG_EXT_GATEWAY, macro in NetworkManagerVPN +
+
+
+NM_VPN_PLUGIN_IP4_CONFIG_GATEWAY, macro in NetworkManagerVPN +
+
+
+NM_VPN_PLUGIN_IP4_CONFIG_INT_GATEWAY, macro in NetworkManagerVPN +
+
+
+NM_VPN_PLUGIN_IP4_CONFIG_MSS, macro in NetworkManagerVPN +
+
+
+NM_VPN_PLUGIN_IP4_CONFIG_MTU, macro in NetworkManagerVPN +
+
+
+NM_VPN_PLUGIN_IP4_CONFIG_NBNS, macro in NetworkManagerVPN +
+
+
+NM_VPN_PLUGIN_IP4_CONFIG_NEVER_DEFAULT, macro in NetworkManagerVPN +
+
+
+NM_VPN_PLUGIN_IP4_CONFIG_PREFIX, macro in NetworkManagerVPN +
+
+
+NM_VPN_PLUGIN_IP4_CONFIG_PTP, macro in NetworkManagerVPN +
+
+
+NM_VPN_PLUGIN_IP4_CONFIG_ROUTES, macro in NetworkManagerVPN +
+
+
+NM_VPN_PLUGIN_IP4_CONFIG_TUNDEV, macro in NetworkManagerVPN +
+

W

NMWepKeyType, enum in NMSettingWirelessSecurity diff --git a/docs/libnm-util/html/ch01.html b/docs/libnm-util/html/ch01.html index 52f73af9..d97a8939 100644 --- a/docs/libnm-util/html/ch01.html +++ b/docs/libnm-util/html/ch01.html @@ -21,7 +21,7 @@

-libnm-util API Reference

+libnm-util API Reference
NMConnection — Describes a connection to specific network or provider @@ -33,25 +33,30 @@ NMSettingConnection — Describes general connection properties
-NMSettingWired +NMSettingWired — Describes connection properties for Ethernet-based networks
-NMSettingWireless +NMSettingWireless — Describes connection properties for 802.11 WiFi networks
-NMSettingWirelessSecurity +NMSettingWirelessSecurity — Describes connection properties for WiFi networks that +use WEP, LEAP, WPA or WPA2/RSN security
-NMSettingBluetooth +NMSettingBluetooth — Describes Bluetooth connection properties
-NMSettingSerial +NMSettingSerial — Describes connection properties for devices that use +serial communications
NMSettingCdma — Describes CDMA-based mobile broadband properties
-NMSettingGsm +NMSettingGsm — Describes GSM/3GPP-based mobile broadband properties +
+
+NMSettingWimax — Describes 802.16e Mobile WiMAX connection properties
NMSettingOlpcMesh @@ -60,19 +65,20 @@ NMSetting8021x — Describes 802.1x-authenticated connection properties
-NMSettingIP4Config +NMSettingIP4Config — Describes IPv4 addressing, routing, and name service properties
-NMSettingIP6Config +NMSettingIP6Config — Describes IPv6 addressing, routing, and name service properties
-NMSettingPPP +NMSettingPPP — Describes connection properties for devices/networks +that require PPP to deliver IP capability
-NMSettingPPPOE +NMSettingPPPOE — Describes PPPoE connection properties
-NMSettingVPN +NMSettingVPN — Describes connection properties for Virtual Private Networks
nm-utils — Utility functions diff --git a/docs/libnm-util/html/index.html b/docs/libnm-util/html/index.html index feb9a71b..51f90c6a 100644 --- a/docs/libnm-util/html/index.html +++ b/docs/libnm-util/html/index.html @@ -35,25 +35,30 @@ NMSettingConnection — Describes general connection properties
-NMSettingWired +NMSettingWired — Describes connection properties for Ethernet-based networks
-NMSettingWireless +NMSettingWireless — Describes connection properties for 802.11 WiFi networks
-NMSettingWirelessSecurity +NMSettingWirelessSecurity — Describes connection properties for WiFi networks that +use WEP, LEAP, WPA or WPA2/RSN security
-NMSettingBluetooth +NMSettingBluetooth — Describes Bluetooth connection properties
-NMSettingSerial +NMSettingSerial — Describes connection properties for devices that use +serial communications
NMSettingCdma — Describes CDMA-based mobile broadband properties
-NMSettingGsm +NMSettingGsm — Describes GSM/3GPP-based mobile broadband properties +
+
+NMSettingWimax — Describes 802.16e Mobile WiMAX connection properties
NMSettingOlpcMesh @@ -62,19 +67,20 @@ NMSetting8021x — Describes 802.1x-authenticated connection properties
-NMSettingIP4Config +NMSettingIP4Config — Describes IPv4 addressing, routing, and name service properties
-NMSettingIP6Config +NMSettingIP6Config — Describes IPv6 addressing, routing, and name service properties
-NMSettingPPP +NMSettingPPP — Describes connection properties for devices/networks +that require PPP to deliver IP capability
-NMSettingPPPOE +NMSettingPPPOE — Describes PPPoE connection properties
-NMSettingVPN +NMSettingVPN — Describes connection properties for Virtual Private Networks
nm-utils — Utility functions diff --git a/docs/libnm-util/html/index.sgml b/docs/libnm-util/html/index.sgml index 4140e896..eda2a542 100644 --- a/docs/libnm-util/html/index.sgml +++ b/docs/libnm-util/html/index.sgml @@ -11,6 +11,7 @@ + @@ -86,6 +87,13 @@ + + + + + + + @@ -99,11 +107,6 @@ - - - - - @@ -174,6 +177,9 @@ + + + @@ -183,6 +189,7 @@ + @@ -197,6 +204,7 @@ + @@ -210,6 +218,7 @@ + @@ -225,6 +234,11 @@ + + + + + @@ -237,6 +251,7 @@ + @@ -255,6 +270,7 @@ + @@ -267,6 +283,7 @@ + @@ -283,10 +300,21 @@ + + + + + + + + + + + @@ -362,6 +390,10 @@ + + + + @@ -387,6 +419,10 @@ + + + + @@ -419,6 +455,10 @@ + + + + @@ -448,6 +488,10 @@ + + + + @@ -463,7 +507,27 @@ + + + + + + + + + + + + + + + + + + + + @@ -491,6 +555,32 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -535,6 +625,9 @@ + + + @@ -543,6 +636,8 @@ + + @@ -551,6 +646,8 @@ + + @@ -581,6 +678,12 @@ + + + + + + @@ -594,6 +697,12 @@ + + + + + + @@ -617,6 +726,7 @@ + @@ -628,6 +738,7 @@ + @@ -636,9 +747,11 @@ + + @@ -651,6 +764,10 @@ + + + + @@ -755,6 +872,10 @@ + + + + @@ -849,6 +970,10 @@ + + + + @@ -920,6 +1045,10 @@ + + + + @@ -949,6 +1078,9 @@ + + + @@ -989,6 +1121,15 @@ + + + + + + + + + diff --git a/docs/libnm-util/html/libnm-util-nm-utils.html b/docs/libnm-util/html/libnm-util-nm-utils.html index f2650339..00c11126 100644 --- a/docs/libnm-util/html/libnm-util-nm-utils.html +++ b/docs/libnm-util/html/libnm-util-nm-utils.html @@ -55,12 +55,12 @@ const char * GDestroyNotify elem_destroy_fn); enum NMUtilsSecurityType; gboolean nm_utils_security_valid (NMUtilsSecurityType type, - guint32 wifi_caps, + NMDeviceWifiCapabilities wifi_caps, gboolean have_ap, gboolean adhoc, - guint32 ap_flags, - guint32 ap_wpa, - guint32 ap_rsn); + NM80211ApFlags ap_flags, + NM80211ApSecurityFlags ap_wpa, + NM80211ApSecurityFlags ap_rsn); GSList * nm_utils_ip4_addresses_from_gvalue (const GValue *value); void nm_utils_ip4_addresses_to_gvalue (GSList *list, GValue *value); @@ -118,7 +118,7 @@ libnm-util can also be done. This function can be called more than once.

error :

-location to store error, or NULL +location to store error, or NULL @@ -346,18 +346,73 @@ Utility function to free a nm_utils_security_valid() for checking whether a given access +point is compatible with a network device.

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

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

NMU_SEC_WPA2_ENTERPRISE

WPA2 is used with 802.1x authentication +

nm_utils_security_valid ()

gboolean            nm_utils_security_valid             (NMUtilsSecurityType type,
-                                                         guint32 wifi_caps,
+                                                         NMDeviceWifiCapabilities wifi_caps,
                                                          gboolean have_ap,
                                                          gboolean adhoc,
-                                                         guint32 ap_flags,
-                                                         guint32 ap_wpa,
-                                                         guint32 ap_rsn);
+ 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 @@ -369,7 +424,7 @@ type, and AP capabilities intersect.

type :

the security type to check AP flags and device capabilties against, -e.g. NMU_SEC_STATIC_WEP +e.g. NMU_SEC_STATIC_WEP diff --git a/docs/libnm-util/html/libnm-util.devhelp b/docs/libnm-util/html/libnm-util.devhelp index b8b98e40..21ba39f2 100644 --- a/docs/libnm-util/html/libnm-util.devhelp +++ b/docs/libnm-util/html/libnm-util.devhelp @@ -13,6 +13,7 @@ + @@ -86,6 +87,7 @@ + @@ -96,7 +98,6 @@ - @@ -153,6 +154,7 @@ + @@ -167,6 +169,7 @@ + @@ -179,6 +182,7 @@ + @@ -199,6 +203,7 @@ + @@ -217,6 +222,7 @@ + @@ -228,6 +234,7 @@ + @@ -412,6 +419,21 @@ + + + + + + + + + + + + + + + @@ -442,6 +464,8 @@ + + @@ -450,6 +474,8 @@ + + @@ -480,6 +506,12 @@ + + + + + + @@ -493,6 +525,12 @@ + + + + + + @@ -515,6 +553,7 @@ + @@ -526,6 +565,7 @@ + @@ -534,9 +574,11 @@ + + diff --git a/docs/libnm-util/html/libnm-util.devhelp2 b/docs/libnm-util/html/libnm-util.devhelp2 index 0104b4d0..a6544ddd 100644 --- a/docs/libnm-util/html/libnm-util.devhelp2 +++ b/docs/libnm-util/html/libnm-util.devhelp2 @@ -13,6 +13,7 @@ + @@ -86,6 +87,7 @@ + @@ -96,7 +98,6 @@ - @@ -153,6 +154,7 @@ + @@ -167,6 +169,7 @@ + @@ -179,6 +182,7 @@ + @@ -199,6 +203,7 @@ + @@ -217,6 +222,7 @@ + @@ -228,6 +234,7 @@ + @@ -412,6 +419,21 @@ + + + + + + + + + + + + + + + @@ -442,6 +464,8 @@ + + @@ -450,6 +474,8 @@ + + @@ -480,6 +506,12 @@ + + + + + + @@ -493,6 +525,12 @@ + + + + + + @@ -515,6 +553,7 @@ + @@ -526,6 +565,7 @@ + @@ -534,9 +574,11 @@ + + @@ -863,6 +905,7 @@ + @@ -871,13 +914,15 @@ - - - + + + + + @@ -885,6 +930,64 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -892,5 +995,36 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/libnm-util/html/object-tree.html b/docs/libnm-util/html/object-tree.html index a69c8dbb..a67b1874 100644 --- a/docs/libnm-util/html/object-tree.html +++ b/docs/libnm-util/html/object-tree.html @@ -38,7 +38,7 @@ NMSettingPPPOE NMSettingSerial NMSettingVPN - NMSettingWimax + NMSettingWimax NMSettingWired NMSettingWireless NMSettingWirelessSecurity @@ -57,7 +57,7 @@ NMSettingPPPOEError NMSettingSerialError NMSettingVpnError - NMSettingWimaxError + NMSettingWimaxError NMSettingWiredError NMSettingWirelessError NMSettingWirelessSecurityError -- cgit 1.3.0-6-gf8a5