RSB  0.19.0
rsb::ParticipantConfig::EventProcessingStrategy Class Reference

Instances of this class describe the selection and configuration of an event processing strategy. More...

#include <ParticipantConfig.h>

Inheritance diagram for rsb::ParticipantConfig::EventProcessingStrategy:
Inheritance graph
Collaboration diagram for rsb::ParticipantConfig::EventProcessingStrategy:
Collaboration graph

Public Member Functions

 EventProcessingStrategy (const std::string &name)
 
std::string getName () const
 Returns the name of the implementation to be selected. More...
 
void setName (const std::string &name)
 Sets the name of the implementation to be selected. More...
 
rsc::runtime::Properties getOptions () const
 Returns the options for the strategy. More...
 
rsc::runtime::Properties & mutableOptions ()
 Returns the options for the strategy. More...
 
void setOptions (const rsc::runtime::Properties &options)
 Sets the options for the strategy. More...
 
void handleOption (const std::vector< std::string > &key, const std::string &value)
 
void printContents (std::ostream &stream) const
 

Private Attributes

std::string name
 
rsc::runtime::Properties options
 

Detailed Description

Instances of this class describe the selection and configuration of an event processing strategy.

This mechanism is applied to select and configure implementations of eventprocessing::EventSendingStrategy and eventprocessing::EventReceivingStrategy.

Author
jmoringe

Definition at line 148 of file ParticipantConfig.h.

Constructor & Destructor Documentation

rsb::ParticipantConfig::EventProcessingStrategy::EventProcessingStrategy ( const std::string &  name)

Definition at line 139 of file ParticipantConfig.cpp.

Member Function Documentation

string rsb::ParticipantConfig::EventProcessingStrategy::getName ( ) const

Returns the name of the implementation to be selected.

Returns
The name of the processing strategy implementation that should be used.

Definition at line 143 of file ParticipantConfig.cpp.

References name.

Referenced by rsb::eventprocessing::PushInRouteConfigurator::createEventReceivingStrategy().

Here is the caller graph for this function:

Properties rsb::ParticipantConfig::EventProcessingStrategy::getOptions ( ) const

Returns the options for the strategy.

Returns
copy of options for the strategy

Definition at line 151 of file ParticipantConfig.cpp.

References options.

Referenced by rsb::eventprocessing::PushInRouteConfigurator::createEventReceivingStrategy().

Here is the caller graph for this function:

void rsb::ParticipantConfig::EventProcessingStrategy::handleOption ( const std::vector< std::string > &  key,
const std::string &  value 
)

Definition at line 163 of file ParticipantConfig.cpp.

References options.

Referenced by rsb::ParticipantConfig::handleOption().

Here is the caller graph for this function:

rsc::runtime::Properties & rsb::ParticipantConfig::EventProcessingStrategy::mutableOptions ( )

Returns the options for the strategy.

Returns
mutable reference to options for the strategy

Definition at line 155 of file ParticipantConfig.cpp.

References options.

void rsb::ParticipantConfig::EventProcessingStrategy::printContents ( std::ostream &  stream) const

Definition at line 173 of file ParticipantConfig.cpp.

References name, and options.

void rsb::ParticipantConfig::EventProcessingStrategy::setName ( const std::string &  name)

Sets the name of the implementation to be selected.

Parameters
name- Name of the processing strategy implementation that should be used.

Definition at line 147 of file ParticipantConfig.cpp.

References name.

Referenced by rsb::ParticipantConfig::handleOption().

Here is the caller graph for this function:

void rsb::ParticipantConfig::EventProcessingStrategy::setOptions ( const rsc::runtime::Properties &  options)

Sets the options for the strategy.

Parameters
optionsnew options replacing all old ones

Definition at line 159 of file ParticipantConfig.cpp.

References options.

Member Data Documentation

std::string rsb::ParticipantConfig::EventProcessingStrategy::name
private

Definition at line 195 of file ParticipantConfig.h.

Referenced by getName(), printContents(), and setName().

rsc::runtime::Properties rsb::ParticipantConfig::EventProcessingStrategy::options
private

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