|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
<html>
|
|
Packit |
5756e2 |
<head>
|
|
Packit |
5756e2 |
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
|
Packit |
5756e2 |
<title>NMVpnEditorPlugin: 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="NMVpnEditor.html" title="NMVpnEditor">
|
|
Packit |
5756e2 |
<link rel="next" href="NMVpnPluginOld.html" title="NMVpnPluginOld">
|
|
Packit Service |
a1bd4f |
<meta name="generator" content="GTK-Doc V1.33.0 (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 |
Prerequisites |
|
|
Packit |
5756e2 |
Properties |
|
|
Packit |
5756e2 |
Signals
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
NMVpnEditorPlugin
|
|
Packit |
5756e2 |
NMVpnEditorPlugin
|
|
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 |
NMVpnEditorPlugin *
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
(*NMVpnEditorPluginFactory) ()
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
NMVpnEditorPlugin *
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
nm_vpn_editor_plugin_factory ()
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
NMVpnEditor *
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
nm_vpn_editor_plugin_get_editor ()
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
NMVpnEditorPluginCapability
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
nm_vpn_editor_plugin_get_capabilities ()
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
gsize
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
nm_vpn_editor_plugin_get_vt ()
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
NMConnection *
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
nm_vpn_editor_plugin_import ()
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
gboolean
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
nm_vpn_editor_plugin_export ()
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
char *
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
nm_vpn_editor_plugin_get_suggested_filename ()
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
NMVpnEditorPlugin *
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
nm_vpn_editor_plugin_load_from_file ()
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
NMVpnEditorPlugin *
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
nm_vpn_editor_plugin_load ()
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
NMVpnPluginInfo *
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
nm_vpn_editor_plugin_get_plugin_info ()
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
void
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
nm_vpn_editor_plugin_set_plugin_info ()
|
|
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 |
filename
|
|
Packit |
5756e2 |
Read / Write / Construct Only
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
GKeyFile *
|
|
Packit |
5756e2 |
keyfile
|
|
Packit |
5756e2 |
Write / Construct Only
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit Service |
a1bd4f |
char *
|
|
Packit |
5756e2 |
name
|
|
Packit |
5756e2 |
Read
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit Service |
a1bd4f |
char *
|
|
Packit |
5756e2 |
description
|
|
Packit |
5756e2 |
Read
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit Service |
a1bd4f |
char *
|
|
Packit |
5756e2 |
name
|
|
Packit |
5756e2 |
Read
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit Service |
a1bd4f |
char *
|
|
Packit |
5756e2 |
service
|
|
Packit |
5756e2 |
Read
|
|
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 |
void
|
|
Packit |
5756e2 |
changed
|
|
Packit |
5756e2 |
Run First
|
|
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 |
enum
|
|
Packit |
5756e2 |
NMVpnEditorPluginCapability
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
#define
|
|
Packit |
5756e2 |
NM_VPN_EDITOR_PLUGIN_NAME
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
#define
|
|
Packit |
5756e2 |
NM_VPN_EDITOR_PLUGIN_DESCRIPTION
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
#define
|
|
Packit |
5756e2 |
NM_VPN_EDITOR_PLUGIN_SERVICE
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
NMVpnEditorPluginInterface
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
NMVpnEditor
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
NMVpnEditorPluginVT
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
NMVpnPluginInfo
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
Object Hierarchy
|
|
Packit |
5756e2 |
GFlags
|
|
Packit |
5756e2 |
╰── NMVpnEditorPluginCapability
|
|
Packit |
5756e2 |
GInterface
|
|
Packit |
5756e2 |
├── NMVpnEditor
|
|
Packit |
5756e2 |
╰── NMVpnEditorPlugin
|
|
Packit |
5756e2 |
GObject
|
|
Packit |
5756e2 |
╰── NMVpnPluginInfo
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
Prerequisites
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
NMVpnEditor requires
|
|
Packit |
5756e2 |
GObject.
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
Implemented Interfaces
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
NMVpnPluginInfo implements
|
|
Packit |
5756e2 |
GInitable.
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
Description
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
Functions
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
NMVpnEditorPluginFactory ()
|
|
Packit |
5756e2 |
NMVpnEditorPlugin *
|
|
Packit |
5756e2 |
(*NMVpnEditorPluginFactory) (GError **error);
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
nm_vpn_editor_plugin_factory ()
|
|
Packit |
5756e2 |
NMVpnEditorPlugin *
|
|
Packit |
5756e2 |
nm_vpn_editor_plugin_factory (GError **error);
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
nm_vpn_editor_plugin_get_editor ()
|
|
Packit |
5756e2 |
NMVpnEditor *
|
|
Packit |
5756e2 |
nm_vpn_editor_plugin_get_editor (NMVpnEditorPlugin *plugin,
|
|
Packit |
5756e2 |
NMConnection *connection,
|
|
Packit |
5756e2 |
GError **error);
|
|
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 NMVpnEditorPlugin
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
connection
|
|
Packit |
5756e2 |
the NMConnection to be edited
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
error
|
|
Packit |
5756e2 |
on return, an error or NULL
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
Returns
|
|
Packit |
5756e2 |
a new NMVpnEditor or NULL on error.
|
|
Packit |
5756e2 |
[transfer full]
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
nm_vpn_editor_plugin_get_capabilities ()
|
|
Packit |
5756e2 |
NMVpnEditorPluginCapability
|
|
Packit |
5756e2 |
nm_vpn_editor_plugin_get_capabilities (NMVpnEditorPlugin *plugin);
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
nm_vpn_editor_plugin_get_vt ()
|
|
Packit |
5756e2 |
gsize
|
|
Packit |
5756e2 |
nm_vpn_editor_plugin_get_vt (NMVpnEditorPlugin *plugin,
|
|
Packit |
5756e2 |
NMVpnEditorPluginVT *vt,
|
|
Packit |
5756e2 |
gsize vt_size);
|
|
Packit |
5756e2 |
Returns an opaque VT function table for the plugin to extend
|
|
Packit |
5756e2 |
functionality. The actual meaning of NMVpnEditorPluginVT is not
|
|
Packit |
5756e2 |
defined in public API of libnm, instead it must be agreed by
|
|
Packit |
5756e2 |
both the plugin and the caller. See the header-only file
|
|
Packit |
5756e2 |
'nm-vpn-editor-plugin-call.h' which defines the meaning.
|
|
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 NMVpnEditorPlugin
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
vt
|
|
Packit |
5756e2 |
buffer to be filled with the VT table of the plugin.
|
|
Packit |
5756e2 |
[out]
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
vt_size
|
|
Packit |
5756e2 |
the size of the buffer. Can be 0 to only query the
|
|
Packit |
5756e2 |
size of plugin's VT.
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
Returns
|
|
Packit |
5756e2 |
the actual size of the plugin
|
|
Packit |
5756e2 |
's virtual function table.
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
Since: 1.4
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
nm_vpn_editor_plugin_import ()
|
|
Packit |
5756e2 |
NMConnection *
|
|
Packit |
5756e2 |
nm_vpn_editor_plugin_import (NMVpnEditorPlugin *plugin,
|
|
Packit |
5756e2 |
const char *path,
|
|
Packit |
5756e2 |
GError **error);
|
|
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 NMVpnEditorPlugin
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
path
|
|
Packit |
5756e2 |
full path to the file to attempt to read into a new NMConnection
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
error
|
|
Packit |
5756e2 |
on return, an error or NULL
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
Returns
|
|
Packit |
5756e2 |
a new NMConnection imported from path
|
|
Packit |
5756e2 |
, or NULL
|
|
Packit |
5756e2 |
on error or if the file at path
|
|
Packit |
5756e2 |
was not recognized by this plugin.
|
|
Packit |
5756e2 |
[transfer full]
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
nm_vpn_editor_plugin_export ()
|
|
Packit |
5756e2 |
gboolean
|
|
Packit |
5756e2 |
nm_vpn_editor_plugin_export (NMVpnEditorPlugin *plugin,
|
|
Packit |
5756e2 |
const char *path,
|
|
Packit |
5756e2 |
NMConnection *connection,
|
|
Packit |
5756e2 |
GError **error);
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
nm_vpn_editor_plugin_get_suggested_filename ()
|
|
Packit |
5756e2 |
char *
|
|
Packit |
5756e2 |
nm_vpn_editor_plugin_get_suggested_filename
|
|
Packit |
5756e2 |
(NMVpnEditorPlugin *plugin,
|
|
Packit |
5756e2 |
NMConnection *connection);
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
nm_vpn_editor_plugin_load_from_file ()
|
|
Packit |
5756e2 |
NMVpnEditorPlugin *
|
|
Packit |
5756e2 |
nm_vpn_editor_plugin_load_from_file (const char *plugin_name,
|
|
Packit |
5756e2 |
const char *check_service,
|
|
Packit |
5756e2 |
int check_owner,
|
|
Packit |
5756e2 |
NMUtilsCheckFilePredicate check_file,
|
|
Packit |
5756e2 |
gpointer user_data,
|
|
Packit |
5756e2 |
GError **error);
|
|
Packit |
5756e2 |
Load the shared library plugin_name
|
|
Packit |
5756e2 |
and create a new
|
|
Packit |
5756e2 |
NMVpnEditorPlugin instance via the NMVpnEditorPluginFactory
|
|
Packit |
5756e2 |
function.
|
|
Packit |
5756e2 |
If plugin_name
|
|
Packit |
5756e2 |
is not an absolute path name, it assumes the file
|
|
Packit |
5756e2 |
is in the plugin directory of NetworkManager. In any case, the call
|
|
Packit |
5756e2 |
will do certain checks on the file before passing it to dlopen.
|
|
Packit |
5756e2 |
A consequence for that is, that you cannot omit the ".so" suffix
|
|
Packit |
5756e2 |
as you could for nm_vpn_editor_plugin_load().
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
Parameters
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
plugin_name
|
|
Packit |
5756e2 |
The path or name of the shared library to load.
|
|
Packit |
5756e2 |
The path must either be an absolute filename to an existing file.
|
|
Packit |
5756e2 |
Alternatively, it can be the name (without path) of a library in the
|
|
Packit |
5756e2 |
plugin directory of NetworkManager.
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
check_service
|
|
Packit |
5756e2 |
if not-null, check that the loaded plugin advertises
|
|
Packit |
5756e2 |
the given service.
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
check_owner
|
|
Packit |
5756e2 |
if non-negative, check whether the file is owned
|
|
Packit |
5756e2 |
by UID check_owner
|
|
Packit |
5756e2 |
or by root. In this case also check that
|
|
Packit |
5756e2 |
the file is not writable by anybody else.
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
check_file
|
|
Packit |
5756e2 |
optional callback to validate the file prior to
|
|
Packit |
5756e2 |
loading the shared library.
|
|
Packit |
5756e2 |
[scope call]
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
user_data
|
|
Packit |
5756e2 |
user data for check_file
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
error
|
|
Packit |
5756e2 |
on failure the error reason.
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
Returns
|
|
Packit |
5756e2 |
a new plugin instance or NULL on error.
|
|
Packit |
5756e2 |
[transfer full]
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
Since: 1.2
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
nm_vpn_editor_plugin_load ()
|
|
Packit |
5756e2 |
NMVpnEditorPlugin *
|
|
Packit |
5756e2 |
nm_vpn_editor_plugin_load (const char *plugin_name,
|
|
Packit |
5756e2 |
const char *check_service,
|
|
Packit |
5756e2 |
GError **error);
|
|
Packit |
5756e2 |
Load the shared library plugin_name
|
|
Packit |
5756e2 |
and create a new
|
|
Packit |
5756e2 |
NMVpnEditorPlugin instance via the NMVpnEditorPluginFactory
|
|
Packit |
5756e2 |
function.
|
|
Packit |
5756e2 |
This is similar to nm_vpn_editor_plugin_load_from_file(), but
|
|
Packit |
5756e2 |
it does no validation of the plugin name, instead passes it directly
|
|
Packit |
5756e2 |
to dlopen(). If you have the full path to a plugin file,
|
|
Packit |
5756e2 |
nm_vpn_editor_plugin_load_from_file() is preferred.
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
Parameters
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
plugin_name
|
|
Packit |
5756e2 |
The name of the shared library to load.
|
|
Packit |
5756e2 |
This path will be directly passed to dlopen() without
|
|
Packit |
5756e2 |
further checks.
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
check_service
|
|
Packit |
5756e2 |
if not-null, check that the loaded plugin advertises
|
|
Packit |
5756e2 |
the given service.
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
error
|
|
Packit |
5756e2 |
on failure the error reason.
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
Returns
|
|
Packit |
5756e2 |
a new plugin instance or NULL on error.
|
|
Packit |
5756e2 |
[transfer full]
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
Since: 1.4
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
nm_vpn_editor_plugin_get_plugin_info ()
|
|
Packit |
5756e2 |
NMVpnPluginInfo *
|
|
Packit |
5756e2 |
nm_vpn_editor_plugin_get_plugin_info (NMVpnEditorPlugin *plugin);
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
Parameters
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
plugin
|
|
Packit |
5756e2 |
the NMVpnEditorPlugin instance
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
Returns
|
|
Packit |
5756e2 |
if set, return the NMVpnPluginInfo instance.
|
|
Packit |
5756e2 |
[transfer none]
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
Since: 1.4
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
nm_vpn_editor_plugin_set_plugin_info ()
|
|
Packit |
5756e2 |
void
|
|
Packit |
5756e2 |
nm_vpn_editor_plugin_set_plugin_info (NMVpnEditorPlugin *plugin,
|
|
Packit |
5756e2 |
NMVpnPluginInfo *plugin_info);
|
|
Packit |
5756e2 |
Set or clear the plugin-info instance.
|
|
Packit |
5756e2 |
This takes a weak reference on plugin_info
|
|
Packit |
5756e2 |
, to avoid circular
|
|
Packit |
5756e2 |
reference as the plugin-info might also reference the editor-plugin.
|
|
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 NMVpnEditorPlugin instance
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
plugin_info
|
|
Packit |
5756e2 |
a NMVpnPluginInfo instance or NULL.
|
|
Packit |
5756e2 |
[allow-none]
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
Since: 1.4
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
Types and Values
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
enum NMVpnEditorPluginCapability
|
|
Packit |
5756e2 |
Flags that indicate certain capabilities of the plugin to editor programs.
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
Members
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
NM_VPN_EDITOR_PLUGIN_CAPABILITY_NONE
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
unknown or no capability
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
NM_VPN_EDITOR_PLUGIN_CAPABILITY_IMPORT
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
the plugin can import new connections
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
NM_VPN_EDITOR_PLUGIN_CAPABILITY_EXPORT
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
the plugin can export connections
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
NM_VPN_EDITOR_PLUGIN_CAPABILITY_IPV6
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
the plugin supports IPv6 addressing
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
NM_VPN_EDITOR_PLUGIN_NAME
|
|
Packit |
5756e2 |
#define NM_VPN_EDITOR_PLUGIN_NAME "name"
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
NM_VPN_EDITOR_PLUGIN_DESCRIPTION
|
|
Packit |
5756e2 |
#define NM_VPN_EDITOR_PLUGIN_DESCRIPTION "description"
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
NM_VPN_EDITOR_PLUGIN_SERVICE
|
|
Packit |
5756e2 |
#define NM_VPN_EDITOR_PLUGIN_SERVICE "service"
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
NMVpnEditorPluginInterface
|
|
Packit |
5756e2 |
typedef struct {
|
|
Packit Service |
a1bd4f |
GTypeInterface g_iface;
|
|
Packit |
5756e2 |
|
|
Packit Service |
a1bd4f |
NMVpnEditor *(*get_editor)(NMVpnEditorPlugin *plugin, NMConnection *connection, GError **error);
|
|
Packit |
5756e2 |
|
|
Packit Service |
a1bd4f |
NMVpnEditorPluginCapability (*get_capabilities)(NMVpnEditorPlugin *plugin);
|
|
Packit |
5756e2 |
|
|
Packit Service |
a1bd4f |
NMConnection *(*import_from_file)(NMVpnEditorPlugin *plugin, const char *path, GError **error);
|
|
Packit |
5756e2 |
|
|
Packit Service |
a1bd4f |
gboolean (*export_to_file)(NMVpnEditorPlugin *plugin,
|
|
Packit Service |
a1bd4f |
const char * path,
|
|
Packit Service |
a1bd4f |
NMConnection * connection,
|
|
Packit Service |
a1bd4f |
GError ** error);
|
|
Packit |
5756e2 |
|
|
Packit Service |
a1bd4f |
char *(*get_suggested_filename)(NMVpnEditorPlugin *plugin, NMConnection *connection);
|
|
Packit |
5756e2 |
|
|
Packit Service |
a1bd4f |
void (*notify_plugin_info_set)(NMVpnEditorPlugin *plugin, NMVpnPluginInfo *plugin_info);
|
|
Packit |
5756e2 |
|
|
Packit Service |
a1bd4f |
const NMVpnEditorPluginVT *(*get_vt)(NMVpnEditorPlugin *plugin, gsize *out_vt_size);
|
|
Packit |
5756e2 |
} NMVpnEditorPluginInterface;
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
Interface for VPN editor plugins.
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
Members
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
get_editor ()
|
|
Packit |
5756e2 |
returns an NMVpnEditor, pre-filled with values from connection
|
|
Packit |
5756e2 |
if non-NULL.
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
get_capabilities ()
|
|
Packit |
5756e2 |
returns a bitmask of capabilities.
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
import_from_file ()
|
|
Packit |
5756e2 |
Try to import a connection from the specified path. On
|
|
Packit |
5756e2 |
success, return a partial NMConnection object. On error, return NULL and
|
|
Packit |
5756e2 |
set error
|
|
Packit |
5756e2 |
with additional information. Note that error
|
|
Packit |
5756e2 |
can be NULL, in
|
|
Packit |
5756e2 |
which case no additional error information should be provided.
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
export_to_file ()
|
|
Packit |
5756e2 |
Export the given connection to the specified path. Return
|
|
Packit |
5756e2 |
TRUE on success. On error, return FALSE and set error
|
|
Packit |
5756e2 |
with additional
|
|
Packit |
5756e2 |
error information. Note that error
|
|
Packit |
5756e2 |
can be NULL, in which case no
|
|
Packit |
5756e2 |
additional error information should be provided.
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
get_suggested_filename ()
|
|
Packit |
5756e2 |
For a given connection, return a suggested file
|
|
Packit |
5756e2 |
name. Returned value will be NULL or a suggested file name to be freed by
|
|
Packit |
5756e2 |
the caller.
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
notify_plugin_info_set ()
|
|
Packit |
5756e2 |
A callback to be called when the plugin info is set.
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
get_vt ()
|
|
Packit |
5756e2 |
return a virtual function table to implement further functions in
|
|
Packit |
5756e2 |
the plugin, without requiring to update libnm. Used by nm_vpn_editor_plugin_get_vt().
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
NMVpnEditor
|
|
Packit |
5756e2 |
typedef struct _NMVpnEditor NMVpnEditor;
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
NMVpnEditorPluginVT
|
|
Packit |
5756e2 |
typedef struct _NMVpnEditorPluginVT NMVpnEditorPluginVT;
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
NMVpnPluginInfo
|
|
Packit |
5756e2 |
typedef struct _NMVpnPluginInfo NMVpnPluginInfo;
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
Property Details
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
The “filename” property
|
|
Packit Service |
a1bd4f |
“filename” char *
|
|
Packit |
5756e2 |
The filename from which the info was loaded.
|
|
Packit |
5756e2 |
Can be NULL if the instance was not loaded from
|
|
Packit |
5756e2 |
a file (i.e. the keyfile instance was passed to the
|
|
Packit |
5756e2 |
constructor).
|
|
Packit |
5756e2 |
Owner: NMVpnPluginInfo
|
|
Packit |
5756e2 |
Flags: Read / Write / Construct Only
|
|
Packit |
5756e2 |
Default value: NULL
|
|
Packit |
5756e2 |
Since: 1.2
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
The “keyfile” property
|
|
Packit |
5756e2 |
“keyfile” GKeyFile *
|
|
Packit |
5756e2 |
Initialize the instance with a different keyfile instance.
|
|
Packit |
5756e2 |
When passing a keyfile instance, the constructor will not
|
|
Packit |
5756e2 |
try to read from filename.
|
|
Packit |
5756e2 |
Owner: NMVpnPluginInfo
|
|
Packit |
5756e2 |
Flags: Write / Construct Only
|
|
Packit |
5756e2 |
Since: 1.2
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
The “name” property
|
|
Packit Service |
a1bd4f |
“name” char *
|
|
Packit |
5756e2 |
The name of the VPN plugin.
|
|
Packit |
5756e2 |
Owner: NMVpnPluginInfo
|
|
Packit |
5756e2 |
Flags: Read
|
|
Packit |
5756e2 |
Default value: NULL
|
|
Packit |
5756e2 |
Since: 1.2
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
The “description” property
|
|
Packit Service |
a1bd4f |
“description” char *
|
|
Packit |
5756e2 |
Longer description of the VPN plugin.
|
|
Packit |
5756e2 |
Owner: NMVpnEditorPlugin
|
|
Packit |
5756e2 |
Flags: Read
|
|
Packit |
5756e2 |
Default value: NULL
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
The “name” property
|
|
Packit Service |
a1bd4f |
“name” char *
|
|
Packit |
5756e2 |
Short display name of the VPN plugin.
|
|
Packit |
5756e2 |
Owner: NMVpnEditorPlugin
|
|
Packit |
5756e2 |
Flags: Read
|
|
Packit |
5756e2 |
Default value: NULL
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
The “service” property
|
|
Packit Service |
a1bd4f |
“service” char *
|
|
Packit |
5756e2 |
D-Bus service name of the plugin's VPN service.
|
|
Packit |
5756e2 |
Owner: NMVpnEditorPlugin
|
|
Packit |
5756e2 |
Flags: Read
|
|
Packit |
5756e2 |
Default value: NULL
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
Signal Details
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
The “changed” signal
|
|
Packit |
5756e2 |
void
|
|
Packit |
5756e2 |
user_function (NMVpnEditor *nmvpneditor,
|
|
Packit |
5756e2 |
gpointer user_data)
|
|
Packit |
5756e2 |
Flags: Run First
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit |
5756e2 |
|
|
Packit Service |
a1bd4f |
Generated by GTK-Doc V1.33.0
|
|
Packit |
5756e2 |
</body>
|
|
Packit |
5756e2 |
</html>
|