From b436a68a20ff3114ded32a7a3d70cdd4954039f9 Mon Sep 17 00:00:00 2001 From: Michael Biebl Date: Sat, 12 Nov 2011 01:36:14 +0100 Subject: Imported Upstream version 0.9.2.0 --- docs/libnm-util/html/NMSettingVPN.html | 394 +++++++++++++++------------------ 1 file changed, 184 insertions(+), 210 deletions(-) (limited to 'docs/libnm-util/html/NMSettingVPN.html') diff --git a/docs/libnm-util/html/NMSettingVPN.html b/docs/libnm-util/html/NMSettingVPN.html index 1c6264d0..4f397cc3 100644 --- a/docs/libnm-util/html/NMSettingVPN.html +++ b/docs/libnm-util/html/NMSettingVPN.html @@ -8,7 +8,7 @@ - + @@ -44,57 +44,54 @@ 
 #include <nm-setting-vpn.h>
 
-#define             NM_SETTING_VPN_SETTING_NAME
-enum                NMSettingVpnError;
-#define             NM_TYPE_SETTING_VPN_ERROR
-#define             NM_SETTING_VPN_ERROR
-GQuark              nm_setting_vpn_error_quark          (void);
-#define             NM_SETTING_VPN_SERVICE_TYPE
-#define             NM_SETTING_VPN_USER_NAME
-#define             NM_SETTING_VPN_DATA
-#define             NM_SETTING_VPN_SECRETS
                     NMSettingVPN;
                     NMSettingVPNClass;
+enum                NMSettingVpnError;
 void                (*NMVPNIterFunc)                    (const char *key,
                                                          const char *value,
                                                          gpointer user_data);
-GType               nm_setting_vpn_get_type             (void);
-NMSetting *         nm_setting_vpn_new                  (void);
-const char *        nm_setting_vpn_get_service_type     (NMSettingVPN *setting);
-const char *        nm_setting_vpn_get_user_name        (NMSettingVPN *setting);
+#define             NM_SETTING_VPN_DATA
+#define             NM_SETTING_VPN_SECRETS
+#define             NM_SETTING_VPN_SERVICE_TYPE
+#define             NM_SETTING_VPN_SETTING_NAME
+#define             NM_SETTING_VPN_USER_NAME
 void                nm_setting_vpn_add_data_item        (NMSettingVPN *setting,
                                                          const char *key,
                                                          const char *item);
-const char *        nm_setting_vpn_get_data_item        (NMSettingVPN *setting,
-                                                         const char *key);
-void                nm_setting_vpn_remove_data_item     (NMSettingVPN *setting,
-                                                         const char *key);
-void                nm_setting_vpn_foreach_data_item    (NMSettingVPN *setting,
-                                                         NMVPNIterFunc func,
-                                                         gpointer user_data);
 void                nm_setting_vpn_add_secret           (NMSettingVPN *setting,
                                                          const char *key,
                                                          const char *secret);
+GQuark              nm_setting_vpn_error_quark          (void);
+void                nm_setting_vpn_foreach_data_item    (NMSettingVPN *setting,
+                                                         NMVPNIterFunc func,
+                                                         gpointer user_data);
+void                nm_setting_vpn_foreach_secret       (NMSettingVPN *setting,
+                                                         NMVPNIterFunc func,
+                                                         gpointer user_data);
+const char *        nm_setting_vpn_get_data_item        (NMSettingVPN *setting,
+                                                         const char *key);
 const char *        nm_setting_vpn_get_secret           (NMSettingVPN *setting,
                                                          const char *key);
+const char *        nm_setting_vpn_get_service_type     (NMSettingVPN *setting);
+const char *        nm_setting_vpn_get_user_name        (NMSettingVPN *setting);
+NMSetting *         nm_setting_vpn_new                  (void);
+void                nm_setting_vpn_remove_data_item     (NMSettingVPN *setting,
+                                                         const char *key);
 void                nm_setting_vpn_remove_secret        (NMSettingVPN *setting,
                                                          const char *key);
-void                nm_setting_vpn_foreach_secret       (NMSettingVPN *setting,
-                                                         NMVPNIterFunc func,
-                                                         gpointer user_data);

Object Hierarchy

-
-  GEnum
-   +----NMSettingVpnError
-
   GObject
    +----NMSetting
          +----NMSettingVPN
+
+  GEnum
+   +----NMSettingVpnError
+

Properties

@@ -120,15 +117,30 @@ properties.

Details

-

NM_SETTING_VPN_SETTING_NAME

-
#define NM_SETTING_VPN_SETTING_NAME "vpn"
+
NMSettingVPN

+
typedef struct _NMSettingVPN NMSettingVPN;

+

+

+
+
+
+

NMSettingVPNClass

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

-

enum NMSettingVpnError

+

enum NMSettingVpnError

typedef enum {
 	NM_SETTING_VPN_ERROR_UNKNOWN = 0,
 	NM_SETTING_VPN_ERROR_INVALID_PROPERTY,
@@ -159,111 +171,97 @@ required
-

NM_TYPE_SETTING_VPN_ERROR

-
#define NM_TYPE_SETTING_VPN_ERROR (nm_setting_vpn_error_get_type ()) 
-
-

-

-
-
-
-

NM_SETTING_VPN_ERROR

-
#define NM_SETTING_VPN_ERROR nm_setting_vpn_error_quark ()
-
-

-

-
-
-
-

nm_setting_vpn_error_quark ()

-
GQuark              nm_setting_vpn_error_quark          (void);
-

-Registers an error quark for NMSettingVPN if necessary. -

+

NMVPNIterFunc ()

+
void                (*NMVPNIterFunc)                    (const char *key,
+                                                         const char *value,
+                                                         gpointer user_data);
- - - - + + + + + + + + + + + + + +

Returns :

the error quark used for NMSettingVPN errors.

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

NM_SETTING_VPN_SERVICE_TYPE

-
#define NM_SETTING_VPN_SERVICE_TYPE "service-type"
+
NM_SETTING_VPN_DATA

+
#define NM_SETTING_VPN_DATA         "data"
-

NM_SETTING_VPN_USER_NAME

-
#define NM_SETTING_VPN_USER_NAME    "user-name"
+
NM_SETTING_VPN_SECRETS

+
#define NM_SETTING_VPN_SECRETS      "secrets"
-

NM_SETTING_VPN_DATA

-
#define NM_SETTING_VPN_DATA         "data"
+
NM_SETTING_VPN_SERVICE_TYPE

+
#define NM_SETTING_VPN_SERVICE_TYPE "service-type"
-

NM_SETTING_VPN_SECRETS

-
#define NM_SETTING_VPN_SECRETS      "secrets"
+
NM_SETTING_VPN_SETTING_NAME

+
#define NM_SETTING_VPN_SETTING_NAME "vpn"
-

NMSettingVPN

-
typedef struct _NMSettingVPN NMSettingVPN;
+

NM_SETTING_VPN_USER_NAME

+
#define NM_SETTING_VPN_USER_NAME    "user-name"
+

-

NMSettingVPNClass

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

nm_setting_vpn_add_data_item ()

+
void                nm_setting_vpn_add_data_item        (NMSettingVPN *setting,
+                                                         const char *key,
+                                                         const char *item);

+Establishes a relationship between key and item internally in the +setting which may be retrieved later. Should not be used to store passwords +or other secrets, which is what nm_setting_vpn_add_secret() is for.

-
-
-
-

NMVPNIterFunc ()

-
void                (*NMVPNIterFunc)                    (const char *key,
-                                                         const char *value,
-                                                         gpointer user_data);
- - + + - - + + - - + @@ -271,96 +269,109 @@ Registers an error quark for -

nm_setting_vpn_get_type ()

-
GType               nm_setting_vpn_get_type             (void);
+

nm_setting_vpn_add_secret ()

+
void                nm_setting_vpn_add_secret           (NMSettingVPN *setting,
+                                                         const char *key,
+                                                         const char *secret);

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

+

key :

the name of the data or secret item

setting :

the NMSettingVPN +

value :

the value of the data or secret item

key :

a name that uniquely identifies the given value item +

user_data :

User data passed to nm_setting_vpn_foreach_data_item() or -nm_setting_vpn_foreach_secret() +

item :

the value to be referenced by key
++ + + + + + + + + + + + + + +

setting :

the NMSettingVPN +

key :

a name that uniquely identifies the given secret secret +

secret :

the secret to be referenced by key +
-

nm_setting_vpn_new ()

-
NMSetting *         nm_setting_vpn_new                  (void);
+

nm_setting_vpn_error_quark ()

+
GQuark              nm_setting_vpn_error_quark          (void);

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

- +

Returns :

the new empty NMSettingVPN object. [transfer full] -the error quark used for NMSettingVPN errors.
-

nm_setting_vpn_get_service_type ()

-
const char *        nm_setting_vpn_get_service_type     (NMSettingVPN *setting);
+

nm_setting_vpn_foreach_data_item ()

+
void                nm_setting_vpn_foreach_data_item    (NMSettingVPN *setting,
+                                                         NMVPNIterFunc func,
+                                                         gpointer user_data);

-Returns the service name of the VPN, which identifies the specific VPN -plugin that should be used to connect to this VPN. +Iterates all data items stored in this setting. It is safe to add, remove, +and modify data items inside func, though any additions or removals made +during iteration will not be part of the iteration.

- - - - - -

setting :

the NMSettingVPN +a NMSettingVPN

Returns :

the VPN plugin's service name
-
-
-
-

nm_setting_vpn_get_user_name ()

-
const char *        nm_setting_vpn_get_user_name        (NMSettingVPN *setting);
-
-- - - - + - - + +

setting :

the NMSettingVPN +

func :

an user provided function. [scope call]

Returns :

the "user-name" property of the setting

user_data :

data to be passed to func +
-

nm_setting_vpn_add_data_item ()

-
void                nm_setting_vpn_add_data_item        (NMSettingVPN *setting,
-                                                         const char *key,
-                                                         const char *item);
+

nm_setting_vpn_foreach_secret ()

+
void                nm_setting_vpn_foreach_secret       (NMSettingVPN *setting,
+                                                         NMVPNIterFunc func,
+                                                         gpointer user_data);

-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. +Iterates all secrets stored in this setting. It is safe to add, remove, +and modify secrets inside func, though any additions or removals made during +iteration will not be part of the iteration.

- - - + - - + @@ -396,12 +407,12 @@ by -

nm_setting_vpn_remove_data_item ()

-
void                nm_setting_vpn_remove_data_item     (NMSettingVPN *setting,
+
nm_setting_vpn_get_secret ()

+
const char *        nm_setting_vpn_get_secret           (NMSettingVPN *setting,
                                                          const char *key);

 

-Deletes a key/value relationship previously established by
-nm_setting_vpn_add_data_item().
+Retrieves the secret of a key/value relationship previously established
+by nm_setting_vpn_add_secret().

setting :

the NMSettingVPN +a NMSettingVPN

key :

a name that uniquely identifies the given value item +

func :

an user provided function. [scope call]

item :

the value to be referenced by key +

user_data :

data to be passed to func
@@ -413,53 +424,42 @@ Deletes a key/value relationship previously established by - + + + + +

key :

the name of the data item to removethe name of the secret to retrieve

Returns :

the secret, if any
-

nm_setting_vpn_foreach_data_item ()

-
void                nm_setting_vpn_foreach_data_item    (NMSettingVPN *setting,
-                                                         NMVPNIterFunc func,
-                                                         gpointer user_data);
+

nm_setting_vpn_get_service_type ()

+
const char *        nm_setting_vpn_get_service_type     (NMSettingVPN *setting);

-Iterates all data items stored in this setting. It is safe to add, remove, -and modify data items inside func, though any additions or removals made -during iteration will not be part of the iteration. +Returns the service name of the VPN, which identifies the specific VPN +plugin that should be used to connect to this VPN.

- - - - - - - + +

setting :

a NMSettingVPN -

func :

an user provided function. [scope call] +the NMSettingVPN

user_data :

data to be passed to func -

Returns :

the VPN plugin's service name
-

nm_setting_vpn_add_secret ()

-
void                nm_setting_vpn_add_secret           (NMSettingVPN *setting,
-                                                         const char *key,
-                                                         const char *secret);
-

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

+

nm_setting_vpn_get_user_name ()

+
const char *        nm_setting_vpn_get_user_name        (NMSettingVPN *setting);
@@ -469,54 +469,36 @@ setting which may be retrieved later. - - - - - - + +

key :

a name that uniquely identifies the given secret secret -

secret :

the secret to be referenced by key -

Returns :

the "user-name" property of the setting
-

nm_setting_vpn_get_secret ()

-
const char *        nm_setting_vpn_get_secret           (NMSettingVPN *setting,
-                                                         const char *key);
+

nm_setting_vpn_new ()

+
NMSetting *         nm_setting_vpn_new                  (void);

-Retrieves the secret of a key/value relationship previously established -by nm_setting_vpn_add_secret(). +Creates a new NMSettingVPN object with default values.

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

setting :

the NMSettingVPN -

key :

the name of the secret to retrieve

Returns :

the secret, if any
the new empty NMSettingVPN object. [transfer full] +
-

nm_setting_vpn_remove_secret ()

-
void                nm_setting_vpn_remove_secret        (NMSettingVPN *setting,
+
nm_setting_vpn_remove_data_item ()

+
void                nm_setting_vpn_remove_data_item     (NMSettingVPN *setting,
                                                          const char *key);

 

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

 
@@ -528,39 +510,31 @@ Deletes a key/value relationship previously established by
 
-
+

 

 

 
key :
the name of the secret to removethe name of the data item to remove
-

nm_setting_vpn_foreach_secret ()

-
void                nm_setting_vpn_foreach_secret       (NMSettingVPN *setting,
-                                                         NMVPNIterFunc func,
-                                                         gpointer user_data);
+

nm_setting_vpn_remove_secret ()

+
void                nm_setting_vpn_remove_secret        (NMSettingVPN *setting,
+                                                         const char *key);

-Iterates all secrets stored in this setting. It is safe to add, remove, -and modify secrets inside func, though any additions or removals made during -iteration will not be part of the iteration. +Deletes a key/value relationship previously established by +nm_setting_vpn_add_secret().

- - - - - - - + +

setting :

a NMSettingVPN -

func :

an user provided function. [scope call] +the NMSettingVPN

user_data :

data to be passed to func -

key :

the name of the secret to remove
@@ -607,6 +581,6 @@ plugin.
- Generated by GTK-Doc V1.17
+ Generated by GTK-Doc V1.18
\ No newline at end of file -- cgit 1.3.0-6-gf8a5