From a4256940da049f91bbbea5e53e469a59ea9c10f7 Mon Sep 17 00:00:00 2001 From: Sjoerd Simons Date: Fri, 25 Oct 2013 21:20:58 +0200 Subject: Imported Upstream version 0.9.8.8 --- docs/libnm-util/html/NMSettingVPN.html | 486 ++++++++++++++++++--------------- 1 file changed, 267 insertions(+), 219 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 d686803b..afbe41bf 100644 --- a/docs/libnm-util/html/NMSettingVPN.html +++ b/docs/libnm-util/html/NMSettingVPN.html @@ -3,12 +3,12 @@ NMSettingVPN - + - + @@ -44,57 +44,57 @@ 
 #include <nm-setting-vpn.h>
 
+#define             NM_SETTING_VPN_SETTING_NAME
+enum                NMSettingVpnError;
+#define             NM_SETTING_VPN_ERROR
+GQuark              nm_setting_vpn_error_quark          (void);
+#define             NM_SETTING_VPN_SERVICE_TYPE
+#define             NM_SETTING_VPN_USER_NAME
+#define             NM_SETTING_VPN_DATA
+#define             NM_SETTING_VPN_SECRETS
                     NMSettingVPN;
                     NMSettingVPNClass;
-enum                NMSettingVpnError;
 void                (*NMVPNIterFunc)                    (const char *key,
                                                          const char *value,
                                                          gpointer user_data);
-#define             NM_SETTING_VPN_DATA
-#define             NM_SETTING_VPN_ERROR
-#define             NM_SETTING_VPN_SECRETS
-#define             NM_SETTING_VPN_SERVICE_TYPE
-#define             NM_SETTING_VPN_SETTING_NAME
-#define             NM_SETTING_VPN_USER_NAME
+NMSetting *         nm_setting_vpn_new                  (void);
+const char *        nm_setting_vpn_get_service_type     (NMSettingVPN *setting);
+const char *        nm_setting_vpn_get_user_name        (NMSettingVPN *setting);
+guint32             nm_setting_vpn_get_num_data_items   (NMSettingVPN *setting);
 void                nm_setting_vpn_add_data_item        (NMSettingVPN *setting,
                                                          const char *key,
                                                          const char *item);
-void                nm_setting_vpn_add_secret           (NMSettingVPN *setting,
-                                                         const char *key,
-                                                         const char *secret);
-GQuark              nm_setting_vpn_error_quark          (void);
+const char *        nm_setting_vpn_get_data_item        (NMSettingVPN *setting,
+                                                         const char *key);
+void                nm_setting_vpn_remove_data_item     (NMSettingVPN *setting,
+                                                         const char *key);
 void                nm_setting_vpn_foreach_data_item    (NMSettingVPN *setting,
                                                          NMVPNIterFunc func,
                                                          gpointer user_data);
-void                nm_setting_vpn_foreach_secret       (NMSettingVPN *setting,
-                                                         NMVPNIterFunc func,
-                                                         gpointer user_data);
-const char *        nm_setting_vpn_get_data_item        (NMSettingVPN *setting,
-                                                         const char *key);
-guint32             nm_setting_vpn_get_num_data_items   (NMSettingVPN *setting);
 guint32             nm_setting_vpn_get_num_secrets      (NMSettingVPN *setting);
+void                nm_setting_vpn_add_secret           (NMSettingVPN *setting,
+                                                         const char *key,
+                                                         const char *secret);
 const char *        nm_setting_vpn_get_secret           (NMSettingVPN *setting,
                                                          const char *key);
-const char *        nm_setting_vpn_get_service_type     (NMSettingVPN *setting);
-const char *        nm_setting_vpn_get_user_name        (NMSettingVPN *setting);
-NMSetting *         nm_setting_vpn_new                  (void);
-void                nm_setting_vpn_remove_data_item     (NMSettingVPN *setting,
-                                                         const char *key);
 void                nm_setting_vpn_remove_secret        (NMSettingVPN *setting,
                                                          const char *key);
+void                nm_setting_vpn_foreach_secret       (NMSettingVPN *setting,
+                                                         NMVPNIterFunc func,
+                                                         gpointer user_data);

Object Hierarchy

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

Properties

@@ -120,23 +120,8 @@ properties.

Details

-

NMSettingVPN

-
typedef struct _NMSettingVPN NMSettingVPN;
-

-

-
-
-
-

NMSettingVPNClass

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

+
#define NM_SETTING_VPN_SETTING_NAME "vpn"
 

 

 

@@ -150,8 +135,11 @@ properties.
 	NM_SETTING_VPN_ERROR_MISSING_PROPERTY, /*< nick=MissingProperty >*/
 } NMSettingVpnError;
-
+
+++ @@ -174,105 +162,109 @@ required
-

NMVPNIterFunc ()

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

NM_SETTING_VPN_ERROR_UNKNOWN
+

NM_SETTING_VPN_ERROR

+
#define NM_SETTING_VPN_ERROR nm_setting_vpn_error_quark ()
+
+

+

+ +
+
+

nm_setting_vpn_error_quark ()

+
GQuark              nm_setting_vpn_error_quark          (void);
+

+Registers an error quark for NMSettingVPN if necessary. +

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

key :

the name of the data or secret item

value :

the value of the data or secret item

user_data :

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

Returns :

the error quark used for NMSettingVPN errors.
-

NM_SETTING_VPN_DATA

-
#define NM_SETTING_VPN_DATA         "data"
+
NM_SETTING_VPN_SERVICE_TYPE

+
#define NM_SETTING_VPN_SERVICE_TYPE "service-type"
-

NM_SETTING_VPN_ERROR

-
#define NM_SETTING_VPN_ERROR nm_setting_vpn_error_quark ()
+
NM_SETTING_VPN_USER_NAME

+
#define NM_SETTING_VPN_USER_NAME    "user-name"
-

NM_SETTING_VPN_SECRETS

-
#define NM_SETTING_VPN_SECRETS      "secrets"
+
NM_SETTING_VPN_DATA

+
#define NM_SETTING_VPN_DATA         "data"
-

NM_SETTING_VPN_SERVICE_TYPE

-
#define NM_SETTING_VPN_SERVICE_TYPE "service-type"
+
NM_SETTING_VPN_SECRETS

+
#define NM_SETTING_VPN_SECRETS      "secrets"
-

NM_SETTING_VPN_SETTING_NAME

-
#define NM_SETTING_VPN_SETTING_NAME "vpn"
-
+

NMSettingVPN

+
typedef struct _NMSettingVPN NMSettingVPN;

-

NM_SETTING_VPN_USER_NAME

-
#define NM_SETTING_VPN_USER_NAME    "user-name"
+
NMSettingVPNClass

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

nm_setting_vpn_add_data_item ()

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

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

-
+

NMVPNIterFunc ()

+
void                (*NMVPNIterFunc)                    (const char *key,
+                                                         const char *value,
+                                                         gpointer user_data);
+
+++ - - + + - - + + - - + @@ -280,16 +272,36 @@ or other secrets, which is what -

nm_setting_vpn_add_secret ()

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

nm_setting_vpn_new ()

+
NMSetting *         nm_setting_vpn_new                  (void);

-Establishes a relationship between key and secret internally in the -setting which may be retrieved later. +Creates a new NMSettingVPN object with default values.

-

setting :

the NMSettingVPN -

key :

the name of the data or secret item

key :

a name that uniquely identifies the given value item -

value :

the value of the data or secret item

item :

the value to be referenced by key +

user_data :

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

Returns :

the new empty NMSettingVPN object. [transfer full] +
+
+
+
+

nm_setting_vpn_get_service_type ()

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

+Returns the service name of the VPN, which identifies the specific VPN +plugin that should be used to connect to this VPN. +

+
++++ @@ -297,92 +309,89 @@ setting which may be retrieved later. - - - - - - + +

setting :

key :

a name that uniquely identifies the given secret secret -

secret :

the secret to be referenced by key -

Returns :

the VPN plugin's service name
-

nm_setting_vpn_error_quark ()

-
GQuark              nm_setting_vpn_error_quark          (void);
-

-Registers an error quark for NMSettingVPN if necessary. -

-
+

nm_setting_vpn_get_user_name ()

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

setting :

the NMSettingVPN +

Returns :

the error quark used for NMSettingVPN errors.
the "user-name" property of the setting
-

nm_setting_vpn_foreach_data_item ()

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

nm_setting_vpn_get_num_data_items ()

+
guint32             nm_setting_vpn_get_num_data_items   (NMSettingVPN *setting);

-Iterates all data items stored in this setting. It is safe to add, remove, -and modify data items inside func, though any additions or removals made -during iteration will not be part of the iteration. +Gets number of key/value pairs of VPN configuration data.

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

setting :

a NMSettingVPN -

func :

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

user_data :

data to be passed to func -

Returns :

the number of VPN plugin specific configuration data items
-

nm_setting_vpn_foreach_secret ()

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

nm_setting_vpn_add_data_item ()

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

-Iterates all secrets stored in this setting. It is safe to add, remove, -and modify secrets inside func, though any additions or removals made during -iteration will not be part of the iteration. +Establishes a relationship between key and item internally in the +setting which may be retrieved later. Should not be used to store passwords +or other secrets, which is what nm_setting_vpn_add_secret() is for.

-
+
+++ - - - + - - + @@ -397,8 +406,11 @@ iteration will not be part of the iteration. Retrieves the data item of a key/value relationship previously established by nm_setting_vpn_add_data_item().

-

setting :

a NMSettingVPN +the NMSettingVPN

func :

an user provided function. [scope call] +

key :

a name that uniquely identifies the given value item

user_data :

data to be passed to func +

item :

the value to be referenced by key
+
+++ @@ -418,13 +430,18 @@ by -

nm_setting_vpn_get_num_data_items ()

-
guint32             nm_setting_vpn_get_num_data_items   (NMSettingVPN *setting);
+

nm_setting_vpn_remove_data_item ()

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

-Gets number of key/value pairs of VPN configuration data. +Deletes a key/value relationship previously established by +nm_setting_vpn_add_data_item().

-

setting :
+
+++ @@ -432,45 +449,59 @@ Gets number of key/value pairs of VPN configuration data. - - + +

setting :

Returns :

the number of VPN plugin specific configuration data items

key :

the name of the data item to remove
-

nm_setting_vpn_get_num_secrets ()

-
guint32             nm_setting_vpn_get_num_secrets      (NMSettingVPN *setting);
+

nm_setting_vpn_foreach_data_item ()

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

-Gets number of VPN plugin specific secrets in the setting. +Iterates all data items stored in this setting. It is safe to add, remove, +and modify data items inside func, though any additions or removals made +during iteration will not be part of the iteration.

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

setting :

the NMSettingVPN +a NMSettingVPN

Returns :

the number of VPN plugin specific secrets

func :

an user provided function. [scope call] +

user_data :

data to be passed to func +
-

nm_setting_vpn_get_secret ()

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

nm_setting_vpn_get_num_secrets ()

+
guint32             nm_setting_vpn_get_num_secrets      (NMSettingVPN *setting);

-Retrieves the secret of a key/value relationship previously established -by nm_setting_vpn_add_secret(). +Gets number of VPN plugin specific secrets in the setting.

-
+
+++ @@ -478,26 +509,27 @@ by key :

- - - - +

setting :

the name of the secret to retrieve

Returns :

the secret, if anythe number of VPN plugin specific secrets
-

nm_setting_vpn_get_service_type ()

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

nm_setting_vpn_add_secret ()

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

-Returns the service name of the VPN, which identifies the specific VPN -plugin that should be used to connect to this VPN. +Establishes a relationship between key and secret internally in the +setting which may be retrieved later.

-
+
+++ @@ -505,18 +537,32 @@ plugin that should be used to connect to this VPN. - - + + + + + +

setting :

Returns :

the VPN plugin's service name

key :

a name that uniquely identifies the given secret secret +

secret :

the secret to be referenced by key +
-

nm_setting_vpn_get_user_name ()

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

nm_setting_vpn_get_secret ()

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

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

+
+++ @@ -524,39 +570,30 @@ plugin that should be used to connect to this VPN. + + + + - +

setting :

key :

the name of the secret to retrieve

Returns :

the "user-name" property of the settingthe secret, if any
-

nm_setting_vpn_new ()

-
NMSetting *         nm_setting_vpn_new                  (void);
-

-Creates a new NMSettingVPN object with default values. -

-
-- - - - -

Returns :

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

nm_setting_vpn_remove_data_item ()

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

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

 

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

-

+

+++
@@ -565,31 +602,42 @@ Deletes a key/value relationship previously established by
 
-
+

 


 
 

 
setting :

 

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

nm_setting_vpn_remove_secret ()

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

nm_setting_vpn_foreach_secret ()

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

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

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

setting :

the NMSettingVPN +a NMSettingVPN

key :

the name of the secret to remove

func :

an user provided function. [scope call] +

user_data :

data to be passed to func +
@@ -643,6 +691,6 @@ VPN connection.
- Generated by GTK-Doc V1.18
+ Generated by GTK-Doc V1.19
\ No newline at end of file -- cgit 1.3.0-6-gf8a5