<?xml version="1.0"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
               "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<refentry id="libnm-glib-NMVPNPlugin">
<refmeta>
<refentrytitle role="top_of_page">NMVPNPlugin</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>LIBNM-GLIB Library</refmiscinfo>
</refmeta>

<refnamediv>
<refname>NMVPNPlugin</refname>
<refpurpose></refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>

<refsynopsisdiv role="synopsis">
<title role="synopsis.title">Synopsis</title>

<synopsis>



#define             <link linkend="NM-VPN-PLUGIN-DBUS-SERVICE-NAME:CAPS">NM_VPN_PLUGIN_DBUS_SERVICE_NAME</link>
#define             <link linkend="NM-VPN-PLUGIN-STATE:CAPS">NM_VPN_PLUGIN_STATE</link>
enum                <link linkend="NMVPNPluginError">NMVPNPluginError</link>;
#define             <link linkend="NM-VPN-PLUGIN-ERROR:CAPS">NM_VPN_PLUGIN_ERROR</link>
#define             <link linkend="NM-TYPE-VPN-PLUGIN-ERROR:CAPS">NM_TYPE_VPN_PLUGIN_ERROR</link>
                    <link linkend="NMVPNPlugin">NMVPNPlugin</link>;
<link linkend="GQuark">GQuark</link>              <link linkend="nm-vpn-plugin-error-quark">nm_vpn_plugin_error_quark</link>           (void);
<link linkend="GType">GType</link>               <link linkend="nm-vpn-plugin-error-get-type">nm_vpn_plugin_error_get_type</link>        (void);
<link linkend="DBusGConnection">DBusGConnection</link>*    <link linkend="nm-vpn-plugin-get-connection">nm_vpn_plugin_get_connection</link>        (<link linkend="NMVPNPlugin">NMVPNPlugin</link> *plugin);
<link linkend="NMVPNServiceState">NMVPNServiceState</link>   <link linkend="nm-vpn-plugin-get-state">nm_vpn_plugin_get_state</link>             (<link linkend="NMVPNPlugin">NMVPNPlugin</link> *plugin);
<link linkend="void">void</link>                <link linkend="nm-vpn-plugin-set-state">nm_vpn_plugin_set_state</link>             (<link linkend="NMVPNPlugin">NMVPNPlugin</link> *plugin,
                                                         <link linkend="NMVPNServiceState">NMVPNServiceState</link> state);
<link linkend="void">void</link>                <link linkend="nm-vpn-plugin-set-login-banner">nm_vpn_plugin_set_login_banner</link>      (<link linkend="NMVPNPlugin">NMVPNPlugin</link> *plugin,
                                                         const <link linkend="char">char</link> *banner);
<link linkend="void">void</link>                <link linkend="nm-vpn-plugin-failure">nm_vpn_plugin_failure</link>               (<link linkend="NMVPNPlugin">NMVPNPlugin</link> *plugin,
                                                         <link linkend="NMVPNPluginFailure">NMVPNPluginFailure</link> reason);
<link linkend="void">void</link>                <link linkend="nm-vpn-plugin-set-ip4-config">nm_vpn_plugin_set_ip4_config</link>        (<link linkend="NMVPNPlugin">NMVPNPlugin</link> *plugin,
                                                         <link linkend="GHashTable">GHashTable</link> *ip4_config);
<link linkend="gboolean">gboolean</link>            <link linkend="nm-vpn-plugin-disconnect">nm_vpn_plugin_disconnect</link>            (<link linkend="NMVPNPlugin">NMVPNPlugin</link> *plugin,
                                                         <link linkend="GError">GError</link> **err);

</synopsis>
</refsynopsisdiv>









<refsect1 role="desc">
<title role="desc.title">Description</title>
<para>

</para>
</refsect1>

<refsect1 role="details">
<title role="details.title">Details</title>
<refsect2>
<title><anchor id="NM-VPN-PLUGIN-DBUS-SERVICE-NAME:CAPS" role="macro"/>NM_VPN_PLUGIN_DBUS_SERVICE_NAME</title>
<indexterm><primary>NM_VPN_PLUGIN_DBUS_SERVICE_NAME</primary></indexterm><programlisting>#define NM_VPN_PLUGIN_DBUS_SERVICE_NAME "service-name"
</programlisting>
<para>

</para></refsect2>
<refsect2>
<title><anchor id="NM-VPN-PLUGIN-STATE:CAPS" role="macro"/>NM_VPN_PLUGIN_STATE</title>
<indexterm><primary>NM_VPN_PLUGIN_STATE</primary></indexterm><programlisting>#define NM_VPN_PLUGIN_STATE             "state"
</programlisting>
<para>

</para></refsect2>
<refsect2>
<title><anchor id="NMVPNPluginError" role="enum"/>enum NMVPNPluginError</title>
<indexterm><primary>NMVPNPluginError</primary></indexterm><programlisting>typedef enum {
	NM_VPN_PLUGIN_ERROR_GENERAL,
	NM_VPN_PLUGIN_ERROR_STARTING_IN_PROGRESS,
	NM_VPN_PLUGIN_ERROR_ALREADY_STARTED,
	NM_VPN_PLUGIN_ERROR_STOPPING_IN_PROGRESS,
	NM_VPN_PLUGIN_ERROR_ALREADY_STOPPED,
	NM_VPN_PLUGIN_ERROR_WRONG_STATE,
	NM_VPN_PLUGIN_ERROR_BAD_ARGUMENTS,
	NM_VPN_PLUGIN_ERROR_LAUNCH_FAILED,
	NM_VPN_PLUGIN_ERROR_CONNECTION_INVALID,
} NMVPNPluginError;
</programlisting>
<para>

</para></refsect2>
<refsect2>
<title><anchor id="NM-VPN-PLUGIN-ERROR:CAPS" role="macro"/>NM_VPN_PLUGIN_ERROR</title>
<indexterm><primary>NM_VPN_PLUGIN_ERROR</primary></indexterm><programlisting>#define NM_VPN_PLUGIN_ERROR      (nm_vpn_plugin_error_quark ())
</programlisting>
<para>

</para></refsect2>
<refsect2>
<title><anchor id="NM-TYPE-VPN-PLUGIN-ERROR:CAPS" role="macro"/>NM_TYPE_VPN_PLUGIN_ERROR</title>
<indexterm><primary>NM_TYPE_VPN_PLUGIN_ERROR</primary></indexterm><programlisting>#define NM_TYPE_VPN_PLUGIN_ERROR (nm_vpn_plugin_error_get_type ()) 
</programlisting>
<para>

</para></refsect2>
<refsect2>
<title><anchor id="NMVPNPlugin" role="struct"/>NMVPNPlugin</title>
<indexterm><primary>NMVPNPlugin</primary></indexterm><programlisting>typedef struct {
	GObject parent;
} NMVPNPlugin;
</programlisting>
<para>

</para></refsect2>
<refsect2>
<title><anchor id="nm-vpn-plugin-error-quark" role="function"/>nm_vpn_plugin_error_quark ()</title>
<indexterm><primary>nm_vpn_plugin_error_quark</primary></indexterm><programlisting><link linkend="GQuark">GQuark</link>              nm_vpn_plugin_error_quark           (void);</programlisting>
<para>

</para><variablelist role="params">
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>


</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="nm-vpn-plugin-error-get-type" role="function"/>nm_vpn_plugin_error_get_type ()</title>
<indexterm><primary>nm_vpn_plugin_error_get_type</primary></indexterm><programlisting><link linkend="GType">GType</link>               nm_vpn_plugin_error_get_type        (void);</programlisting>
<para>

</para><variablelist role="params">
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>


</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="nm-vpn-plugin-get-connection" role="function"/>nm_vpn_plugin_get_connection ()</title>
<indexterm><primary>nm_vpn_plugin_get_connection</primary></indexterm><programlisting><link linkend="DBusGConnection">DBusGConnection</link>*    nm_vpn_plugin_get_connection        (<link linkend="NMVPNPlugin">NMVPNPlugin</link> *plugin);</programlisting>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>plugin</parameter>&nbsp;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>


</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="nm-vpn-plugin-get-state" role="function"/>nm_vpn_plugin_get_state ()</title>
<indexterm><primary>nm_vpn_plugin_get_state</primary></indexterm><programlisting><link linkend="NMVPNServiceState">NMVPNServiceState</link>   nm_vpn_plugin_get_state             (<link linkend="NMVPNPlugin">NMVPNPlugin</link> *plugin);</programlisting>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>plugin</parameter>&nbsp;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>


</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="nm-vpn-plugin-set-state" role="function"/>nm_vpn_plugin_set_state ()</title>
<indexterm><primary>nm_vpn_plugin_set_state</primary></indexterm><programlisting><link linkend="void">void</link>                nm_vpn_plugin_set_state             (<link linkend="NMVPNPlugin">NMVPNPlugin</link> *plugin,
                                                         <link linkend="NMVPNServiceState">NMVPNServiceState</link> state);</programlisting>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>plugin</parameter>&nbsp;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>state</parameter>&nbsp;:</term>
<listitem><simpara>


</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="nm-vpn-plugin-set-login-banner" role="function"/>nm_vpn_plugin_set_login_banner ()</title>
<indexterm><primary>nm_vpn_plugin_set_login_banner</primary></indexterm><programlisting><link linkend="void">void</link>                nm_vpn_plugin_set_login_banner      (<link linkend="NMVPNPlugin">NMVPNPlugin</link> *plugin,
                                                         const <link linkend="char">char</link> *banner);</programlisting>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>plugin</parameter>&nbsp;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>banner</parameter>&nbsp;:</term>
<listitem><simpara>


</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="nm-vpn-plugin-failure" role="function"/>nm_vpn_plugin_failure ()</title>
<indexterm><primary>nm_vpn_plugin_failure</primary></indexterm><programlisting><link linkend="void">void</link>                nm_vpn_plugin_failure               (<link linkend="NMVPNPlugin">NMVPNPlugin</link> *plugin,
                                                         <link linkend="NMVPNPluginFailure">NMVPNPluginFailure</link> reason);</programlisting>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>plugin</parameter>&nbsp;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>reason</parameter>&nbsp;:</term>
<listitem><simpara>


</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="nm-vpn-plugin-set-ip4-config" role="function"/>nm_vpn_plugin_set_ip4_config ()</title>
<indexterm><primary>nm_vpn_plugin_set_ip4_config</primary></indexterm><programlisting><link linkend="void">void</link>                nm_vpn_plugin_set_ip4_config        (<link linkend="NMVPNPlugin">NMVPNPlugin</link> *plugin,
                                                         <link linkend="GHashTable">GHashTable</link> *ip4_config);</programlisting>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>plugin</parameter>&nbsp;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>ip4_config</parameter>&nbsp;:</term>
<listitem><simpara>


</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="nm-vpn-plugin-disconnect" role="function"/>nm_vpn_plugin_disconnect ()</title>
<indexterm><primary>nm_vpn_plugin_disconnect</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            nm_vpn_plugin_disconnect            (<link linkend="NMVPNPlugin">NMVPNPlugin</link> *plugin,
                                                         <link linkend="GError">GError</link> **err);</programlisting>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>plugin</parameter>&nbsp;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>err</parameter>&nbsp;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>


</simpara></listitem></varlistentry>
</variablelist></refsect2>

</refsect1>





<refsect1><refsect2 /><refsect2 /></refsect1>
</refentry>
