The top-level plug-in class. More...

#include <ProcessorPlugin.hpp>

Public Member Functions
virtual Processor *	create_processor (Route &route, const rti::routing::PropertySet &properties)=0
	Creates a Route Processor. More...

virtual void	delete_processor (Route &route, Processor *processor)=0
	Deletes a Route Processor. More...

virtual rti::config::LibraryVersion	get_version () const

virtual	~ProcessorPlugin ()
	Virtual destructor. More...

Detailed Description

The top-level plug-in class.

Represents a factory of Processor.

Constructor & Destructor Documentation

◆ ~ProcessorPlugin()

virtual rti::routing::processor::ProcessorPlugin::~ProcessorPlugin ( )

inlinevirtual

Virtual destructor.

Member Function Documentation

◆ create_processor()

virtual Processor* rti::routing::processor::ProcessorPlugin::create_processor	(	Route &	route,
		const rti::routing::PropertySet &	properties
	)

pure virtual

Creates a Route Processor.

This function is called when the Route containing the Processor is enabled.

A Routing Service running instance will product a log indicating the occurrence of this event. For example:

Required: yes

Parameters

route	<<in>> An object representation of the Route that owns the Processor.
properties	<<in>> Configuration properties for the Processor. These properties corresponds to the properties specified within the tag <processor>.

Returns: New Processor if successful. Cannot return nullptr.

Exceptions

std::exception

Multi-threading safety:: Safe

◆ delete_processor()

virtual void rti::routing::processor::ProcessorPlugin::delete_processor	(	Route &	route,
		Processor *	processor
	)

pure virtual

Deletes a Route Processor.

This function is called when the Route containing the Processor is disabled.