51Degrees Device Detection C/C++  4.1Newer Version 4.2

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

Search

Documentation

Hash

• Device Detection
• Hash API

Detailed Description

All the functions specific to the Hash device detection API.

Collaboration diagram for Hash:

Structs

struct	fiftyoneDegreesDataSetHashHeader Dataset header containing information about the dataset. More...
struct	fiftyoneDegreesConfigHash Hash specific configuration structure. More...
struct	fiftyoneDegreesHashRootNodes Data structure containing the root nodes for the combination of an evidence item and a component. More...
struct	fiftyoneDegreesDataSetHash Data set structure containing all the components used for detections. More...
struct	fiftyoneDegreesResultHash Singular User-Agent result returned by a Hash process method. More...
struct	fiftyoneDegreesResultHashArray Array of items of type fiftyoneDegreesResultHash used to easily access and track the size of the array. More...

Macros

#define	FIFTYONE_DEGREES_CACHE_CONCURRENCY   10 Default value for the cache concurrency used in the default configuration. More...
#define	FIFTYONE_DEGREES_HASH_DIFFERENCE   0 Default value for the difference threshold used in the default configuration.
#define	FIFTYONE_DEGREES_HASH_DRIFT   0 Default value for the drift threshold used in the default configuration.
#define	FIFTYONE_DEGREES_STRING_CACHE_SIZE   10000 Default value for the string cache size used in the default collection configuration.
#define	FIFTYONE_DEGREES_STRING_LOADED   100 Default value for the string cache loaded size used in the default collection configuration.
#define	FIFTYONE_DEGREES_NODE_CACHE_SIZE   50000 Default value for the node cache size used in the default collection configuration.
#define	FIFTYONE_DEGREES_NODE_LOADED   100 Default value for the node cache loaded size used in the default collection configuration.
#define	FIFTYONE_DEGREES_PROFILE_CACHE_SIZE   10000 Default value for the profile cache size used in the default collection configuration.
#define	FIFTYONE_DEGREES_PROFILE_LOADED   100 Default value for the profile cache loaded size used in the default collection configuration.
#define	FIFTYONE_DEGREES_VALUE_CACHE_SIZE   500 Default value for the value cache size used in the default collection configuration.
#define	FIFTYONE_DEGREES_VALUE_LOADED   0 Default value for the value cache loaded size used in the default collection configuration.
#define	FIFTYONE_DEGREES_PROPERTY_CACHE_SIZE   0 Default value for the property cache size used in the default collection configuration.
#define	FIFTYONE_DEGREES_PROPERTY_LOADED   INT_MAX Default value for the property cache loaded size used in the default collection configuration.
#define	FIFTYONE_DEGREES_RESULTS_HASH_MEMBERS Macro defining the common members of a Hash result. More...

Typedefs

typedef fiftyoneDegreesResultHashArray

fiftyoneDegreesResultsHash Array of Hash results used to easily access and track the size of the array.

Enumerations

enum	fiftyoneDegreesHashMatchMethod {   FIFTYONE_DEGREES_HASH_MATCH_METHOD_NONE, FIFTYONE_DEGREES_HASH_MATCH_METHOD_PERFORMANCE, FIFTYONE_DEGREES_HASH_MATCH_METHOD_COMBINED, FIFTYONE_DEGREES_HASH_MATCH_METHOD_PREDICTIVE,   FIFTYONE_DEGREES_HASH_MATCH_METHODS_LENGTH } DATA STRUCTURES. More...

Functions

size_t	fiftyoneDegreesHashSizeManagerFromFile (fiftyoneDegreesConfigHash *config, fiftyoneDegreesPropertiesRequired *properties, const char *fileName, fiftyoneDegreesException *exception) EXTERNAL METHODS. More...
fiftyoneDegreesStatusCode	fiftyoneDegreesHashInitManagerFromFile (fiftyoneDegreesResourceManager *manager, fiftyoneDegreesConfigHash *config, fiftyoneDegreesPropertiesRequired *properties, const char *fileName, fiftyoneDegreesException *exception) Initialises the resource manager with a Hash data set resource populated from the Hash data file referred to by fileName. More...
size_t	fiftyoneDegreesHashSizeManagerFromMemory (fiftyoneDegreesConfigHash *config, fiftyoneDegreesPropertiesRequired *properties, void *memory, long size, fiftyoneDegreesException *exception) Gets the total size in bytes which will be allocated when intialising a Hash resource and associated manager with the same parameters. More...
fiftyoneDegreesStatusCode	fiftyoneDegreesHashInitManagerFromMemory (fiftyoneDegreesResourceManager *manager, fiftyoneDegreesConfigHash *config, fiftyoneDegreesPropertiesRequired *properties, void *memory, long size, fiftyoneDegreesException *exception) Initialises the resource manager with a Hash data set resource populated from the Hash data set pointed to by the memory parameter. More...
void	fiftyoneDegreesResultsHashFromEvidence (fiftyoneDegreesResultsHash *results, fiftyoneDegreesEvidenceKeyValuePairArray *evidence, fiftyoneDegreesException *exception) Processes the evidence value pairs in the evidence collection and populates the result in the results structure. More...
void	fiftyoneDegreesResultsHashFromUserAgent (fiftyoneDegreesResultsHash *results, const char *userAgent, size_t userAgentLength, fiftyoneDegreesException *exception) Process a single User-Agent and populate the device offsets in the results structure. More...
void	fiftyoneDegreesResultsHashFromDeviceId (fiftyoneDegreesResultsHash *results, const char *deviceId, size_t deviceIdLength, fiftyoneDegreesException *exception) Process a single Device Id and populate the device offsets in the results structure. More...
fiftyoneDegreesResultsHash *	fiftyoneDegreesResultsHashCreate (fiftyoneDegreesResourceManager *manager, uint32_t userAgentCapacity, uint32_t overridesCapacity) Allocates a results structure containing a reference to the Hash data set managed by the resource manager provided. More...
void	fiftyoneDegreesResultsHashFree (fiftyoneDegreesResultsHash *results) Frees the results structure created by the fiftyoneDegreesResultsHashCreate method. More...
bool	fiftyoneDegreesResultsHashGetHasValues (fiftyoneDegreesResultsHash *results, int requiredPropertyIndex, fiftyoneDegreesException *exception) Gets whether or not the results provided contain valid values for the property index provided. More...
fiftyoneDegreesResultsNoValueReason	fiftyoneDegreesResultsHashGetNoValueReason (fiftyoneDegreesResultsHash *results, int requiredPropertyIndex, fiftyoneDegreesException *exception) Gets the reason why a results does not contain valid values for a given property. More...
const char *	fiftyoneDegreesResultsHashGetNoValueReasonMessage (fiftyoneDegreesResultsNoValueReason reason) Gets a fuller description of the reason why a value is missing. More...
fiftyoneDegreesCollectionItem *	fiftyoneDegreesResultsHashGetValues (fiftyoneDegreesResultsHash *results, int requiredPropertyIndex, fiftyoneDegreesException *exception) Populates the list of values in the results instance with value structure instances associated with the required property index. More...
size_t	fiftyoneDegreesResultsHashGetValuesString (fiftyoneDegreesResultsHash *results, const char *propertyName, char *buffer, size_t bufferLength, const char *separator, fiftyoneDegreesException *exception) Sets the buffer the values associated in the results for the property name. More...
size_t	fiftyoneDegreesResultsHashGetValuesStringByRequiredPropertyIndex (fiftyoneDegreesResultsHash *results, const int requiredPropertyIndex, char *buffer, size_t bufferLength, const char *separator, fiftyoneDegreesException *exception) Sets the buffer the values associated in the results for the property name. More...
fiftyoneDegreesStatusCode	fiftyoneDegreesHashReloadManagerFromOriginalFile (fiftyoneDegreesResourceManager *manager, fiftyoneDegreesException *exception) Reload the data set being used by the resource manager using the data file location which was used when the manager was created. More...
fiftyoneDegreesStatusCode	fiftyoneDegreesHashReloadManagerFromFile (fiftyoneDegreesResourceManager *manager, const char *fileName, fiftyoneDegreesException *exception) Reload the data set being used by the resource manager using the data file location specified. More...
fiftyoneDegreesStatusCode	fiftyoneDegreesHashReloadManagerFromMemory (fiftyoneDegreesResourceManager *manager, void *source, long length, fiftyoneDegreesException *exception) Reload the data set being used by the resource manager using a data file loaded into contiguous memory. More...
fiftyoneDegreesDataSetHash *	fiftyoneDegreesDataSetHashGet (fiftyoneDegreesResourceManager *manager) Gets a safe reference to the Hash data set from the resource manager. More...
void	fiftyoneDegreesDataSetHashRelease (fiftyoneDegreesDataSetHash *dataSet) Release the reference to a data set returned by the fiftyoneDegreesDataSetHashGet method. More...
uint32_t	fiftyoneDegreesHashIterateProfilesForPropertyAndValue (fiftyoneDegreesResourceManager *manager, const char *propertyName, const char *valueName, void *state, fiftyoneDegreesProfileIterateMethod callback, fiftyoneDegreesException *exception) Iterates over the profiles in the data set calling the callback method for any profiles that contain the property and value provided. More...
char *	fiftyoneDegreesHashGetDeviceIdFromResult (fiftyoneDegreesDataSetHash *dataSet, fiftyoneDegreesResultHash *result, char *destination, size_t size, fiftyoneDegreesException *exception) Get the device id string from the single result provided. More...
char *	fiftyoneDegreesHashGetDeviceIdFromResults (fiftyoneDegreesResultsHash *results, char *destination, size_t size, fiftyoneDegreesException *exception) Get the device id string from the results provided. More...

Variables

fiftyoneDegreesConfigHash	fiftyoneDegreesHashInMemoryConfig DETECTION CONFIGURATIONS. More...
fiftyoneDegreesConfigHash	fiftyoneDegreesHashHighPerformanceConfig Highest performance configuration. More...
fiftyoneDegreesConfigHash	fiftyoneDegreesHashLowMemoryConfig Low memory configuration. More...
fiftyoneDegreesConfigHash	fiftyoneDegreesHashBalancedConfig Uses caching to balance memory usage and performance. More...
fiftyoneDegreesConfigHash	fiftyoneDegreesHashBalancedTempConfig Balanced configuration modified to create a temporary file copy of the source data file to avoid locking the source data file. More...
fiftyoneDegreesConfigHash	fiftyoneDegreesHashDefaultConfig Default detection configuration. More...
fiftyoneDegreesConfigHash	fiftyoneDegreesHashSingleLoadedConfig Configuration designed only for testing. More...

Macro Definition Documentation

◆ FIFTYONE_DEGREES_CACHE_CONCURRENCY

#define FIFTYONE_DEGREES_CACHE_CONCURRENCY   10

Default value for the cache concurrency used in the default configuration.

◆ FIFTYONE_DEGREES_RESULTS_HASH_MEMBERS

#define FIFTYONE_DEGREES_RESULTS_HASH_MEMBERS

Value:

fiftyoneDegreesResultsDeviceDetection b; \

fiftyoneDegreesCollectionItem propertyItem; \

fiftyoneDegreesList values;

Macro defining the common members of a Hash result.

List of value items when results are fetched

Enumeration Type Documentation

◆ fiftyoneDegreesHashMatchMethod

enum fiftyoneDegreesHashMatchMethod

DATA STRUCTURES.

Enum used to indicate which method was used to find a match for the evidence provided.

Enumerator
FIFTYONE_DEGREES_HASH_MATCH_METHODS_LENGTH	The length of the enum.

Function Documentation

◆ fiftyoneDegreesDataSetHashGet()

fiftyoneDegreesDataSetHash* fiftyoneDegreesDataSetHashGet

(

fiftyoneDegreesResourceManager *

manager

)

Gets a safe reference to the Hash data set from the resource manager.

Fetching through this method ensures that the data set it not freed or moved during the time it is in use. The data set returned by this method should be released with the fiftyoneDegreesDataSetHashRelease method.

Parameters

manager - the resource manager containing a hash data set initialised by one of the Hash data set init methods

Returns

a fixed pointer to the data set in manager

◆ fiftyoneDegreesDataSetHashRelease()

void fiftyoneDegreesDataSetHashRelease

(

fiftyoneDegreesDataSetHash *

dataSet

)

Release the reference to a data set returned by the fiftyoneDegreesDataSetHashGet method.

Doing so tell the resource manager linked to the data set that it is no longer being used.

Parameters

dataSet - pointer to the data set to release

◆ fiftyoneDegreesHashGetDeviceIdFromResult()

char* fiftyoneDegreesHashGetDeviceIdFromResult	(	fiftyoneDegreesDataSetHash *	dataSet,
		fiftyoneDegreesResultHash *	result,
		char *	destination,
		size_t	size,
		fiftyoneDegreesException *	exception
	)

Get the device id string from the single result provided.

This contains profile ids for all components, concatenated with the separator character '-'.

Parameters

dataSet - pointer to the data set used to get the result

result - pointer to the result to get the device id of

destination - pointer to the memory to write the characters to

size - amount of memory allocated to destination

exception - pointer to an exception data structure to be used if an exception occurs. See exceptions.h

Returns

the destination pointer

◆ fiftyoneDegreesHashGetDeviceIdFromResults()

char* fiftyoneDegreesHashGetDeviceIdFromResults	(	fiftyoneDegreesResultsHash *	results,
		char *	destination,
		size_t	size,
		fiftyoneDegreesException *	exception
	)

exception   )

Get the device id string from the single result provided.

This contains profile ids for all components, concatenated with the separator character '-'.

Parameters

dataSet - pointer to the data set used to get the result

result - pointer to the result to get the device id of

destination - pointer to the memory to write the characters to

size - amount of memory allocated to destination

exception - pointer to an exception data structure to be used if an exception occurs. See exceptions.h

Returns

the destination pointer

◆ fiftyoneDegreesHashGetDeviceIdFromResults()

char* fiftyoneDegreesHashGetDeviceIdFromResults	(	fiftyoneDegreesResultsHash *	results,
		char *	destination,
		size_t	size,
		fiftyoneDegreesException *	exception
	)

Get the device id string from the results provided.

This contains profile ids for all components, concatenated with the separator character '-'.

Parameters

results - pointer to the results to get the device id of

destination - pointer to the memory to write the characters to

size - amount of memory allocated to destination

exception - pointer to an exception data structure to be used if an exception occurs. See exceptions.h

Returns

the destination pointer

◆ fiftyoneDegreesHashInitManagerFromFile()

fiftyoneDegreesStatusCode fiftyoneDegreesHashInitManagerFromFile	(	fiftyoneDegreesResourceManager *	manager,
		fiftyoneDegreesConfigHash *	config,
		fiftyoneDegreesPropertiesRequired *	properties,
		const char *	fileName,
		fiftyoneDegreesException *	exception
	)

Initialises the resource manager with a Hash data set resource populated from the Hash data file referred to by fileName.

Configures the data set to operate using the configuration set in detection, collection and properties.

Parameters

manager - the resource manager to manager the share data set resource

config - configuration for the operation of the data set, or NULL if default detection configuration is required

properties - the properties that will be consumed from the data set, or NULL if all available properties in the Hash data file should be available for consumption

fileName - the full path to a file with read permission that contains the Hash data set

exception - pointer to an exception data structure to be used if an exception occurs. See exceptions.h.

Returns

the status associated with the data set resource assign to the resource manager. Any value other than FIFTYONE_DEGREES_STATUS_SUCCESS means the data set was not created and the resource manager can not be used.

Examples

Hash/GettingStarted.c, Hash/MatchMetrics.c, Hash/OfflineProcessing.c, and Hash/StronglyTyped.c.

◆ fiftyoneDegreesHashInitManagerFromMemory()

fiftyoneDegreesStatusCode fiftyoneDegreesHashInitManagerFromMemory	(	fiftyoneDegreesResourceManager *	manager,
		fiftyoneDegreesConfigHash *	config,
		fiftyoneDegreesPropertiesRequired *	properties,
		void *	memory,
		long	size,
		fiftyoneDegreesException *	exception
	)

Initialises the resource manager with a Hash data set resource populated from the Hash data set pointed to by the memory parameter.

Configures the data set to operate using the configuration set in detection and properties.

Parameters

manager - the resource manager to manager the share data set resource

config - configuration for the operation of the data set, or NULL if default detection configuration is required

properties - the properties that will be consumed from the data set, or NULL if all available properties in the Hash data file should be available for consumption

memory - pointer to continuous memory containing the Hash data set

size - the number of bytes that make up the Hash data set

exception - pointer to an exception data structure to be used if an exception occurs. See exceptions.h.

Returns

the status associated with the data set resource assign to the resource manager. Any value other than FIFTYONE_DEGREES_STATUS_SUCCESS means the data set was not created and the resource manager can not be used.

◆ fiftyoneDegreesHashIterateProfilesForPropertyAndValue()

uint32_t fiftyoneDegreesHashIterateProfilesForPropertyAndValue	(	fiftyoneDegreesResourceManager *	manager,
		const char *	propertyName,
		const char *	valueName,
		void *	state,
		fiftyoneDegreesProfileIterateMethod	callback,
		fiftyoneDegreesException *	exception
	)

Iterates over the profiles in the data set calling the callback method for any profiles that contain the property and value provided.

Parameters

manager - the resource manager containing a hash data set initialised by one of the Hash data set init methods

propertyName - name of the property which the value relates to

valueName - name of the property value which the profiles must contain

state - pointer passed to the callback method

callback - method called when a matching profile is found

exception - pointer to an exception data structure to be used if an exception occurs. See exceptions.h

Returns

the number of matching profiles iterated over

◆ fiftyoneDegreesHashReloadManagerFromFile()

fiftyoneDegreesStatusCode fiftyoneDegreesHashReloadManagerFromFile	(	fiftyoneDegreesResourceManager *	manager,
		const char *	fileName,
		fiftyoneDegreesException *	exception
	)

Reload the data set being used by the resource manager using the data file location specified.

When initialising the data, the configuration that manager was first created with is used.

If the new data file is successfully initialised, the current data set is replaced The old data will remain in memory until the last fiftyoneDegreesResultsHash which contain a reference to it are released.

This method is defined by the FIFTYONE_DEGREES_DATASET_RELOAD macro.

Parameters

manager - pointer to the resource manager to reload the data set for

fileName - path to the new data file

exception - pointer to an exception data structure to be used if an exception occurs. See exceptions.h.

Returns

the status associated with the data set reload. Any value other than FIFTYONE_DEGREES_STATUS_SUCCESS means the data set was not reloaded correctly

◆ fiftyoneDegreesHashReloadManagerFromMemory()

fiftyoneDegreesStatusCode fiftyoneDegreesHashReloadManagerFromMemory	(	fiftyoneDegreesResourceManager *	manager,
		void *	source,
		long	length,
		fiftyoneDegreesException *	exception
	)

Reload the data set being used by the resource manager using a data file loaded into contiguous memory.

When initialising the data, the configuration that manager was first created with is used.

If the data passed in is successfully initialised, the current data set is replaced The old data will remain in memory until the last fiftyoneDegreesResultsHash which contain a reference to it are released.

This method is defined by the FIFTYONE_DEGREES_DATASET_RELOAD macro.

Parameters

manag