From 2e5fa45ddfbb5cffa1e78221f1cea706e2f298af Mon Sep 17 00:00:00 2001 From: Michael Biebl Date: Wed, 31 Jul 2019 10:51:42 +0200 Subject: New upstream version 1.19.90 --- docs/libnm-util/html/NMSettingVPN.html | 909 --------------------------------- 1 file changed, 909 deletions(-) delete mode 100644 docs/libnm-util/html/NMSettingVPN.html (limited to 'docs/libnm-util/html/NMSettingVPN.html') diff --git a/docs/libnm-util/html/NMSettingVPN.html b/docs/libnm-util/html/NMSettingVPN.html deleted file mode 100644 index be421f2f..00000000 --- a/docs/libnm-util/html/NMSettingVPN.html +++ /dev/null @@ -1,909 +0,0 @@ - - - - -NMSettingVPN: libnm-util Reference Manual - - - - - - - - - - - - - - - - -
-
-
- - -
-

NMSettingVPN

-

NMSettingVPN — Describes connection properties for Virtual Private Networks

-
-
-

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_*dataRead / Write
gbooleanpersistentRead / 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_PERSISTENT
#defineNM_SETTING_VPN_DATA
#defineNM_SETTING_VPN_SECRETS
-
-
-

Object Hierarchy

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

Includes

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

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.

-
-
-

Functions

-
-

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.

-
-
-
-
-

NMVPNIterFunc ()

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

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

 
-
-
-
-
-

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.

-
-

Parameters

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

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

Parameters

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

setting

the NMSettingVPN

 
-
-
-

Returns

-

the “user-name” property of the setting

-
-
-
-
-

nm_setting_vpn_get_persistent ()

-
gboolean
-nm_setting_vpn_get_persistent (NMSettingVPN *setting);
-
-

Parameters

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

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.

-
-

Parameters

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

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.

-
-

Parameters

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

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

-
-

Parameters

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

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

-
-

Parameters

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

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.

-
-

Parameters

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

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.

-
-

Parameters

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

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.

-
-

Parameters

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

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

-
-

Parameters

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

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

-
-

Parameters

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

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.

-
-

Parameters

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

setting

a NMSettingVPN

 

func

an user provided function.

[scope call]

user_data

data to be passed to func -

 
-
-
-
-
-

Types and Values

-
-

NM_SETTING_VPN_SETTING_NAME

-
#define NM_SETTING_VPN_SETTING_NAME "vpn"
-
-
-
-
-

enum NMSettingVpnError

-
-

Members

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

NM_SETTING_VPN_ERROR_UNKNOWN

 -

unknown or unclassified error

-		 

NM_SETTING_VPN_ERROR_INVALID_PROPERTY

 -

the property was invalid

-		 

NM_SETTING_VPN_ERROR_MISSING_PROPERTY

 -

the property was missing and is -required

-		 
-
-
-
-
-

NM_SETTING_VPN_ERROR

-
#define NM_SETTING_VPN_ERROR nm_setting_vpn_error_quark ()
-
-
-
-
-

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

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 “persistent” property

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

-

Default value: FALSE

-
-
-
-

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.29
- - \ No newline at end of file -- cgit 1.3.0-6-gf8a5