From 2c032d8f1c6292c1338a615e6ec40252889ba85c Mon Sep 17 00:00:00 2001 From: Michael Biebl Date: Thu, 22 Jan 2015 00:29:39 +0100 Subject: Imported Upstream version 1.0.0 --- docs/libnm/html/NMSettingVpn.html | 682 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 682 insertions(+) create mode 100644 docs/libnm/html/NMSettingVpn.html (limited to 'docs/libnm/html/NMSettingVpn.html') diff --git a/docs/libnm/html/NMSettingVpn.html b/docs/libnm/html/NMSettingVpn.html new file mode 100644 index 00000000..a83c0145 --- /dev/null +++ b/docs/libnm/html/NMSettingVpn.html @@ -0,0 +1,682 @@ + + + + +NMSettingVpn + + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+

NMSettingVpn

+

NMSettingVpn — Describes connection properties for Virtual Private Networks

+
+
+

Synopsis

+
#define             NM_SETTING_VPN_SETTING_NAME
+#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
+struct              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);
+
+
+
+

Object Hierarchy

+
+  GObject
+   +----NMSetting
+         +----NMSettingVpn
+
+
+
+

Properties

+
+  "data"                     GHashTable*           : Read / Write
+  "persistent"               gboolean              : Read / Write
+  "secrets"                  GHashTable*           : Read / Write
+  "service-type"             gchar*                : Read / Write
+  "user-name"                gchar*                : Read / Write
+
+
+
+

Description

+

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

+
+
+

Details

+
+

NM_SETTING_VPN_SETTING_NAME

+
#define NM_SETTING_VPN_SETTING_NAME "vpn"
+
+

+

+
+
+
+

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_PERSISTENT

+
#define NM_SETTING_VPN_PERSISTENT   "persistent"
+
+

+

+
+
+
+

NM_SETTING_VPN_DATA

+
#define NM_SETTING_VPN_DATA         "data"
+
+

+

+
+
+
+

NM_SETTING_VPN_SECRETS

+
#define NM_SETTING_VPN_SECRETS      "secrets"
+
+

+

+
+
+
+

struct NMSettingVpn

+
struct NMSettingVpn;
+

+

+
+
+
+

NMSettingVpnClass

+
typedef struct {
+	NMSettingClass parent;
+} NMSettingVpnClass;
+
+

+

+
+
+
+

NMVpnIterFunc ()

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

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

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

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 +

Returns :

the "user-name" property of the setting
+
+
+
+

nm_setting_vpn_get_persistent ()

+
gboolean            nm_setting_vpn_get_persistent       (NMSettingVpn *setting);
+
++++ + + + + + + + + + + +

setting :

the NMSettingVpn +

Returns :

the "persistent" property of the setting
+
+
+
+

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

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

setting :

the NMSettingVpn +

Returns :

the number of VPN plugin specific configuration data items
+
+
+
+

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

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

setting :

the NMSettingVpn +

key :

a name that uniquely identifies the given value item +

item :

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

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

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

setting :

the NMSettingVpn +

key :

the name of the data item to retrieve

Returns :

the data item, if any
+
+
+
+

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

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

setting :

the NMSettingVpn +

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

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

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

setting :

a NMSettingVpn +

func :

an user provided function. [scope call] +

user_data :

data to be passed to func +
+
+
+
+

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

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

setting :

the NMSettingVpn +

Returns :

the number of VPN plugin specific secrets
+
+
+
+

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

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

setting :

the NMSettingVpn +

key :

a name that uniquely identifies the given secret secret +

secret :

the secret to be referenced by key +
+
+
+
+

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

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

setting :

the NMSettingVpn +

key :

the name of the secret to retrieve

Returns :

the secret, if any
+
+
+
+

nm_setting_vpn_remove_secret ()

+
gboolean            nm_setting_vpn_remove_secret        (NMSettingVpn *setting,
+                                                         const char *key);
+

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

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

setting :

the NMSettingVpn +

key :

the name of the secret to remove

Returns :

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

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

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

setting :

a NMSettingVpn +

func :

an user provided function. [scope call] +

user_data :

data to be passed to func +
+
+
+
+

Property Details

+
+

The "data" property

+
  "data"                     GHashTable*           : Read / Write
+

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

+

+Type: GHashTable(utf8,utf8) +

+
+
+
+

The "persistent" property

+
  "persistent"               gboolean              : Read / Write
+

+If the VPN service supports persistence, and this property is TRUE, +the VPN will attempt to stay connected across link changes and outages, +until explicitly disconnected. +

+

Default value: FALSE

+
+
+
+

The "secrets" property

+
  "secrets"                  GHashTable*           : Read / Write
+

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

+

+Type: GHashTable(utf8,utf8) +

+
+
+
+

The "service-type" property

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

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

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

+

Default value: NULL

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