7. Plugin Manager - PluginManager

The PluginManager module facilitates loading operations of plugin that will be used with the PluginLib object. Operation includes loading plugins, closing the loaded plugins, and setting the plugin log verbosity. Any plugin loaded with the PluginManager and not explicitly closed can be used through the PluginLib object and the LMan object.

The methods associated with a PluginManager object are the following.

• Begin and end an instance of an object, return object error flag

  • vdm_PluginManagerBegin() - create an instance of a PluginManager object

  • vdm_PluginManagerEnd() - destroy an instance of a PluginManager object

  • vdm_PluginManagerError() - return PluginManager object error flag

  • vdm_PluginManagerSetErrorLevel() - set the verbosity of the log

• Load plugins

  • vdm_PluginManagerLoadPlugin() - define the path to the plugin binary file to be loaded

• Close plugins

  • vdm_PluginManagerShutdown() - remove and close all loaded plugins

Instance a PluginManager object using vdm_PluginLibBegin(). Once instanced set pointers to abstract data functions using vdm_PluginLibDataFun().

7.1. Function Descriptions

The currently available PluginManager functions are described in detail in this section.

vdm_PluginManager *vdm_PluginManagerBegin(void)

create an instance of a PluginManager object

Create an instance of a PluginManager object. Memory is allocated for the object private data and the pointer to the data is returned.

Destroy an instance of a PluginManager object using

void vdm_PluginManagerEnd (vdm_PluginManager *PluginManager)

Return the current value of a PluginManager object error flag using

Vint vdm_PluginManagerError (vdm_PluginManager *PluginManager)

Returns:

The function returns a pointer to the newly created PluginManager object. If the object creation fails, NULL is returned.

void vdm_PluginManagerEnd(vdm_PluginManager *p)

end an instance of a PluginManager object

See vdm_PluginManagerBegin()

void vdm_PluginManagerShutdown(vdm_PluginManager *p)

clear the current instance of loaded plugins

void vdm_PluginManagerLoadPlugin(vdm_PluginManager *p, Vchar *pathToPluginLibrary)

load a pluginlibrary

Load a pluginlibrary. The path to the plugin library to load must not include the library extension: .dll, .so or .dylib.

Parameters:

• p – Pointer to PluginManager object.

• pathToPluginLibrary – Path to the plugin to load.

Vint vdm_PluginManagerError(vdm_PluginManager *p)

return the current value of a PluginManager object error flag

Report total number of errors notified. This will reset the counter to zero after

Parameters:

p – Pointer to PluginManager object.

Returns:

Integer error count

void vdm_PluginManagerSetErrorLevel(vdm_PluginManager *p, Vint errorLevel)

set plugin manager error level

Parameters:

• p – Pointer to PluginManager object.

• errorLevel – Error level for the plugin manager

  =0     No log (default)
  =1     Error
  =2     Warning
  =3     Info
  =4     Debug
  

Vint vdm_PluginManagerGetErrorLevel(vdm_PluginManager *p)

return plugin manager error level

Parameters:

p – Pointer to PluginManager object.

Returns:

Integer error level