, GError **error);

Parameters

@@ -256,7 +291,7 @@ nm_vpn_editor_plugin_get_editor (-Returns +Returns a new NMVpnEditor or NULL on error. [transfer full] @@ -269,13 +304,60 @@ nm_vpn_editor_plugin_get_capabilities ( +nm_vpn_editor_plugin_get_vt () +gsize +nm_vpn_editor_plugin_get_vt (NMVpnEditorPlugin *plugin, + NMVpnEditorPluginVT *vt, + gsize vt_size); +Returns an opaque VT function table for the plugin to extend +functionality. The actual meaning of NMVpnEditorPluginVT is not +defined in public API of libnm, instead it must be agreed by +both the plugin and the caller. See the header-only file +'nm-vpn-editor-plugin-call.h' which defines the meaning. + +Parameters +

+++++ ++++++++++++++++++

plugin	the NMVpnEditorPlugin
vt	buffer to be filled with the VT table of the plugin.	[out]
vt_size	the size of the buffer. Can be 0 to only query the +size of plugin's VT.

+

+ +Returns + the actual size of the plugin +'s virtual function table. + +Since: 1.4 + + + nm_vpn_editor_plugin_import () NMConnection * nm_vpn_editor_plugin_import (NMVpnEditorPlugin *plugin, const char *path, GError **error); -Parameters +Parameters @@ -302,7 +384,7 @@ nm_vpn_editor_plugin_import ( -Returns +Returns a new NMConnection imported from path , or NULL on error or if the file at path @@ -345,9 +427,10 @@ function. is not an absolute path name, it assumes the file is in the plugin directory of NetworkManager. In any case, the call will do certain checks on the file before passing it to dlopen. -A consequence for that is, that you cannot omit the ".so" suffix. +A consequence for that is, that you cannot omit the ".so" suffix +as you could for nm_vpn_editor_plugin_load(). -Parameters +Parameters @@ -398,12 +481,125 @@ loading the shared library. -Returns +Returns a new plugin instance or NULL on error. [transfer full] Since: 1.2 + + +nm_vpn_editor_plugin_load () +NMVpnEditorPlugin * +nm_vpn_editor_plugin_load (const char *plugin_name, + const char *check_service, + GError **error); +Load the shared libary plugin_name + and create a new +NMVpnEditorPlugin instace via the NMVpnEditorPluginFactory +function. +This is similar to nm_vpn_editor_plugin_load_from_file(), but +it does no validation of the plugin name, instead passes it directly +to dlopen(). If you have the full path to a plugin file, +nm_vpn_editor_plugin_load_from_file() is preferred. + +Parameters + +++++ + + + + + + + + + + + + + + + + + + plugin_name The name of the shared library to load. +This path will be directly passed to dlopen() without +further checks. check_service if not-null, check that the loaded plugin advertises +the given service. error on failure the error reason. + + +Returns + a new plugin instance or NULL on error. +[transfer full] + +Since: 1.4 + + + +nm_vpn_editor_plugin_get_plugin_info () +struct _NMVpnPluginInfo * +nm_vpn_editor_plugin_get_plugin_info (NMVpnEditorPlugin *plugin); + +Parameters + +++++ + + + + + + plugin the NMVpnEditorPlugin instance + + +Returns + if set, return the NMVpnPluginInfo instance. +[transfer none] + +Since: 1.4 + + + +nm_vpn_editor_plugin_set_plugin_info () +void +nm_vpn_editor_plugin_set_plugin_info (NMVpnEditorPlugin *plugin, + struct _NMVpnPluginInfo *plugin_info); +Set or clear the plugin-info instance. +This takes a weak reference on plugin_info +, to avoid circular +reference as the plugin-info might also reference the editor-plugin. + +Parameters + +++++ + + + + + + + + + + + + + plugin the NMVpnEditorPlugin instance plugin_info a NMVpnPluginInfo instance or NULL. [allow-none] + +Since: 1.4 + Types and Values @@ -411,7 +607,7 @@ loading the shared library. enum NMVpnEditorPluginCapability Flags that indicate certain capabilities of the plugin to editor programs. -Members +Members @@ -491,11 +687,17 @@ loading the shared library. GError **error); char * (*get_suggested_filename) (NMVpnEditorPlugin *plugin, NMConnection *connection); + + void (*notify_plugin_info_set) (NMVpnEditorPlugin *plugin, + struct _NMVpnPluginInfo *plugin_info); + + const NMVpnEditorPluginVT *(*get_vt) (NMVpnEditorPlugin *plugin, + gsize *out_vt_size); } NMVpnEditorPluginInterface; Interface for VPN editor plugins. -Members +Members @@ -504,11 +706,6 @@ loading the shared library. - - - - - @@ -546,6 +743,17 @@ name. Returned value will be NULL or a suggested f the caller. + + + + + + + + + + GTypeInterface g_iface; the parent interface get_editor () returns an NMVpnEditor, pre-filled with values from connection if non-NULL. notify_plugin_info_set () get_vt () return a virtual function table to implement further functions in +the plugin, without requiring to update libnm. Used by nm_vpn_editor_plugin_get_vt(). @@ -555,6 +763,11 @@ the caller. NMVpnEditor typedef struct _NMVpnEditor NMVpnEditor; + + +NMVpnEditorPluginVT +typedef struct _NMVpnEditorPluginVT NMVpnEditorPluginVT; + Property Details @@ -594,6 +807,6 @@ user_function ( - Generated by GTK-Doc V1.24 +Generated by GTK-Doc V1.25 \ No newline at end of file -- cgit 1.3.0-6-gf8a5

GTypeInterface `g_iface`;	the parent interface
`get_editor` ()	returns an NMVpnEditor, pre-filled with values from `connection` if non-`NULL`.
`notify_plugin_info_set` ()
`get_vt` ()	return a virtual function table to implement further functions in +the plugin, without requiring to update libnm. Used by `nm_vpn_editor_plugin_get_vt()`.

plugin_name	The name of the shared library to load. +This path will be directly passed to `dlopen()` without +further checks.
check_service	if not-null, check that the loaded plugin advertises +the given service.
error	on failure the error reason.

plugin	the NMVpnEditorPlugin instance
plugin_info	a NMVpnPluginInfo instance or `NULL`.	[allow-none]