cloe::PluginManifest Struct Reference

#include <plugin.hpp>

Public Attributes
const char *	plugin_type
const char *	plugin_type_version
const char *	factory_symbol
int	glibc_dlopen_mode

Detailed Description

PluginManifest is the C struct that can be dynamically loaded and which defines the interface between the Cloe engine and a Cloe plugin.

See the EXPORT_CLOE_PLUGIN macro for more information on how to define this struct.

Member Data Documentation

factory_symbol

const char* cloe::PluginManifest::factory_symbol

The factory symbol defines which function should be used to create the model factory.

glibc_dlopen_mode

int cloe::PluginManifest::glibc_dlopen_mode

The dlopen is RTLD_LOCAL | RTLD_NOW by default but can be overridden here.

See the CLOE_PLUGIN_GLIBC_DLOPEN_MODE define for information on how to configure this.

Since

CLOE_PLUGIN_VERSION == 1

cloe-runtime == 0.18.0

plugin_type

const char* cloe::PluginManifest::plugin_type

The plugin type is one of: component, controller, simulator.

plugin_type_version

const char* cloe::PluginManifest::plugin_type_version

The plugin API version is defined by the plugin type above.

---

The documentation for this struct was generated from the following file:

• /home/docs/checkouts/readthedocs.org/user_builds/cloe/checkouts/latest/runtime/include/cloe/plugin.hpp