ioformat::Plugin Class Reference

Base class for all plugins. More...

#include <ioformat/plugin/Plugin.h>

Inherited by ioformat::FormatPlugin, and ioformat::ProtocolPlugin.

Public Types
using	StringSet = std::unordered_set< std::string >
using	StringMap = std::unordered_map< std::string, std::string >

Public Member Functions
virtual uint64_t	api () const =0
	Get the API version of the plugin.
virtual const std::string &	name () const =0
	Get the name of the plugin.
virtual const PluginVersion &	version () const =0
	Get the version of the plugin.
virtual void	initLog (iolink::LogLevel level)=0
	Initialize the plugin's logger.

Detailed Description

Base class for all plugins.

This class should not be used directly, inherit from ExtractorPlugin or WriterPlugin instead.

Member Function Documentation

api()

virtual uint64_t ioformat::Plugin::api ( ) const

inlinepure virtual

Get the API version of the plugin.

This is used internally to check compatibility between the plugin and the ioformat plugin loader.

Implemented in ioformat::ExtractorPlugin, ioformat::ProtocolPlugin, and ioformat::WriterPlugin.

---

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

• ioformat/public/include/ioformat/plugin/Plugin.h