Hazelcast C++ Client
Hazelcast C++ Client Library
Loading...
Searching...
No Matches
hazelcast::client::config::config_pattern_matcher Class Referenceabstract

The ConfigPatternMatcher provides a strategy to match an item name to a configuration pattern. More...

#include <config_pattern_matcher.h>

Inheritance diagram for hazelcast::client::config::config_pattern_matcher:

Public Member Functions

virtual std::shared_ptr< std::string > matches (const std::vector< std::string > &config_patterns, const std::string &item_name) const =0
 Returns the best match for an item name out of a list of configuration patterns.

Detailed Description

The ConfigPatternMatcher provides a strategy to match an item name to a configuration pattern.

It is used on each Config.getXXXConfig() and ClientConfig.getXXXConfig() call for map, list, queue, set, executor, topic, etc., so for example itemName is the name of a map and configPatterns are all defined map configurations.

If no configuration is found by the matcher it should return NULL. In this case the default config will be used for this item then. If multiple configurations are found by the matcher a exception::ConfigurationException should be thrown.

The default matcher is hazelcast::config::matcher::MatchingPointConfigPatternMatcher.

Definition at line 39 of file config_pattern_matcher.h.

Member Function Documentation

◆ matches()

virtual std::shared_ptr< std::string > hazelcast::client::config::config_pattern_matcher::matches ( const std::vector< std::string > & config_patterns,
const std::string & item_name ) const
pure virtual

Returns the best match for an item name out of a list of configuration patterns.

Parameters
configPatternslist of configuration patterns
itemNameitem name to match
Returns
a key of configPatterns which matches the item name or
NULL
if nothing matches
Exceptions
ConfigurationExceptionif ambiguous configurations are found

Implemented in hazelcast::client::config::matcher::matching_point_config_pattern_matcher.


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