Hazelcast C++ Client
Public Member Functions | List of all members
hazelcast::client::config::ConfigPatternMatcher Class Referenceabstract

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

#include <ConfigPatternMatcher.h>

+ Inheritance diagram for hazelcast::client::config::ConfigPatternMatcher:

Public Member Functions

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

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, semaphore 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.

Member Function Documentation

◆ matches()

virtual boost::shared_ptr<std::string> hazelcast::client::config::ConfigPatternMatcher::matches ( const std::vector< std::string > &  configPatterns,
const std::string &  itemName 
) 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::MatchingPointConfigPatternMatcher.


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