A device detection library that is used natively or by 51Degrees products

fiftyoneDegreesConfigDeviceDetection Struct Reference

Detailed Description

Device detection configuration structure containing device detection specific configuration options, and options that apply to structures and methods in device detection libraries.

Collaboration diagram for fiftyoneDegreesConfigDeviceDetection:

[legend]

Data Fields

fiftyoneDegreesConfigBase b
 Base structure members.
bool updateMatchedUserAgent
 True if the detection should record the matched characters from the target User-Agent.
size_t maxMatchedUserAgentLength
 Limit in bytes on the length of a single header such as User-Agent, of a pseudo header including the separators between its values, and of the matched User-Agent.
bool allowUnmatched
 True if there should be at least one matched node in order for the results to be considered valid.
bool processSpecialEvidence
 Some evidence requires additional processing that doesn't need to be checked for if being used in an environment that doesn't generate it.

Field Documentation

◆ allowUnmatched

bool fiftyoneDegreesConfigDeviceDetection::allowUnmatched

True if there should be at least one matched node in order for the results to be considered valid.

By default, this is false

◆ maxMatchedUserAgentLength

size_t fiftyoneDegreesConfigDeviceDetection::maxMatchedUserAgentLength

Limit in bytes on the length of a single header such as User-Agent, of a pseudo header including the separators between its values, and of the matched User-Agent.

The working memory for a pseudo header is allocated from this value when a set of results is created, and detection does not grow it. A value longer than the limit is ignored and detection moves on to the next header. A direct User-Agent call over the limit gives the same results as evidence holding that value. The limit applies whether or not updateMatchedUserAgent is true. To raise the limit set a larger value before the data set is created, which also raises the memory each set of results holds.

◆ processSpecialEvidence

bool fiftyoneDegreesConfigDeviceDetection::processSpecialEvidence

Some evidence requires additional processing that doesn't need to be checked for if being used in an environment that doesn't generate it.

For example; GHEV and SUA query evidence. By default, this is true.

Examples
Hash/GettingStarted.c, and Hash/Performance.c.

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