rti::routing::adapter::AdapterPlugin Class Reference

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

#include <AdapterPlugin.hpp>

Public Member Functions
virtual Connection *	create_connection (StreamReaderListener *input_stream_discovery_listener, StreamReaderListener *output_stream_discovery_listener, const PropertySet &properties)=0
	Creates a Connection.
virtual void	delete_connection (Connection *connection)=0
	Deletes a Connection.
virtual rti::config::LibraryVersion	get_version () const
virtual	~AdapterPlugin ()
	Virtual destructor.

Detailed Description

The top-level plug-in class.

Represents a factory of Connection.

Constructor & Destructor Documentation

virtual rti::routing::adapter::AdapterPlugin::~AdapterPlugin ( )

inlinevirtual

Virtual destructor.

Member Function Documentation

virtual Connection* rti::routing::adapter::AdapterPlugin::create_connection ( StreamReaderListener *  input_stream_discovery_listener, StreamReaderListener *  output_stream_discovery_listener, const PropertySet &  properties  )

pure virtual

Creates a Connection.

Connection objects are created when the domain routes that contain them are enabled.

Parameters

input_stream_discovery_listener	<<in>> The listener of the built-in DiscoveryStreamReader that notifies the discovery of new input streams.
output_stream_discovery_listener	<<in>> The listener of the built-in DiscoveryStreamReader that notifies the discovery of new output streams.
properties	<<in>> Configuration properties for the Connection. These properties corresponds to the properties specified within the tag <connection>.

Returns

New Connection if successful. Cannot return nullptr.

Exceptions

std::exception

Multi-threading safety:

Safe

virtual void rti::routing::adapter::AdapterPlugin::delete_connection ( Connection *  connection )

pure virtual

Deletes a Connection.

Connection objects are deleted when the domain routes that contain them are disabled or RTI Routing Service is stopped.

Parameters

connection

<<in>> Connection to be deleted

Exceptions

std::exception

Multi-threading safety:

Safe

virtual rti::config::LibraryVersion rti::routing::adapter::AdapterPlugin::get_version ( ) const

inlinevirtual

Returns

The version of this AdapterPlugin.

Version is used for logging purposes and allows you to track which version of the AdapterPlugin RTI Routing Service is using.

*Default implementation of this operation returns the version of the required Connext libraries.