Blame docs/libnm/html/NMVpnPluginOld.html

Packit 5756e2
Packit 5756e2
<html>
Packit 5756e2
<head>
Packit 5756e2
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
Packit 5756e2
<title>NMVpnPluginOld: libnm Reference Manual</title>
Packit 5756e2
<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot">
Packit 5756e2
<link rel="home" href="index.html" title="libnm Reference Manual">
Packit 5756e2
<link rel="up" href="ch06.html" title="VPN Plugin API Reference">
Packit 5756e2
<link rel="prev" href="NMVpnEditorPlugin.html" title="NMVpnEditorPlugin">
Packit 5756e2
<link rel="next" href="object-tree.html" title="Object Hierarchy">
Packit Service 5ffa24
<meta name="generator" content="GTK-Doc V1.33.1 (XML mode)">
Packit 5756e2
<link rel="stylesheet" href="style.css" type="text/css">
Packit 5756e2
</head>
Packit 5756e2
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
Packit 5756e2
Packit 5756e2
Packit 5756e2
Top  | 
Packit 5756e2
                  Description  | 
Packit 5756e2
                  Object Hierarchy  | 
Packit 5756e2
                  Implemented Interfaces  | 
Packit 5756e2
                  Properties  | 
Packit 5756e2
                  Signals
Packit 5756e2
Packit 5756e2
Home
Packit 5756e2
Up
Packit 5756e2
Prev
Packit 5756e2
Next
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2

NMVpnPluginOld

Packit 5756e2

NMVpnPluginOld

Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2

Functions

Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
GDBusConnection *
Packit 5756e2
Packit 5756e2
Packit 5756e2
nm_vpn_plugin_old_get_connection ()
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
NMVpnServiceState
Packit 5756e2
Packit 5756e2
Packit 5756e2
nm_vpn_plugin_old_get_state ()
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
void
Packit 5756e2
Packit 5756e2
Packit 5756e2
nm_vpn_plugin_old_set_state ()
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
void
Packit 5756e2
Packit 5756e2
Packit 5756e2
nm_vpn_plugin_old_secrets_required ()
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
void
Packit 5756e2
Packit 5756e2
Packit 5756e2
nm_vpn_plugin_old_set_login_banner ()
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
void
Packit 5756e2
Packit 5756e2
Packit 5756e2
nm_vpn_plugin_old_failure ()
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
void
Packit 5756e2
Packit 5756e2
Packit 5756e2
nm_vpn_plugin_old_set_config ()
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
void
Packit 5756e2
Packit 5756e2
Packit 5756e2
nm_vpn_plugin_old_set_ip4_config ()
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
void
Packit 5756e2
Packit 5756e2
Packit 5756e2
nm_vpn_plugin_old_set_ip6_config ()
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
gboolean
Packit 5756e2
Packit 5756e2
Packit 5756e2
nm_vpn_plugin_old_disconnect ()
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
gboolean
Packit 5756e2
Packit 5756e2
Packit 5756e2
nm_vpn_plugin_old_read_vpn_details ()
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
gboolean
Packit 5756e2
Packit 5756e2
Packit 5756e2
nm_vpn_plugin_old_get_secret_flags ()
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2

Properties

Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit Service a1bd4f
char *
Packit 5756e2
service-name
Packit 5756e2
Read / Write / Construct Only
Packit 5756e2
Packit 5756e2
Packit 5756e2
NMVpnServiceState
Packit 5756e2
state
Packit 5756e2
Read / Write
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2

Signals

Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
void
Packit 5756e2
config
Packit 5756e2
Run First
Packit 5756e2
Packit 5756e2
Packit 5756e2
void
Packit 5756e2
failure
Packit 5756e2
Run First
Packit 5756e2
Packit 5756e2
Packit 5756e2
void
Packit 5756e2
ip4-config
Packit 5756e2
Run First
Packit 5756e2
Packit 5756e2
Packit 5756e2
void
Packit 5756e2
ip6-config
Packit 5756e2
Run First
Packit 5756e2
Packit 5756e2
Packit 5756e2
void
Packit 5756e2
login-banner
Packit 5756e2
Run First
Packit 5756e2
Packit 5756e2
Packit 5756e2
void
Packit 5756e2
quit
Packit 5756e2
Run First
Packit 5756e2
Packit 5756e2
Packit 5756e2
void
Packit 5756e2
secrets-required
Packit 5756e2
Run First
Packit 5756e2
Packit 5756e2
Packit 5756e2
void
Packit 5756e2
state-changed
Packit 5756e2
Run First
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2

Types and Values

Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
#define
Packit 5756e2
NM_VPN_PLUGIN_OLD_DBUS_SERVICE_NAME
Packit 5756e2
Packit 5756e2
Packit 5756e2
#define
Packit 5756e2
NM_VPN_PLUGIN_OLD_STATE
Packit 5756e2
Packit 5756e2
Packit 5756e2
 
Packit 5756e2
NMVpnPluginOld
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2

Object Hierarchy

Packit 5756e2
    GObject
Packit 5756e2
    ╰── NMVpnPluginOld
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2

Implemented Interfaces

Packit 5756e2

Packit 5756e2
NMVpnPluginOld implements
Packit 5756e2
 GInitable.

Packit 5756e2
Packit 5756e2
Packit 5756e2

Description

Packit 5756e2
Packit 5756e2
Packit 5756e2

Functions

Packit 5756e2
Packit 5756e2

nm_vpn_plugin_old_get_connection ()

Packit 5756e2
GDBusConnection *
Packit 5756e2
nm_vpn_plugin_old_get_connection (NMVpnPluginOld *plugin);
Packit 5756e2
Packit 5756e2

nm_vpn_plugin_old_get_connection has been deprecated since version 1.2 and should not be used in newly-written code.

Packit 5756e2

Replaced by NMVpnServicePlugin.

Packit 5756e2
Packit 5756e2
Packit 5756e2

Returns

Packit 5756e2

.

Packit Service 5ffa24

[transfer full]

Packit 5756e2
Packit 5756e2
Packit 5756e2

Packit 5756e2
Packit 5756e2

nm_vpn_plugin_old_get_state ()

Packit 5756e2
NMVpnServiceState
Packit 5756e2
nm_vpn_plugin_old_get_state (NMVpnPluginOld *plugin);
Packit 5756e2
Packit 5756e2

nm_vpn_plugin_old_get_state has been deprecated since version 1.2 and should not be used in newly-written code.

Packit 5756e2

Replaced by NMVpnServicePlugin.

Packit 5756e2
Packit 5756e2
Packit 5756e2

Packit 5756e2
Packit 5756e2

nm_vpn_plugin_old_set_state ()

Packit 5756e2
void
Packit 5756e2
nm_vpn_plugin_old_set_state (NMVpnPluginOld *plugin,
Packit 5756e2
                             NMVpnServiceState state);
Packit 5756e2
Packit 5756e2

nm_vpn_plugin_old_set_state has been deprecated since version 1.2 and should not be used in newly-written code.

Packit 5756e2

Replaced by NMVpnServicePlugin.

Packit 5756e2
Packit 5756e2
Packit 5756e2

Packit 5756e2
Packit 5756e2

nm_vpn_plugin_old_secrets_required ()

Packit 5756e2
void
Packit 5756e2
nm_vpn_plugin_old_secrets_required (NMVpnPluginOld *plugin,
Packit 5756e2
                                    const char *message,
Packit 5756e2
                                    const char **hints);
Packit 5756e2
Packit 5756e2

nm_vpn_plugin_old_secrets_required has been deprecated since version 1.2 and should not be used in newly-written code.

Packit 5756e2

Replaced by NMVpnServicePlugin.

Packit 5756e2
Packit 5756e2

Called by VPN plugin implementations to signal to NetworkManager that secrets

Packit 5756e2
are required during the connection process.  This signal may be used to
Packit 5756e2
request new secrets when the secrets originally provided by NetworkManager
Packit 5756e2
are insufficient, or the VPN process indicates that it needs additional
Packit 5756e2
information to complete the request.

Packit 5756e2
Packit 5756e2

Parameters

Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2

plugin

Packit 5756e2

the NMVpnPluginOld

Packit 5756e2
 
Packit 5756e2
Packit 5756e2
Packit 5756e2

message

Packit 5756e2

an information message about why secrets are required, if any

Packit 5756e2
 
Packit 5756e2
Packit 5756e2
Packit 5756e2

hints

Packit 5756e2

VPN specific secret names for required new secrets

Packit 5756e2
 
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2

Packit 5756e2
Packit 5756e2

nm_vpn_plugin_old_set_login_banner ()

Packit 5756e2
void
Packit 5756e2
nm_vpn_plugin_old_set_login_banner (NMVpnPluginOld *plugin,
Packit 5756e2
                                    const char *banner);
Packit 5756e2
Packit 5756e2

nm_vpn_plugin_old_set_login_banner has been deprecated since version 1.2 and should not be used in newly-written code.

Packit 5756e2

Replaced by NMVpnServicePlugin.

Packit 5756e2
Packit 5756e2
Packit 5756e2

Packit 5756e2
Packit 5756e2

nm_vpn_plugin_old_failure ()

Packit 5756e2
void
Packit 5756e2
nm_vpn_plugin_old_failure (NMVpnPluginOld *plugin,
Packit 5756e2
                           NMVpnPluginFailure reason);
Packit 5756e2
Packit 5756e2

nm_vpn_plugin_old_failure has been deprecated since version 1.2 and should not be used in newly-written code.

Packit 5756e2

Replaced by NMVpnServicePlugin.

Packit 5756e2
Packit 5756e2
Packit 5756e2

Packit 5756e2
Packit 5756e2

nm_vpn_plugin_old_set_config ()

Packit 5756e2
void
Packit 5756e2
nm_vpn_plugin_old_set_config (NMVpnPluginOld *plugin,
Packit 5756e2
                              GVariant *config);
Packit 5756e2
Packit 5756e2

nm_vpn_plugin_old_set_config has been deprecated since version 1.2 and should not be used in newly-written code.

Packit 5756e2

Replaced by NMVpnServicePlugin.

Packit 5756e2
Packit 5756e2
Packit 5756e2

Packit 5756e2
Packit 5756e2

nm_vpn_plugin_old_set_ip4_config ()

Packit 5756e2
void
Packit 5756e2
nm_vpn_plugin_old_set_ip4_config (NMVpnPluginOld *plugin,
Packit 5756e2
                                  GVariant *ip4_config);
Packit 5756e2
Packit 5756e2

nm_vpn_plugin_old_set_ip4_config has been deprecated since version 1.2 and should not be used in newly-written code.

Packit 5756e2

Replaced by NMVpnServicePlugin.

Packit 5756e2
Packit 5756e2
Packit 5756e2

Packit 5756e2
Packit 5756e2

nm_vpn_plugin_old_set_ip6_config ()

Packit 5756e2
void
Packit 5756e2
nm_vpn_plugin_old_set_ip6_config (NMVpnPluginOld *plugin,
Packit 5756e2
                                  GVariant *ip6_config);
Packit 5756e2
Packit 5756e2

nm_vpn_plugin_old_set_ip6_config has been deprecated since version 1.2 and should not be used in newly-written code.

Packit 5756e2

Replaced by NMVpnServicePlugin.

Packit 5756e2
Packit 5756e2
Packit 5756e2

Packit 5756e2
Packit 5756e2

nm_vpn_plugin_old_disconnect ()

Packit 5756e2
gboolean
Packit 5756e2
nm_vpn_plugin_old_disconnect (NMVpnPluginOld *plugin,
Packit 5756e2
                              GError **err);
Packit 5756e2
Packit 5756e2

nm_vpn_plugin_old_disconnect has been deprecated since version 1.2 and should not be used in newly-written code.

Packit 5756e2

Replaced by NMVpnServicePlugin.

Packit 5756e2
Packit 5756e2
Packit 5756e2

Packit 5756e2
Packit 5756e2

nm_vpn_plugin_old_read_vpn_details ()

Packit 5756e2
gboolean
Packit 5756e2
nm_vpn_plugin_old_read_vpn_details (int fd,
Packit 5756e2
                                    GHashTable **out_data,
Packit 5756e2
                                    GHashTable **out_secrets);
Packit 5756e2
Packit 5756e2

nm_vpn_plugin_old_read_vpn_details has been deprecated since version 1.2 and should not be used in newly-written code.

Packit 5756e2

Replaced by NMVpnServicePlugin.

Packit 5756e2
Packit 5756e2

Parses key/value pairs from a file descriptor (normally stdin) passed by

Packit 5756e2
an applet when the applet calls the authentication dialog of the VPN plugin.

Packit 5756e2
Packit 5756e2

Parameters

Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2

fd

Packit 5756e2

file descriptor to read from, usually stdin (0)

Packit 5756e2
 
Packit 5756e2
Packit 5756e2
Packit 5756e2

out_data

Packit 5756e2

on successful return, a hash table

Packit 5756e2
(mapping char*:char*) containing the key/value pairs of VPN data items. 

Packit Service 5ffa24
[out][transfer full]
Packit 5756e2
Packit 5756e2
Packit 5756e2

out_secrets

Packit 5756e2

on successful return, a hash table

Packit 5756e2
(mapping char*:char*) containing the key/value pairsof VPN secrets. 

Packit Service 5ffa24
[out][transfer full]
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2

Returns

Packit 5756e2

TRUE if reading values was successful, FALSE if not

Packit 5756e2
Packit 5756e2
Packit 5756e2

Packit 5756e2
Packit 5756e2

nm_vpn_plugin_old_get_secret_flags ()

Packit 5756e2
gboolean
Packit 5756e2
nm_vpn_plugin_old_get_secret_flags (GHashTable *data,
Packit 5756e2
                                    const char *secret_name,
Packit 5756e2
                                    NMSettingSecretFlags *out_flags);
Packit 5756e2
Packit 5756e2

nm_vpn_plugin_old_get_secret_flags has been deprecated since version 1.2 and should not be used in newly-written code.

Packit 5756e2

Replaced by NMVpnServicePlugin.

Packit 5756e2
Packit 5756e2

Given a VPN secret key name, attempts to find the corresponding flags data

Packit 5756e2
item in data
Packit 5756e2
.  If found, converts the flags data item to
Packit 5756e2
NMSettingSecretFlags and returns it.

Packit 5756e2
Packit 5756e2

Parameters

Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2

data

Packit 5756e2

hash table containing VPN key/value pair data items

Packit 5756e2
 
Packit 5756e2
Packit 5756e2
Packit 5756e2

secret_name

Packit 5756e2

VPN secret key name for which to retrieve flags for

Packit 5756e2
 
Packit 5756e2
Packit 5756e2
Packit 5756e2

out_flags

Packit 5756e2

on success, the flags associated with secret_name

Packit 5756e2
. 

Packit 5756e2
[out]
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2

Returns

Packit 5756e2

TRUE if the flag data item was found and successfully converted

Packit 5756e2
to flags, FALSE if not

Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2

Types and Values

Packit 5756e2
Packit 5756e2

NM_VPN_PLUGIN_OLD_DBUS_SERVICE_NAME

Packit 5756e2
#define NM_VPN_PLUGIN_OLD_DBUS_SERVICE_NAME "service-name"
Packit 5756e2
Packit 5756e2
Packit 5756e2

Packit 5756e2
Packit 5756e2

NM_VPN_PLUGIN_OLD_STATE

Packit 5756e2
#define NM_VPN_PLUGIN_OLD_STATE             "state"
Packit 5756e2
Packit 5756e2
Packit 5756e2

Packit 5756e2
Packit 5756e2

NMVpnPluginOld

Packit 5756e2
typedef struct _NMVpnPluginOld NMVpnPluginOld;
Packit 5756e2

NMVpnPluginOld is deprecated and should not be used in newly-written code.

Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2

Property Details

Packit 5756e2
Packit 5756e2

The “service-name” property

Packit Service a1bd4f
  “service-name”             char *
Packit 5756e2

The D-Bus service name of this plugin.

Packit 5756e2
Packit 5756e2

NMVpnPluginOld:service-name has been deprecated since version 1.2 and should not be used in newly-written code.

Packit 5756e2

Replaced by NMVpnServicePlugin.

Packit 5756e2
Packit 5756e2

Owner: NMVpnPluginOld

Packit 5756e2

Flags: Read / Write / Construct Only

Packit 5756e2

Default value: NULL

Packit 5756e2
Packit 5756e2

Packit 5756e2
Packit 5756e2

The “state” property

Packit 5756e2
  “state”                    NMVpnServiceState
Packit 5756e2

The state of the plugin.

Packit 5756e2
Packit 5756e2

NMVpnPluginOld:state has been deprecated since version 1.2 and should not be used in newly-written code.

Packit 5756e2

Replaced by NMVpnServicePlugin.

Packit 5756e2
Packit 5756e2

Owner: NMVpnPluginOld

Packit 5756e2

Flags: Read / Write

Packit 5756e2

Default value: NM_VPN_SERVICE_STATE_INIT

Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2

Signal Details

Packit 5756e2
Packit 5756e2

The “config” signal

Packit 5756e2
void
Packit 5756e2
user_function (NMVpnPluginOld *nmvpnpluginold,
Packit 5756e2
               GVariant       *arg1,
Packit 5756e2
               gpointer        user_data)
Packit 5756e2

Flags: Run First

Packit 5756e2
Packit 5756e2

Packit 5756e2
Packit 5756e2

The “failure” signal

Packit 5756e2
void
Packit 5756e2
user_function (NMVpnPluginOld *nmvpnpluginold,
Packit 5756e2
               guint           arg1,
Packit 5756e2
               gpointer        user_data)
Packit 5756e2

Flags: Run First

Packit 5756e2
Packit 5756e2

Packit 5756e2
Packit 5756e2

The “ip4-config” signal

Packit 5756e2
void
Packit 5756e2
user_function (NMVpnPluginOld *nmvpnpluginold,
Packit 5756e2
               GVariant       *arg1,
Packit 5756e2
               gpointer        user_data)
Packit 5756e2

Flags: Run First

Packit 5756e2
Packit 5756e2

Packit 5756e2
Packit 5756e2

The “ip6-config” signal

Packit 5756e2
void
Packit 5756e2
user_function (NMVpnPluginOld *nmvpnpluginold,
Packit 5756e2
               GVariant       *arg1,
Packit 5756e2
               gpointer        user_data)
Packit 5756e2

Flags: Run First

Packit 5756e2
Packit 5756e2

Packit 5756e2
Packit 5756e2

The “login-banner” signal

Packit 5756e2
void
Packit 5756e2
user_function (NMVpnPluginOld *nmvpnpluginold,
Packit Service a1bd4f
               char           *arg1,
Packit 5756e2
               gpointer        user_data)
Packit 5756e2

Flags: Run First

Packit 5756e2
Packit 5756e2

Packit 5756e2
Packit 5756e2

The “quit” signal

Packit 5756e2
void
Packit 5756e2
user_function (NMVpnPluginOld *nmvpnpluginold,
Packit 5756e2
               gpointer        user_data)
Packit 5756e2

Flags: Run First

Packit 5756e2
Packit 5756e2

Packit 5756e2
Packit 5756e2

The “secrets-required” signal

Packit 5756e2
void
Packit 5756e2
user_function (NMVpnPluginOld *nmvpnpluginold,
Packit Service a1bd4f
               char           *arg1,
Packit 5756e2
               GStrv           arg2,
Packit 5756e2
               gpointer        user_data)
Packit 5756e2

Flags: Run First

Packit 5756e2
Packit 5756e2

Packit 5756e2
Packit 5756e2

The “state-changed” signal

Packit 5756e2
void
Packit 5756e2
user_function (NMVpnPluginOld *nmvpnpluginold,
Packit 5756e2
               guint           arg1,
Packit 5756e2
               gpointer        user_data)
Packit 5756e2

Flags: Run First

Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit Service 5ffa24

Generated by GTK-Doc V1.33.1
Packit 5756e2
</body>
Packit 5756e2
</html>