Apama  10.7.2.2
com::softwareag::connectivity::chainmanagers::ManagedTransportConstructorParameters Class Reference

A container for parameters passed to the constructor of a managed transport (i.e. More...

#include <sag_connectivity_chain_managers.hpp>

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

Public Member Functions

const list_tgetSubscribeChannels () const
 Get the channels that the chain containing this transport instance is subscribed to for receiving messages from the host towards the transport. More...
 
const std::string & getDefaultChannelTowardsHost () const
 Get the default channel used on this chain for messages sent from the transport towards the host. More...
 
- Public Member Functions inherited from com::softwareag::connectivity::PluginConstructorParameters
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 container for parameters passed to the constructor of a managed transport (i.e.

a transport that has a chain manager).

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

The transport's constructor is called by the connectivity framework on creation of a chain, and receives a ManagedTransportConstructorParameters and any additional transport args passed to the createChain method.

Since
10.2.0.0

Member Function Documentation

◆ getDefaultChannelTowardsHost()

const std::string& com::softwareag::connectivity::chainmanagers::ManagedTransportConstructorParameters::getDefaultChannelTowardsHost ( ) const
inline

Get the default channel used on this chain for messages sent from the transport towards the host.

Returns
the channel name, or an empty string if this chain is only sending towards the transport (or if no default was specified when the chain was created by the manager).

◆ getSubscribeChannels()

const list_t& com::softwareag::connectivity::chainmanagers::ManagedTransportConstructorParameters::getSubscribeChannels ( ) const
inline

Get the channels that the chain containing this transport instance is subscribed to for receiving messages from the host towards the transport.

Returns
the list of channels, or empty if this chain is only sending towards the host and not towards the transport.

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