From e152ec7bf4ba252ff9d3eb13eabd417b931dac9a Mon Sep 17 00:00:00 2001 From: Iain Lane Date: Mon, 24 Sep 2018 09:29:55 +0100 Subject: Import Upstream version 1.12.2 --- docs/libnm/html/NMSettingVpn.html | 168 ++++++++++++++++++++++++++++---------- 1 file changed, 127 insertions(+), 41 deletions(-) (limited to 'docs/libnm/html/NMSettingVpn.html') diff --git a/docs/libnm/html/NMSettingVpn.html b/docs/libnm/html/NMSettingVpn.html index 8814e6f8..f1fb21f4 100644 --- a/docs/libnm/html/NMSettingVpn.html +++ b/docs/libnm/html/NMSettingVpn.html @@ -8,7 +8,7 @@ - + @@ -73,7 +73,7 @@ -gboolean +gboolean nm_setting_vpn_get_persistent () @@ -81,7 +81,7 @@ -guint32 +guint32 nm_setting_vpn_get_num_data_items () @@ -104,7 +104,7 @@ -gboolean +gboolean nm_setting_vpn_remove_data_item () @@ -119,8 +119,15 @@ +const char ** + + +nm_setting_vpn_get_data_keys () + + + -guint32 +guint32 nm_setting_vpn_get_num_secrets () @@ -143,7 +150,7 @@ -gboolean +gboolean nm_setting_vpn_remove_secret () @@ -158,8 +165,15 @@ +const char ** + + +nm_setting_vpn_get_secret_keys () + + + -guint32 +guint32 nm_setting_vpn_get_timeout () @@ -179,35 +193,35 @@ -GHashTable * +GHashTable * data Read / Write -gboolean +gboolean persistent Read / Write -GHashTable * +GHashTable * secrets Read / Write -gchar * +gchar * service-type Read / Write -guint +guint timeout Read / Write -gchar * +gchar * user-name Read / Write @@ -259,7 +273,7 @@

Object Hierarchy

-
    GObject
+
    GObject
     ╰── NMSetting
         ╰── NMSettingVpn
 
@@ -281,7 +295,7 @@ properties.

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

Parameters

@@ -378,7 +392,7 @@ nm_setting_vpn_get_user_name (

nm_setting_vpn_get_persistent ()

-
gboolean
+
gboolean
 nm_setting_vpn_get_persistent (NMSettingVpn *setting);

Parameters

@@ -403,7 +417,7 @@ nm_setting_vpn_get_persistent (

nm_setting_vpn_get_num_data_items ()

-
guint32
+
guint32
 nm_setting_vpn_get_num_data_items (NMSettingVpn *setting);

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

@@ -506,7 +520,7 @@ by

nm_setting_vpn_remove_data_item ()

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

Deletes a key/value relationship previously established by @@ -535,8 +549,8 @@ nm_setting_vpn_remove_data_item (

Returns

-

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

+

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


@@ -545,7 +559,7 @@ nm_setting_vpn_remove_data_item (void nm_setting_vpn_foreach_data_item (NMSettingVpn *setting, NMVpnIterFunc func, - gpointer user_data);
+ 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 @@ -581,8 +595,47 @@ during iteration will not be part of the iteration.


+

nm_setting_vpn_get_data_keys ()

+
const char **
+nm_setting_vpn_get_data_keys (NMSettingVpn *setting,
+                              guint *out_length);
+

Retrieves every data key inside setting +, as an array.

+
+

Parameters

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

setting

the NMSettingVpn

 

out_length

(out): the length of the returned array.

[allow-none]
+
+
+

Returns

+

a +NULL-terminated array containing each data key or NULL if +there are no data items.

+

[array length=out_length][transfer container]

+
+

Since: 1.12

+
+
+

nm_setting_vpn_get_num_secrets ()

-
guint32
+
guint32
 nm_setting_vpn_get_num_secrets (NMSettingVpn *setting);

Gets number of VPN plugin specific secrets in the setting.

@@ -684,7 +737,7 @@ by

nm_setting_vpn_remove_secret ()

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

Deletes a key/value relationship previously established by @@ -713,8 +766,8 @@ nm_setting_vpn_remove_secret (

Returns

-

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

+

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


@@ -723,7 +776,7 @@ nm_setting_vpn_remove_secret (void nm_setting_vpn_foreach_secret (NMSettingVpn *setting, NMVpnIterFunc func, - gpointer user_data); + 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 @@ -759,8 +812,47 @@ iteration will not be part of the iteration.


+

nm_setting_vpn_get_secret_keys ()

+
const char **
+nm_setting_vpn_get_secret_keys (NMSettingVpn *setting,
+                                guint *out_length);
+

Retrieves every secret key inside setting +, as an array.

+
+

Parameters

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

setting

the NMSettingVpn

 

out_length

(out): the length of the returned array.

[allow-none]
+
+
+

Returns

+

a +NULL-terminated array containing each secret key or NULL if +there are no secrets.

+

[array length=out_length][transfer container]

+
+

Since: 1.12

+
+
+

nm_setting_vpn_get_timeout ()

-
guint32
+
guint32
 nm_setting_vpn_get_timeout (NMSettingVpn *setting);

Parameters

@@ -838,17 +930,14 @@ nm_setting_vpn_get_timeout (

Property Details

The “data” property

-
  “data”                     GHashTable *
-

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

-

Type: GHashTable(utf8,utf8)

+
  “data”                     GHashTable *

Flags: Read / Write


The “persistent” property

-
  “persistent”               gboolean
-

If the VPN service supports persistence, and this property is TRUE, +

  “persistent”               gboolean
+

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.

Flags: Read / Write

@@ -857,16 +946,13 @@ until explicitly disconnected.


The “secrets” property

-
  “secrets”                  GHashTable *
-

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)

+
  “secrets”                  GHashTable *

Flags: Read / Write


The “service-type” property

-
  “service-type”             gchar *
+
  “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.

@@ -876,7 +962,7 @@ plugin.


The “timeout” property

-
  “timeout”                  guint
+
  “timeout”                  guint

Timeout for the VPN service to establish the connection. Some services may take quite a long time to connect. Value of 0 means a default timeout, which is 60 seconds (unless overridden @@ -889,7 +975,7 @@ timeout in seconds.


The “user-name” property

-
  “user-name”                gchar *
+
  “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 @@ -902,6 +988,6 @@ VPN connection.

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