NMSettingVPN

@@ -37,716 +31,893 @@

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_PERSISTENT
-#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);
-gboolean            nm_setting_vpn_get_persistent       (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);
-gboolean            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);
-gboolean            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 () +
+gboolean +	+nm_setting_vpn_get_persistent () +
+guint32 +	+nm_setting_vpn_get_num_data_items () +
+void +	+nm_setting_vpn_add_data_item () +
const char * +	+nm_setting_vpn_get_data_item () +
+gboolean +	+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 () +
+gboolean +	+nm_setting_vpn_remove_secret () +
+void +	+nm_setting_vpn_foreach_secret () +

Properties

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

GHashTable_gchararray+gchararray_*	data	Read / Write
gboolean	persistent	Read / Write
GHashTable_gchararray+gchararray_*	secrets	Read / Write
+gchar *	service-type	Read / Write
+gchar *	user-name	Read / Write

Types and Values

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

#define	NM_SETTING_VPN_SETTING_NAME
enum	NMSettingVpnError
#define	NM_SETTING_VPN_ERROR
#define	NM_SETTING_VPN_SERVICE_TYPE
#define	NM_SETTING_VPN_USER_NAME
#define	NM_SETTING_VPN_PERSISTENT
#define	NM_SETTING_VPN_DATA
#define	NM_SETTING_VPN_SECRETS

Object Hierarchy

-  GEnum
-   +----NMSettingVpnError
-

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

Properties

-  "data"                     GHashTable_gchararray+gchararray_*  : Read / Write
-  "persistent"               gboolean              : 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"
-

Returns

the VPN plugin's service name

NM_SETTING_VPN_USER_NAME

#define NM_SETTING_VPN_USER_NAME    "user-name"
-

NM_SETTING_VPN_PERSISTENT

#define NM_SETTING_VPN_PERSISTENT   "persistent"
-

nm_setting_vpn_get_user_name ()

const char *
+nm_setting_vpn_get_user_name (NMSettingVPN *setting);

Parameters

+++++ + + + + + +

setting

the NMSettingVPN

NM_SETTING_VPN_DATA

#define NM_SETTING_VPN_DATA         "data"
-

Returns

the “user-name” property of the setting

NM_SETTING_VPN_SECRETS

#define NM_SETTING_VPN_SECRETS      "secrets"
-

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

NMVPNIterFunc ()

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

nm_setting_vpn_get_persistent ()

gboolean
+nm_setting_vpn_get_persistent (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 “persistent” 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 -
Returns :	the VPN plugin's service name	setting	the NMSettingVPN

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

gboolean            nm_setting_vpn_get_persistent       (NMSettingVPN *setting);

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 "persistent" property of the setting	key	the name of the data item to retrieve

Returns

the data item, if any

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

gboolean
+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 -	setting	the NMSettingVPN
Returns :	the number of VPN plugin specific configuration data items	key	the name of the data item to remove

Returns

TRUE if the data item was found and removed from the internal list, +FALSE if it was not.

`setting` :	the NMSettingVPN -	setting	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` +

`setting` :	the NMSettingVPN -	setting	a NMSettingVPN
`key` :	a name that uniquely identifies the given secret `secret` -	func	an user provided function.	[scope call]
`secret` :	the secret to be referenced by `key` -	user_data	data to be passed to `func` +

`setting` :	a NMSettingVPN -
`func` :	an user provided function. [scope call] -
`user_data` :	data to be passed to `func` -

			libnm-util Reference Manual
-Top - \| - Description - \| - Object Hierarchy - \| - Properties -

`setting` :	the NMSettingVPN +	NM_SETTING_VPN_ERROR_UNKNOWN	+ unknown or unclassified error
`key` :	the name of the secret to retrieve	NM_SETTING_VPN_ERROR_INVALID_PROPERTY	+ the property was invalid +
Returns :	the secret, if any	NM_SETTING_VPN_ERROR_MISSING_PROPERTY	+ the property was missing and is +required +

NMSettingVPN

Synopsis

Functions

Properties

Types and Values

Object Hierarchy

Properties

Includes

Description

Details

Functions

NM_SETTING_VPN_SETTING_NAME

nm_setting_vpn_error_quark ()

Returns

enum NMSettingVpnError

NMVPNIterFunc ()

Parameters

NM_SETTING_VPN_ERROR

nm_setting_vpn_new ()

Returns

nm_setting_vpn_error_quark ()

nm_setting_vpn_get_service_type ()

Parameters

NM_SETTING_VPN_SERVICE_TYPE

Returns

NM_SETTING_VPN_USER_NAME

NM_SETTING_VPN_PERSISTENT

nm_setting_vpn_get_user_name ()

Parameters

NM_SETTING_VPN_DATA

Returns

NM_SETTING_VPN_SECRETS

NMSettingVPN

NMSettingVPNClass

NMVPNIterFunc ()

nm_setting_vpn_get_persistent ()

Parameters

Returns

nm_setting_vpn_new ()

nm_setting_vpn_get_num_data_items ()

Parameters

Returns

nm_setting_vpn_get_service_type ()

nm_setting_vpn_add_data_item ()

Parameters

nm_setting_vpn_get_user_name ()

nm_setting_vpn_get_persistent ()

nm_setting_vpn_get_data_item ()

Parameters

Returns

nm_setting_vpn_get_num_data_items ()

nm_setting_vpn_remove_data_item ()

Parameters

Returns

nm_setting_vpn_add_data_item ()

nm_setting_vpn_foreach_data_item ()

Parameters

nm_setting_vpn_get_data_item ()

nm_setting_vpn_get_num_secrets ()

Parameters

Returns

nm_setting_vpn_remove_data_item ()

nm_setting_vpn_add_secret ()

Parameters

nm_setting_vpn_foreach_data_item ()

nm_setting_vpn_get_secret ()

Parameters

Returns

nm_setting_vpn_get_num_secrets ()

nm_setting_vpn_remove_secret ()

Parameters

Returns

nm_setting_vpn_add_secret ()

nm_setting_vpn_foreach_secret ()

Parameters

Types and Values

nm_setting_vpn_get_secret ()

NM_SETTING_VPN_SETTING_NAME

enum NMSettingVpnError

Members

The `"data"` property

The `"persistent"` property

The `"secrets"` property

The `"service-type"` property

The `“data”` property

The `“persistent”` property

The `“secrets”` property

The `“service-type”` property

The `"user-name"` property

The `“user-name”` property