NMSetting

NMSetting

Synopsis

#define             NM_SETTING_PARAM_SERIALIZE
#define             NM_SETTING_PARAM_REQUIRED
#define             NM_SETTING_PARAM_SECRET
#define             NM_SETTING_PARAM_FUZZY_IGNORE
#define             NM_SETTING_PARAM_CERTIFICATE
#define             NM_SETTING_NAME
                    NMSetting;
void                (*NMSettingValueIterFn)             (NMSetting *setting,
                                                         const char *key,
                                                         const GValue *value,
                                                         GParamFlags flags,
                                                         gpointer user_data);
GHashTable*         nm_setting_to_hash                  (NMSetting *setting);
NMSetting*          nm_setting_from_hash                (GType setting_type,
                                                         GHashTable *hash);
NMSetting*          nm_setting_duplicate                (NMSetting *setting);
const char*         nm_setting_get_name                 (NMSetting *setting);
gboolean            nm_setting_verify                   (NMSetting *setting,
                                                         GSList *all_settings,
                                                         GError **error);
enum                NMSettingCompareFlags;
gboolean            nm_setting_compare                  (NMSetting *setting,
                                                         NMSetting *other,
                                                         NMSettingCompareFlags flags);
void                nm_setting_enumerate_values         (NMSetting *setting,
                                                         NMSettingValueIterFn func,
                                                         gpointer user_data);
char*               nm_setting_to_string                (NMSetting *setting);
void                nm_setting_clear_secrets            (NMSetting *setting);
GPtrArray*          nm_setting_need_secrets             (NMSetting *setting);
void                nm_setting_update_secrets           (NMSetting *setting,
                                                         GHashTable *secrets);

Object Hierarchy

  GObject
   +----NMSetting
         +----NMSetting8021x
         +----NMSettingCdma
         +----NMSettingConnection
         +----NMSettingGsm
         +----NMSettingIP4Config
         +----NMSettingPPP
         +----NMSettingPPPOE
         +----NMSettingSerial
         +----NMSettingVPN
         +----NMSettingWired
         +----NMSettingWireless
         +----NMSettingWirelessSecurity

Properties

  "name"                     gchar*                : Read / Write

Description

Details

NM_SETTING_PARAM_SERIALIZE

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


NM_SETTING_PARAM_REQUIRED

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


NM_SETTING_PARAM_SECRET

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


NM_SETTING_PARAM_FUZZY_IGNORE

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


NM_SETTING_PARAM_CERTIFICATE

#define NM_SETTING_PARAM_CERTIFICATE  (1 << (4 + G_PARAM_USER_SHIFT))


NM_SETTING_NAME

#define NM_SETTING_NAME "name"


NMSetting

typedef struct _NMSetting NMSetting;


NMSettingValueIterFn ()

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

setting :

key :

value :

flags :

user_data :


nm_setting_to_hash ()

GHashTable*         nm_setting_to_hash                  (NMSetting *setting);

setting :

Returns :


nm_setting_from_hash ()

NMSetting*          nm_setting_from_hash                (GType setting_type,
                                                         GHashTable *hash);

setting_type :

hash :

Returns :


nm_setting_duplicate ()

NMSetting*          nm_setting_duplicate                (NMSetting *setting);

setting :

Returns :


nm_setting_get_name ()

const char*         nm_setting_get_name                 (NMSetting *setting);

setting :

Returns :


nm_setting_verify ()

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

setting :

all_settings :

error :

Returns :


enum NMSettingCompareFlags

typedef enum {
	/* Match all attributes exactly */
	NM_SETTING_COMPARE_FLAG_EXACT = 0x00000000,

	/* Match only important attributes, like SSID, type, security settings, etc */
	NM_SETTING_COMPARE_FLAG_FUZZY = 0x00000001,

	/* Ignore the connection ID */
	NM_SETTING_COMPARE_FLAG_IGNORE_ID = 0x00000002,

	/* Ignore secrets */
	NM_SETTING_COMPARE_FLAG_IGNORE_SECRETS = 0x00000004
} NMSettingCompareFlags;


nm_setting_compare ()

gboolean            nm_setting_compare                  (NMSetting *setting,
                                                         NMSetting *other,
                                                         NMSettingCompareFlags flags);

setting :

other :

flags :

Returns :


nm_setting_enumerate_values ()

void                nm_setting_enumerate_values         (NMSetting *setting,
                                                         NMSettingValueIterFn func,
                                                         gpointer user_data);

setting :

func :

user_data :


nm_setting_to_string ()

char*               nm_setting_to_string                (NMSetting *setting);

setting :

Returns :


nm_setting_clear_secrets ()

void                nm_setting_clear_secrets            (NMSetting *setting);

setting :


nm_setting_need_secrets ()

GPtrArray*          nm_setting_need_secrets             (NMSetting *setting);

setting :

Returns :


nm_setting_update_secrets ()

void                nm_setting_update_secrets           (NMSetting *setting,
                                                         GHashTable *secrets);

setting :

secrets :

Property Details

The "name" property

  "name"                     gchar*                : Read / Write

Setting's name.

Default value: NULL