Apama  10.15.0.2
com::softwareag::connectivity::PluginConstructorParameters Class Reference

A base interface for parameters passed to the constructor of transport or codec plug-ins. More...

#include <sag_connectivity_plugins.hpp>

Inheritance diagram for com::softwareag::connectivity::PluginConstructorParameters:
com::softwareag::connectivity::PluginConstructorParameters::CodecConstructorParameters com::softwareag::connectivity::PluginConstructorParameters::TransportConstructorParameters com::softwareag::connectivity::chainmanagers::ManagedTransportConstructorParameters

Classes

class  CodecConstructorParameters
 A container for parameters passed to the constructor of a codec plug-in. More...
 
class  TransportConstructorParameters
 A container for parameters passed to the constructor of a transport plug-in. More...
 

Public Member Functions

const map_tgetConfig () const
 Get the configuration for this plug-in. More...
 
const std::string & getChainId () const
 Get the identifier used for the chain this plug-in is part of. More...
 
const std::string & getPluginName () const
 Get the name used in the configuration file for this plug-in. More...
 

Detailed Description

A base interface for parameters passed to the constructor of transport or codec plug-ins.

Compatibility note: new methods may be added to this interface in future releases.

See also
PluginConstructorParameters::TransportConstructorParameters
PluginConstructorParameters::CodecConstructorParameters
Since
9.12.0.1

Member Function Documentation

◆ getChainId()

const std::string& com::softwareag::connectivity::PluginConstructorParameters::getChainId ( ) const
inline

Get the identifier used for the chain this plug-in is part of.

◆ getConfig()

const map_t& com::softwareag::connectivity::PluginConstructorParameters::getConfig ( ) const
inline

Get the configuration for this plug-in.

It is usually more convenient to access configuration using the non-const (mutable) config field instead of this method.

◆ getPluginName()

const std::string& com::softwareag::connectivity::PluginConstructorParameters::getPluginName ( ) const
inline

Get the name used in the configuration file for this plug-in.


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