◆ ConfigHash()
| FiftyoneDegrees::DeviceDetection::Hash::ConfigHash::ConfigHash | ( | fiftyoneDegreesConfigHash * | config | ) |
Construct a new instance using the configuration provided.
The values are copied and no reference to the provided parameter is retained.
- Parameters
-
- config - pointer to the configuration to copy
Member Function Documentation
◆ getConcurrency()
uint16_t FiftyoneDegrees::DeviceDetection::Hash::ConfigHash::getConcurrency ( ) virtualGet the lowest concurrency value in the list of possible concurrencies.
- Returns
- a 16 bit integer with the minimum concurrency value.
Reimplemented from FiftyoneDegrees::Common::ConfigBase.
◆ getConfig()
fiftyoneDegreesConfigHash* FiftyoneDegrees::DeviceDetection::Hash::ConfigHash::getConfig ( ) Gets the configuration data structure for use in C code.
Used internally.
- Returns
- pointer to the underlying configuration data structure.
◆ getDifference()
int FiftyoneDegrees::DeviceDetection::Hash::ConfigHash::getDifference ( ) Gets the difference value that should be used for all device detection requests.
- Returns
- the difference value to use for all device detection.
◆ getDrift()
int FiftyoneDegrees::DeviceDetection::Hash::ConfigHash::getDrift ( ) Gets the drift value that should be used for all device detection requests.
- Returns
- the drift value to use for all device detection.
◆ getNodes()
CollectionConfig FiftyoneDegrees::DeviceDetection::Hash::ConfigHash::getNodes ( ) Get the configuration for the nodes collection.
- Returns
- nodes collection configuration
◆ getProfileOffsets()
CollectionConfig FiftyoneDegrees::DeviceDetection::Hash::ConfigHash::getProfileOffsets ( ) Get the configuration for the profile offsets collection.
- Returns
- profile offsets collection configuration
◆ getProfiles()
CollectionConfig FiftyoneDegrees::DeviceDetection::Hash::ConfigHash::getProfiles ( ) Get the configuration for the profiles collection.
- Returns
- profiles collection configuration
◆ getProperties()
CollectionConfig FiftyoneDegrees::DeviceDetection::Hash::ConfigHash::getProperties ( ) Get the configuration for the properties collection.
- Returns
- properties collection configuration
◆ getStrings()
CollectionConfig FiftyoneDegrees::DeviceDetection::Hash::ConfigHash::getStrings ( ) Get the configuration for the strings collection.
- Returns
- strings collection configuration
◆ getTraceRoute()
bool FiftyoneDegrees::DeviceDetection::Hash::ConfigHash::getTraceRoute ( ) Gets whether the route through each graph should be traced during processing.
The trace can then be printed to debug the matching after the fact. Note that this option is only considered when compiled in debug mode.
- Returns
- true if graphs should be traced
◆ getUsePerformanceGraph()
bool FiftyoneDegrees::DeviceDetection::Hash::ConfigHash::getUsePerformanceGraph ( ) Get whether or not the performance optimized graph is used for processing.
- Returns
- true if the performance graph will be used
◆ getUsePredictiveGraph()
bool FiftyoneDegrees::DeviceDetection::Hash::ConfigHash::getUsePredictiveGraph ( ) Get whether or not the predicitive optimized graph is used for processing.
- Returns
- true if the performance graph will be used
◆ getTraceRoute()
bool FiftyoneDegrees::DeviceDetection::Hash::ConfigHash::getTraceRoute ( ) Gets whether the route through each graph should be traced during processing.
The trace can then be printed to debug the matching after the fact. Note that this option is only considered when compiled in debug mode.
- Returns
- true if graphs should be traced
◆ getUsePerformanceGraph()
bool FiftyoneDegrees::DeviceDetection::Hash::ConfigHash::getUsePerformanceGraph ( ) Get whether or not the performance optimized graph is used for processing.
- Returns
- true if the performance graph will be used
◆ getUsePredictiveGraph()
bool FiftyoneDegrees::DeviceDetection::Hash::ConfigHash::getUsePredictiveGraph ( ) Get whether or not the predicitive optimized graph is used for processing.
- Returns
- true if the performance graph will be used
◆ getValues()
CollectionConfig FiftyoneDegrees::DeviceDetection::Hash::ConfigHash::getValues ( ) Get the configuration for the values collection.
- Returns
- values collection configuration
◆ setBalanced()
void FiftyoneDegrees::DeviceDetection::Hash::ConfigHash::setBalanced ( ) Set the collections to use the balanced configuration.
◆ setBalancedTemp()
void FiftyoneDegrees::DeviceDetection::Hash::ConfigHash::setBalancedTemp ( ) Set the collections to use the balanced temp configuration.
◆ setConcurrency()
void FiftyoneDegrees::DeviceDetection::Hash::ConfigHash::setConcurrency ( uint16_t concurrency ) Set the expected concurrent requests for all the data set's collections.
All collections in the data set which use cached elements will have their caches constructued to allow for the concurrency value set here. See CollectionConfig::setConcurrency
- Parameters
-
- concurrency - expected concurrent requests
- Examples
- Hash/ReloadFromFile.cpp, and Hash/ReloadFromMemory.cpp.
◆ setDifference()
void FiftyoneDegrees::DeviceDetection::Hash::ConfigHash::setDifference ( int32_t difference ) Set the maximum difference in hash value to allow when finding hashes during the processing of HTTP headers.
If the difference is exceeded, the result is considered invalid and values will not be returned. By default this is 0.
- Parameters
-
- difference - to set
◆ setDrift()
void FiftyoneDegrees::DeviceDetection::Hash::ConfigHash::setDrift ( int32_t drift ) Set the maximum drift to allow when matching hashes.
If the drift is exceeded, the result is considered invalid and values will not be returned. By default this is 0.
- Parameters
-
- drift - to set
◆ setHighPerformance()
void FiftyoneDegrees::DeviceDetection::Hash::ConfigHash::setHighPerformance ( ) Set the collections to use the high performance configuration.
◆ setLowMemory()
void FiftyoneDegrees::DeviceDetection::Hash::ConfigHash::setLowMemory ( ) Set the collections to use the low memory configuration.
◆ setMaxPerformance()
void FiftyoneDegrees::DeviceDetection::Hash::ConfigHash::setMaxPerformance ( ) Set the collections to use the entirely in memory configuration.
◆ setTraceRoute()
void FiftyoneDegrees::DeviceDetection::Hash::ConfigHash::setTraceRoute ( bool shouldTrace ) Sets whether the route through each graph should be traced during processing.
The trace can then be printed to debug the matching after the fact. Note that this option is only considered when compiled in debug mode.
- Parameters
-
- shouldTrace - true if graphs should be traced
◆ setUsePerformanceGraph()
void FiftyoneDegrees::DeviceDetection::Hash::ConfigHash::setUsePerformanceGraph ( bool use ) Set whether or not the performance optimized graph is used for processing.
When processing evidence, the performance graph is optimised to find an answer as quick as possible. However, this can be at the expense of finding the best match for evidence which was not in the training data. If the predictive graph is also enabled, it will be used next if there was no match in the performance graph.
- Parameters
-
- use - true if the performance graph should be used
◆ setUsePredictiveGraph()
void FiftyoneDegrees::DeviceDetection::Hash::ConfigHash::setUsePredictiveGraph ( bool use ) Set whether or not the predictive optimized graph is used for processing.
When processing evidence, the predictive graph is optimised to find the best answer for evidence which was not in the training data. However, this is at the expense of processing time, as more possibilities are taken into consideration.
- Parameters
-
- use - true if the predictive graph should be used
The documentation for this class was generated from the following file:- /home/vsts/work/1/s/apis/device-detection-cxx/src/hash/ConfigHash.hpp