NMVPNPlugin

NMVPNPlugin

Functions

GQuark nm_vpn_plugin_error_quark ()
DBusGConnection * nm_vpn_plugin_get_connection ()
NMVPNServiceState nm_vpn_plugin_get_state ()
void nm_vpn_plugin_set_state ()
void nm_vpn_plugin_secrets_required ()
void nm_vpn_plugin_set_login_banner ()
void nm_vpn_plugin_failure ()
void nm_vpn_plugin_set_config ()
void nm_vpn_plugin_set_ip4_config ()
void nm_vpn_plugin_set_ip6_config ()
gboolean nm_vpn_plugin_disconnect ()

Properties

gchar * service-name Read / Write / Construct Only
guint state Read / Write

Signals

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

Types and Values

#define NM_VPN_PLUGIN_DBUS_SERVICE_NAME
#define NM_VPN_PLUGIN_STATE
enum NMVPNPluginError

Object Hierarchy

    GEnum
    ╰── NMVPNPluginError
    GObject
    ╰── NMVPNPlugin

Description

Functions

nm_vpn_plugin_error_quark ()

GQuark
nm_vpn_plugin_error_quark (void);

nm_vpn_plugin_get_connection ()

DBusGConnection *
nm_vpn_plugin_get_connection (NMVPNPlugin *plugin);

nm_vpn_plugin_get_state ()

NMVPNServiceState
nm_vpn_plugin_get_state (NMVPNPlugin *plugin);

nm_vpn_plugin_set_state ()

void
nm_vpn_plugin_set_state (NMVPNPlugin *plugin,
                         NMVPNServiceState state);

nm_vpn_plugin_secrets_required ()

void
nm_vpn_plugin_secrets_required (NMVPNPlugin *plugin,
                                const char *message,
                                const char **hints);

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

Parameters

plugin

the NMVPNPlugin

  

message

an information message about why secrets are required, if any

  

hints

VPN specific secret names for required new secrets

  

Since: 0.9.10

nm_vpn_plugin_set_login_banner ()

void
nm_vpn_plugin_set_login_banner (NMVPNPlugin *plugin,
                                const char *banner);

nm_vpn_plugin_failure ()

void
nm_vpn_plugin_failure (NMVPNPlugin *plugin,
                       NMVPNPluginFailure reason);

nm_vpn_plugin_set_config ()

void
nm_vpn_plugin_set_config (NMVPNPlugin *plugin,
                          GHashTable *config);

nm_vpn_plugin_set_ip4_config ()

void
nm_vpn_plugin_set_ip4_config (NMVPNPlugin *plugin,
                              GHashTable *ip4_config);

nm_vpn_plugin_set_ip6_config ()

void
nm_vpn_plugin_set_ip6_config (NMVPNPlugin *plugin,
                              GHashTable *ip6_config);

nm_vpn_plugin_disconnect ()

gboolean
nm_vpn_plugin_disconnect (NMVPNPlugin *plugin,
                          GError **err);

Types and Values

NM_VPN_PLUGIN_DBUS_SERVICE_NAME

#define NM_VPN_PLUGIN_DBUS_SERVICE_NAME "service-name"

NM_VPN_PLUGIN_STATE

#define NM_VPN_PLUGIN_STATE             "state"

enum NMVPNPluginError

Returned by the VPN service plugin to indicate errors.

Members

NM_VPN_PLUGIN_ERROR_GENERAL

general failure

  

NM_VPN_PLUGIN_ERROR_STARTING_IN_PROGRESS

the plugin is already starting, and another connect request was received

  

NM_VPN_PLUGIN_ERROR_ALREADY_STARTED

the plugin is already connected, and another connect request was received

  

NM_VPN_PLUGIN_ERROR_STOPPING_IN_PROGRESS

the plugin is already stopping, and another stop request was received

  

NM_VPN_PLUGIN_ERROR_ALREADY_STOPPED

the plugin is already stopped, and another disconnect request was received

  

NM_VPN_PLUGIN_ERROR_WRONG_STATE

the operation could not be performed in this state

  

NM_VPN_PLUGIN_ERROR_BAD_ARGUMENTS

the operation could not be performed as the request contained malformed arguments, or arguments of unexpected type. Usually means that one of the VPN setting data items or secrets was not of the expected type (ie int, string, bool, etc).

  

NM_VPN_PLUGIN_ERROR_LAUNCH_FAILED

a child process failed to launch

  

NM_VPN_PLUGIN_ERROR_CONNECTION_INVALID

the operation could not be performed because the connection was invalid. Usually means that the connection's VPN setting was missing some required data item or secret.

  

NM_VPN_PLUGIN_ERROR_INTERACTIVE_NOT_SUPPORTED

the operation could not be performed as the plugin does not support interactive operations, such as ConnectInteractive() or NewSecrets()

  

Property Details

The “service-name” property

  “service-name”             gchar *

The D-Bus service name of this plugin.

Flags: Read / Write / Construct Only

Default value: NULL

The “state” property

  “state”                    guint

The state of the plugin.

Flags: Read / Write

Allowed values: <= 6

Default value: 1

Signal Details

The “config” signal

void
user_function (NMVPNPlugin *nmvpnplugin,
               gpointer     user_data)

Flags: Run First

The “failure” signal

void
user_function (NMVPNPlugin *nmvpnplugin,
               guint        arg1,
               gpointer     user_data)

Flags: Run First

The “ip4-config” signal

void
user_function (NMVPNPlugin *nmvpnplugin,
               gpointer     user_data)

Flags: Run First

The “ip6-config” signal

void
user_function (NMVPNPlugin *nmvpnplugin,
               gpointer     user_data)

Flags: Run First

The “login-banner” signal

void
user_function (NMVPNPlugin *nmvpnplugin,
               gchar       *arg1,
               gpointer     user_data)

Flags: Run First

The “quit” signal

void
user_function (NMVPNPlugin *nmvpnplugin,
               gpointer     user_data)

Flags: Run First

The “secrets-required” signal

void
user_function (NMVPNPlugin *nmvpnplugin,
               gchar       *arg1,
               GStrv        arg2,
               gpointer     user_data)

Flags: Run First

The “state-changed” signal

void
user_function (NMVPNPlugin *nmvpnplugin,
               guint        arg1,
               gpointer     user_data)

Flags: Run First

Generated by GTK-Doc V1.29