From 59c3714a494c3b3765657c0551ad82842d98a7d2 Mon Sep 17 00:00:00 2001 From: Sjoerd Simons Date: Sat, 26 Apr 2014 20:55:09 +0200 Subject: Imported Upstream version 0.9.8.10 --- docs/libnm-util/html/NMSettingVPN.html | 1072 ++++++++++++++++++-------------- 1 file changed, 614 insertions(+), 458 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 afbe41bf..57039178 100644 --- a/docs/libnm-util/html/NMSettingVPN.html +++ b/docs/libnm-util/html/NMSettingVPN.html @@ -2,34 +2,28 @@ -NMSettingVPN +libnm-util Reference Manual: NMSettingVPN - + - - - - - - - - - - + + + + + + +
@@ -37,660 +31,822 @@

NMSettingVPN

NMSettingVPN — Describes connection properties for Virtual Private Networks

- +
-
-

Synopsis

-
-#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;
-void                (*NMVPNIterFunc)                    (const char *key,
-                                                         const char *value,
-                                                         gpointer user_data);
-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);
-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);
-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);
-void                nm_setting_vpn_remove_secret        (NMSettingVPN *setting,
-                                                         const char *key);
-void                nm_setting_vpn_foreach_secret       (NMSettingVPN *setting,
-                                                         NMVPNIterFunc func,
-                                                         gpointer user_data);
-
+
+

Functions

+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+GQuark + +nm_setting_vpn_error_quark () +
+void + +(*NMVPNIterFunc) () +
+NMSetting * + +nm_setting_vpn_new () +
const char * + +nm_setting_vpn_get_service_type () +
const char * + +nm_setting_vpn_get_user_name () +
+guint32 + +nm_setting_vpn_get_num_data_items () +
+void + +nm_setting_vpn_add_data_item () +
const char * + +nm_setting_vpn_get_data_item () +
+void + +nm_setting_vpn_remove_data_item () +
+void + +nm_setting_vpn_foreach_data_item () +
+guint32 + +nm_setting_vpn_get_num_secrets () +
+void + +nm_setting_vpn_add_secret () +
const char * + +nm_setting_vpn_get_secret () +
+void + +nm_setting_vpn_remove_secret () +
+void + +nm_setting_vpn_foreach_secret () +
+
+
+

Properties

+
+++++ + + + + + + + + + + + + + + + + + + + + + + +
GHashTable_gchararray+gchararray_*dataRead / Write
GHashTable_gchararray+gchararray_*secretsRead / Write
+gchar *service-typeRead / Write
+gchar *user-nameRead / Write
+
+
+

Types and Values

+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
#defineNM_SETTING_VPN_SETTING_NAME
enumNMSettingVpnError
#defineNM_SETTING_VPN_ERROR
#defineNM_SETTING_VPN_SERVICE_TYPE
#defineNM_SETTING_VPN_USER_NAME
#defineNM_SETTING_VPN_DATA
#defineNM_SETTING_VPN_SECRETS

Object Hierarchy

-
-  GEnum
-   +----NMSettingVpnError
-
-
-  GObject
-   +----NMSetting
-         +----NMSettingVPN
+
    GEnum
+    ╰── NMSettingVpnError
+    GObject
+    ╰── NMSetting
+        ╰── NMSettingVPN
-

Properties

-
-  "data"                     GHashTable_gchararray+gchararray_*  : Read / Write
-  "secrets"                  GHashTable_gchararray+gchararray_*  : Read / Write
-  "service-type"             gchar*                : Read / Write
-  "user-name"                gchar*                : Read / Write
+
Includes

+
#include <nm-setting-vpn.h>

Description

-

-The NMSettingVPN object is a NMSetting subclass that describes properties +

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

+properties.

-

Details

+

Functions

-

NM_SETTING_VPN_SETTING_NAME

-
#define NM_SETTING_VPN_SETTING_NAME "vpn"
-
-

-

+

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.

+

+
-

enum NMSettingVpnError

-
typedef enum {
-	NM_SETTING_VPN_ERROR_UNKNOWN = 0,      /*< nick=UnknownError >*/
-	NM_SETTING_VPN_ERROR_INVALID_PROPERTY, /*< nick=InvalidProperty >*/
-	NM_SETTING_VPN_ERROR_MISSING_PROPERTY, /*< nick=MissingProperty >*/
-} NMSettingVpnError;
-
-
+

NMVPNIterFunc ()

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

Parameters

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

NM_SETTING_VPN_ERROR_UNKNOWN

unknown or unclassified error -

key

the name of the data or secret item

 

NM_SETTING_VPN_ERROR_INVALID_PROPERTY

the property was invalid -

value

the value of the data or secret item

 

NM_SETTING_VPN_ERROR_MISSING_PROPERTY

the property was missing and is -required -

user_data

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

 
+
-

NM_SETTING_VPN_ERROR

-
#define NM_SETTING_VPN_ERROR nm_setting_vpn_error_quark ()
-
-

-

+

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

-
GQuark              nm_setting_vpn_error_quark          (void);
-

-Registers an error quark for NMSettingVPN if necessary. -

-
+

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.

+
+

Parameters

+
--+++ - - + + +

Returns :

the error quark used for NMSettingVPN errors.

setting

the NMSettingVPN

 
-
-
-

NM_SETTING_VPN_SERVICE_TYPE

-
#define NM_SETTING_VPN_SERVICE_TYPE "service-type"
-
-

-

-
-
-
-

NM_SETTING_VPN_USER_NAME

-
#define NM_SETTING_VPN_USER_NAME    "user-name"
-
-

-

-
-
-
-

NM_SETTING_VPN_DATA

-
#define NM_SETTING_VPN_DATA         "data"
-
-

-

-
-
-
-

NM_SETTING_VPN_SECRETS

-
#define NM_SETTING_VPN_SECRETS      "secrets"
-
-

-

-
-
-
-

NMSettingVPN

-
typedef struct _NMSettingVPN NMSettingVPN;
-

-

+
+

Returns

+

the VPN plugin's service name

+

-
-
-

NMSettingVPNClass

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

-

-

NMVPNIterFunc ()

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

nm_setting_vpn_get_user_name ()

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

Parameters

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

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

setting

the NMSettingVPN

 
+
+

Returns

+

the “user-name” property of the setting

+

+
+
-

nm_setting_vpn_new ()

-
NMSetting *         nm_setting_vpn_new                  (void);
-

-Creates a new NMSettingVPN object with default values. -

-
+

nm_setting_vpn_get_num_data_items ()

+
guint32
+nm_setting_vpn_get_num_data_items (NMSettingVPN *setting);
+

Gets number of key/value pairs of VPN configuration data.

+
+

Parameters

+
--+++ - - + + +

Returns :

the new empty NMSettingVPN object. [transfer full] -

setting

the NMSettingVPN

 
+
+

Returns

+

the number of VPN plugin specific configuration data items

+

+
+
-

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

-
+

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.

+
+

Parameters

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

setting :

the NMSettingVPN -

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 -

key

a name that uniquely identifies the given value item +

 

Returns :

the "user-name" property of the setting

item

the value to be referenced by key +

 
+
-

nm_setting_vpn_get_num_data_items ()

-
guint32             nm_setting_vpn_get_num_data_items   (NMSettingVPN *setting);
-

-Gets number of key/value pairs of VPN configuration data. -

-
+

nm_setting_vpn_get_data_item ()

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

+
+

Parameters

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

setting :

the NMSettingVPN -

setting

the NMSettingVPN

 

Returns :

the number of VPN plugin specific configuration data items

key

the name of the data item to retrieve

 
+
+

Returns

+

the data item, if any

+

+
+
-

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

-
+

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

+
+

Parameters

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

setting :

the NMSettingVPN -

key :

a name that uniquely identifies the given value item -

setting

the NMSettingVPN

 

item :

the value to be referenced by key -

key

the name of the data item to remove

 
+
-

nm_setting_vpn_get_data_item ()

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

-
+

nm_setting_vpn_foreach_data_item ()

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

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.

+
+

Parameters

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

setting :

the NMSettingVPN -

setting

a NMSettingVPN

 

key :

the name of the data item to retrieve

func

an user provided function.

[scope call]

Returns :

the data item, if any

user_data

data to be passed to func +

 
+
-

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

-
+

nm_setting_vpn_get_num_secrets ()

+
guint32
+nm_setting_vpn_get_num_secrets (NMSettingVPN *setting);
+

Gets number of VPN plugin specific secrets in the setting.

+
+

Parameters

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

setting :

the NMSettingVPN -

key :

the name of the data item to remove

setting

the NMSettingVPN

 
+
+

Returns

+

the number of VPN plugin specific secrets

+

+
+
-

nm_setting_vpn_foreach_data_item ()

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

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

-
+

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.

+
+

Parameters

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

setting :

a NMSettingVPN -

setting

the NMSettingVPN

 

func :

an user provided function. [scope call] -

key

a name that uniquely identifies the given secret secret +

 

user_data :

data to be passed to func -

secret

the secret to be referenced by key +

 
+
-

nm_setting_vpn_get_num_secrets ()

-
guint32             nm_setting_vpn_get_num_secrets      (NMSettingVPN *setting);
-

-Gets number of VPN plugin specific secrets in the 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().

+
+

Parameters

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

setting :

the NMSettingVPN -

setting

the NMSettingVPN

 

Returns :

the number of VPN plugin specific secrets

key

the name of the secret to retrieve

 
+
+

Returns

+

the secret, if any

+

+
+
-

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_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_secret().

+
+

Parameters

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

setting :

the NMSettingVPN -

key :

a name that uniquely identifies the given secret secret -

setting

the NMSettingVPN

 

secret :

the secret to be referenced by key -

key

the name of the secret to remove

 
+
-

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

-
+

nm_setting_vpn_foreach_secret ()

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

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.

+
+

Parameters

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

setting :

the NMSettingVPN -

setting

a NMSettingVPN

 

key :

the name of the secret to retrieve

func

an user provided function.

[scope call]

Returns :

the secret, if any

user_data

data to be passed to func +

 
-
+ + +
+

Types and Values

-

nm_setting_vpn_remove_secret ()

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

NM_SETTING_VPN_SETTING_NAME

+
#define NM_SETTING_VPN_SETTING_NAME "vpn"
+

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

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

setting :

the NMSettingVPN -

key :

the name of the secret to remove
-

nm_setting_vpn_foreach_secret ()

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

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

-
+

enum NMSettingVpnError

+
+

Members

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

setting :

a NMSettingVPN +

NM_SETTING_VPN_ERROR_UNKNOWN

 +

unknown or unclassified error

 

func :

an user provided function. [scope call] +

NM_SETTING_VPN_ERROR_INVALID_PROPERTY

 +

the property was invalid

 

user_data :

data to be passed to func +

NM_SETTING_VPN_ERROR_MISSING_PROPERTY

 +

the property was missing and is +required

 
-
-

Property Details

+
-

The "data" property

-
  "data"                     GHashTable_gchararray+gchararray_*  : Read / Write
+

NM_SETTING_VPN_ERROR

+
#define NM_SETTING_VPN_ERROR nm_setting_vpn_error_quark ()
+

-Dictionary of key/value pairs of VPN plugin specific data. Both keys -and values must be strings.

-

The "secrets" property

-
  "secrets"                  GHashTable_gchararray+gchararray_*  : Read / Write
+

NM_SETTING_VPN_SERVICE_TYPE

+
#define NM_SETTING_VPN_SERVICE_TYPE "service-type"
+

-Dictionary of key/value pairs of VPN plugin specific secrets like -passwords or private keys. Both keys and values must be strings.

-

The "service-type" property

-
  "service-type"             gchar*                : Read / Write
+

NM_SETTING_VPN_USER_NAME

+
#define NM_SETTING_VPN_USER_NAME    "user-name"
+

-D-Bus service name of the VPN plugin that this setting uses to connect -to its network. i.e. org.freedesktop.NetworkManager.vpnc for the vpnc -plugin.

-

Default value: NULL

-

The "user-name" property

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

NM_SETTING_VPN_DATA

+
#define NM_SETTING_VPN_DATA         "data"
+

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

+
+
+
+

NM_SETTING_VPN_SECRETS

+
#define NM_SETTING_VPN_SECRETS      "secrets"
+
+

+

+
+
+
+

Property Details

+
+

The “data” property

+
  “data”                     GHashTable_gchararray+gchararray_*
+

Dictionary of key/value pairs of VPN plugin specific data. Both keys and values must be strings.

+

Flags: Read / Write

+
+
+
+

The “secrets” property

+
  “secrets”                  GHashTable_gchararray+gchararray_*
+

Dictionary of key/value pairs of VPN plugin specific secrets like passwords or private keys. Both keys and values must be strings.

+

Flags: Read / Write

+
+
+
+

The “service-type” property

+
  “service-type”             gchar *
+

D-Bus service name of the VPN plugin that this setting uses to connect to its network. i.e. org.freedesktop.NetworkManager.vpnc for the vpnc plugin.

+

Flags: Read / Write

+

Default value: NULL

+
+
+
+

The “user-name” property

+
  “user-name”                gchar *
+

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.

+

Flags: Read / Write

Default value: NULL

- Generated by GTK-Doc V1.19
+ Generated by GTK-Doc V1.20 \ No newline at end of file -- cgit 1.3.0-6-gf8a5