\r\n

51Degrees Device Detection C/C++  4.5

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

hash.h

1 /* *********************************************************************
2  * This Original Work is copyright of 51 Degrees Mobile Experts Limited.
3  * Copyright 2023 51 Degrees Mobile Experts Limited, Davidson House,
4  * Forbury Square, Reading, Berkshire, United Kingdom RG1 3EU.
5  *
6  * This Original Work is the subject of the following patents and patent
7  * applications, owned by 51 Degrees Mobile Experts Limited of 5 Charlotte
8  * Close, Caversham, Reading, Berkshire, United Kingdom RG4 7BY:
9  * European Patent No. 3438848; and
10  * United States Patent No. 10,482,175.
11  *
12  * This Original Work is licensed under the European Union Public Licence
13  * (EUPL) v.1.2 and is subject to its terms as set out below.
14  *
15  * If a copy of the EUPL was not distributed with this file, You can obtain
16  * one at https://opensource.org/licenses/EUPL-1.2.
17  *
18  * The 'Compatible Licences' set out in the Appendix to the EUPL (as may be
19  * amended by the European Commission) shall be deemed incompatible for
20  * the purposes of the Work and the provisions of the compatibility
21  * clause in Article 5 of the EUPL shall not apply.
22  *
23  * If using the Work as, or as part of, a network application, by
24  * including the attribution notice(s) required under Article 5 of the EUPL
25  * in the end user terms of the application under an appropriate heading,
26  * such notice(s) shall fulfill the requirements of that article.
27  * ********************************************************************* */
28 
29 #ifndef FIFTYONE_DEGREES_HASH_INCLUDED
30 #define FIFTYONE_DEGREES_HASH_INCLUDED
31 
40 #if !defined(DEBUG) && !defined(_DEBUG) && !defined(NDEBUG)
41 #define NDEBUG
42 #endif
43 
44 #include <stdlib.h>
45 #include <stdio.h>
46 #include <string.h>
47 #include <limits.h>
48 #include <math.h>
49 #include <time.h>
50 #include <ctype.h>
51 #include <assert.h>
52 #ifdef _MSC_VER
53 #pragma warning(push)
54 #pragma warning(disable : 5105)
55 #include <windows.h>
56 #pragma warning(pop)
57 #endif
58 #include "../common-cxx/common.h"
59 #include "../common-cxx/data.h"
60 #include "../common-cxx/exceptions.h"
61 #include "../common-cxx/threading.h"
62 #include "../common-cxx/file.h"
63 #include "../common-cxx/collection.h"
64 #include "../common-cxx/evidence.h"
65 #include "../common-cxx/list.h"
66 #include "../common-cxx/resource.h"
67 #include "../common-cxx/properties.h"
68 #include "../common-cxx/status.h"
69 #include "../common-cxx/date.h"
70 #include "../common-cxx/pool.h"
71 #include "../common-cxx/component.h"
72 #include "../common-cxx/property.h"
73 #include "../common-cxx/value.h"
74 #include "../common-cxx/profile.h"
75 #include "../common-cxx/overrides.h"
76 #include "../common-cxx/json.h"
77 
78 #include "../config-dd.h"
79 #include "../dataset-dd.h"
80 #include "../results-dd.h"
81 #include "graph.h"
82 
84 #ifndef FIFTYONE_DEGREES_CACHE_CONCURRENCY
85 #ifndef FIFTYONE_DEGREES_NO_THREADING
86 #define FIFTYONE_DEGREES_CACHE_CONCURRENCY 10
87 #else
88 #define FIFTYONE_DEGREES_CACHE_CONCURRENCY 1
89 #endif
90 #endif
91 
95 #ifndef FIFTYONE_DEGREES_EVIDENCE_HIGH_ENTROPY_VALUES
96 #define FIFTYONE_DEGREES_EVIDENCE_HIGH_ENTROPY_VALUES \
97  (FIFTYONE_DEGREES_COMMON_COOKIE_PREFIX \
98  "gethighentropyvalues")
99 #endif
100 
104 #ifndef FIFTYONE_DEGREES_EVIDENCE_STRUCTURED_USER_AGENT
105 #define FIFTYONE_DEGREES_EVIDENCE_STRUCTURED_USER_AGENT \
106  (FIFTYONE_DEGREES_COMMON_COOKIE_PREFIX \
107  "structureduseragent")
108 #endif
109 
113 #ifndef FIFTYONE_DEGREES_EVIDENCE_DEVICE_ID
114 #define FIFTYONE_DEGREES_EVIDENCE_DEVICE_ID \
115  (FIFTYONE_DEGREES_COMMON_COOKIE_PREFIX \
116  "deviceId")
117 #endif
118 
127 typedef enum e_fiftyone_degrees_hash_match_method {
128  FIFTYONE_DEGREES_HASH_MATCH_METHOD_NONE,
129  FIFTYONE_DEGREES_HASH_MATCH_METHOD_PERFORMANCE,
130  FIFTYONE_DEGREES_HASH_MATCH_METHOD_COMBINED,
131  FIFTYONE_DEGREES_HASH_MATCH_METHOD_PREDICTIVE,
132  FIFTYONE_DEGREES_HASH_MATCH_METHODS_LENGTH
133 } fiftyoneDegreesHashMatchMethod;
134 
136 #pragma pack(push, 1)
137 typedef struct fiftyoneDegrees_hash_dataset_header_t {
138  const int32_t versionMajor;
139  const int32_t versionMinor;
140  const int32_t versionBuild;
141  const int32_t versionRevision;
143  const byte tag[16];
144  const byte exportTag[16];
145  const int32_t copyrightOffset;
147  const int16_t age;
148  const int32_t minUserAgentCount;
150  const int32_t nameOffset;
152  const int32_t formatOffset;
154  const fiftyoneDegreesDate published;
156  const fiftyoneDegreesDate nextUpdate;
158  const fiftyoneDegreesCollectionHeader strings;
160  const fiftyoneDegreesCollectionHeader components;
162  const fiftyoneDegreesCollectionHeader maps;
164  const fiftyoneDegreesCollectionHeader properties;
166  const fiftyoneDegreesCollectionHeader values;
168  const fiftyoneDegreesCollectionHeader profiles;
170  const fiftyoneDegreesCollectionHeader rootNodes;
173  const fiftyoneDegreesCollectionHeader nodes;
175  const fiftyoneDegreesCollectionHeader profileOffsets;
179 } fiftyoneDegreesDataSetHashHeader;
180 #pragma pack(pop)
181 
187 typedef struct fiftyone_degrees_config_hash_t {
188  fiftyoneDegreesConfigDeviceDetection b;
189  fiftyoneDegreesCollectionConfig strings;
190  fiftyoneDegreesCollectionConfig components;
192  fiftyoneDegreesCollectionConfig maps;
193  fiftyoneDegreesCollectionConfig properties;
195  fiftyoneDegreesCollectionConfig values;
196  fiftyoneDegreesCollectionConfig profiles;
197  fiftyoneDegreesCollectionConfig rootNodes;
199  fiftyoneDegreesCollectionConfig nodes;
200  fiftyoneDegreesCollectionConfig profileOffsets;
202  int32_t difference;
206  int32_t drift;
209  bool usePerformanceGraph;
211  bool usePredictiveGraph;
213  bool traceRoute;
217 } fiftyoneDegreesConfigHash;
218 
223 typedef struct fiftyone_degrees_hash_rootnodes_t {
224  uint32_t performanceNodeOffset;
226  uint32_t predictiveNodeOffset;
228 } fiftyoneDegreesHashRootNodes;
229 
239 typedef struct fiftyone_degrees_dataset_hash_t {
240  fiftyoneDegreesDataSetDeviceDetection b;
241  const fiftyoneDegreesDataSetHashHeader header;
242  const fiftyoneDegreesConfigHash config;
243  fiftyoneDegreesCollection *strings;
244  fiftyoneDegreesCollection *components;
245  fiftyoneDegreesList componentsList;
247  fiftyoneDegreesHeaderPtrs** componentHeaders;
249  bool *componentsAvailable;
252  uint32_t componentsAvailableCount;
254  fiftyoneDegreesCollection *maps;
255  fiftyoneDegreesCollection *properties;
256  fiftyoneDegreesCollection *values;
257  fiftyoneDegreesCollection *profiles;
258  fiftyoneDegreesCollection *rootNodes;
259  fiftyoneDegreesCollection *nodes;
260  fiftyoneDegreesCollection *profileOffsets;
263 } fiftyoneDegreesDataSetHash;
264 
266 typedef struct fiftyone_degrees_result_hash_t fiftyoneDegreesResultHash;
274 typedef struct fiftyone_degrees_result_hash_t {
275  fiftyoneDegreesResultUserAgent b;
276  uint32_t *profileOffsets;
278  bool *profileIsOverriden;
281  fiftyoneDegreesHashMatchMethod method;
283  int32_t iterations;
285  int32_t difference;
287  int32_t drift;
289  int32_t matchedNodes;
290  fiftyoneDegreesGraphTraceNode* trace;
296 } fiftyoneDegreesResultHash;
297 
301 #define FIFTYONE_DEGREES_RESULTS_HASH_MEMBERS \
302  fiftyoneDegreesResultsDeviceDetection b; \
303  fiftyoneDegreesCollectionItem propertyItem; \
305  fiftyoneDegreesList values;
308 FIFTYONE_DEGREES_ARRAY_TYPE(
309  fiftyoneDegreesResultHash,
310  FIFTYONE_DEGREES_RESULTS_HASH_MEMBERS)
311 
316 typedef fiftyoneDegreesResultHashArray fiftyoneDegreesResultsHash;
317 
329 EXTERNAL_VAR fiftyoneDegreesConfigHash fiftyoneDegreesHashInMemoryConfig;
330 
339 EXTERNAL_VAR fiftyoneDegreesConfigHash fiftyoneDegreesHashHighPerformanceConfig;
340 
352 EXTERNAL_VAR fiftyoneDegreesConfigHash fiftyoneDegreesHashLowMemoryConfig;
353 
366 EXTERNAL_VAR fiftyoneDegreesConfigHash fiftyoneDegreesHashBalancedConfig;
367 
376 EXTERNAL_VAR fiftyoneDegreesConfigHash fiftyoneDegreesHashBalancedTempConfig;
377 
387 EXTERNAL_VAR fiftyoneDegreesConfigHash fiftyoneDegreesHashDefaultConfig;
388 
410 EXTERNAL size_t fiftyoneDegreesHashSizeManagerFromFile(
411  fiftyoneDegreesConfigHash *config,
412  fiftyoneDegreesPropertiesRequired *properties,
413  const char *fileName,
414  fiftyoneDegreesException *exception);
415 
435 EXTERNAL fiftyoneDegreesStatusCode
436 fiftyoneDegreesHashInitManagerFromFile(
437  fiftyoneDegreesResourceManager *manager,
438  fiftyoneDegreesConfigHash *config,
439  fiftyoneDegreesPropertiesRequired *properties,
440  const char *fileName,
441  fiftyoneDegreesException *exception);
442 
460 EXTERNAL size_t fiftyoneDegreesHashSizeManagerFromMemory(
461  fiftyoneDegreesConfigHash *config,
462  fiftyoneDegreesPropertiesRequired *properties,
463  void *memory,
464  long size,
465  fiftyoneDegreesException *exception);
466 
485 EXTERNAL fiftyoneDegreesStatusCode
486 fiftyoneDegreesHashInitManagerFromMemory(
487  fiftyoneDegreesResourceManager *manager,
488  fiftyoneDegreesConfigHash *config,
489  fiftyoneDegreesPropertiesRequired *properties,
490  void *memory,
491  long size,
492  fiftyoneDegreesException *exception);
493 
513 EXTERNAL void fiftyoneDegreesResultsHashFromEvidence(
514  fiftyoneDegreesResultsHash *results,
515  fiftyoneDegreesEvidenceKeyValuePairArray *evidence,
516  fiftyoneDegreesException *exception);
517 
527 EXTERNAL void fiftyoneDegreesResultsHashFromUserAgent(
528  fiftyoneDegreesResultsHash *results,
529  const char* userAgent,
530  size_t userAgentLength,
531  fiftyoneDegreesException *exception);
532 
543 EXTERNAL int fiftyoneDegreesResultsHashFromDeviceId(
544  fiftyoneDegreesResultsHash *results,
545  const char* deviceId,
546  size_t deviceIdLength,
547  fiftyoneDegreesException *exception);
548 
561 EXTERNAL fiftyoneDegreesResultsHash* fiftyoneDegreesResultsHashCreate(
562  fiftyoneDegreesResourceManager *manager,
563  uint32_t overridesCapacity);
564 
571 EXTERNAL void fiftyoneDegreesResultsHashFree(
572  fiftyoneDegreesResultsHash* results);
573 
585 EXTERNAL bool fiftyoneDegreesResultsHashGetHasValues(
586  fiftyoneDegreesResultsHash* results,
587  int requiredPropertyIndex,
588  fiftyoneDegreesException *exception);
589 
600 EXTERNAL fiftyoneDegreesResultsNoValueReason
601  fiftyoneDegreesResultsHashGetNoValueReason(
602  fiftyoneDegreesResultsHash *results,
603  int requiredPropertyIndex,
604  fiftyoneDegreesException *exception);
605 
611 EXTERNAL const char* fiftyoneDegreesResultsHashGetNoValueReasonMessage(
612  fiftyoneDegreesResultsNoValueReason reason);
613 
627 EXTERNAL fiftyoneDegreesCollectionItem* fiftyoneDegreesResultsHashGetValues(
628  fiftyoneDegreesResultsHash* results,
629  int requiredPropertyIndex,
630  fiftyoneDegreesException *exception);
631 
644 EXTERNAL size_t fiftyoneDegreesResultsHashGetValuesString(
645  fiftyoneDegreesResultsHash* results,
646  const char *propertyName,
647  char* const buffer,
648  size_t const length,
649  char* const separator,
650  fiftyoneDegreesException *exception);
651 
663 EXTERNAL size_t fiftyoneDegreesResultsHashGetValuesJson(
664  fiftyoneDegreesResultsHash* results,
665  char* const buffer,
666  size_t const length,
667  fiftyoneDegreesException* exception);
668 
681 EXTERNAL size_t
682 fiftyoneDegreesResultsHashGetValuesStringByRequiredPropertyIndex(
683  fiftyoneDegreesResultsHash* results,
684  const int requiredPropertyIndex,
685  char* const buffer,
686  size_t const length,
687  char* const separator,
688  fiftyoneDegreesException *exception);
689 
703 EXTERNAL size_t fiftyoneDegreesResultsHashGetValuesStringAllProperties(
704  fiftyoneDegreesResultsHash* results,
705  char* const buffer,
706  size_t const length,
707  char* const separator,
708  fiftyoneDegreesException* exception);
709 
727 EXTERNAL fiftyoneDegreesStatusCode
728 fiftyoneDegreesHashReloadManagerFromOriginalFile(
729  fiftyoneDegreesResourceManager *manager,
730  fiftyoneDegreesException *exception);
731 
750 EXTERNAL fiftyoneDegreesStatusCode
751 fiftyoneDegreesHashReloadManagerFromFile(
752  fiftyoneDegreesResourceManager* manager,
753  const char *fileName,
754  fiftyoneDegreesException *exception);
755 
776 EXTERNAL fiftyoneDegreesStatusCode
777 fiftyoneDegreesHashReloadManagerFromMemory(
778  fiftyoneDegreesResourceManager *manager,
779  void *source,
780  long length,
781  fiftyoneDegreesException *exception);
782 
793 EXTERNAL fiftyoneDegreesDataSetHash* fiftyoneDegreesDataSetHashGet(
794  fiftyoneDegreesResourceManager *manager);
795 
802 EXTERNAL void fiftyoneDegreesDataSetHashRelease(
803  fiftyoneDegreesDataSetHash *dataSet);
804 
805 
819 EXTERNAL uint32_t fiftyoneDegreesHashIterateProfilesForPropertyAndValue(
820  fiftyoneDegreesResourceManager *manager,
821  const char *propertyName,
822  const char *valueName,
823  void *state,
824  fiftyoneDegreesProfileIterateMethod callback,
825  fiftyoneDegreesException *exception);
826 
839 EXTERNAL char* fiftyoneDegreesHashGetDeviceIdFromResult(
840  fiftyoneDegreesDataSetHash *dataSet,
841  fiftyoneDegreesResultHash *result,
842  char* const buffer,
843  size_t const length,
844  fiftyoneDegreesException *exception);
845 
856 EXTERNAL char* fiftyoneDegreesHashGetDeviceIdFromResults(
857  fiftyoneDegreesResultsHash *results,
858  char* const buffer,
859  size_t const length,
860  fiftyoneDegreesException *exception);
861 
866 #endif
fiftyoneDegreesHashRootNodes::predictiveNodeOffset
uint32_t predictiveNodeOffset
Offset in the nodes collection of the root node for the predictive graph.
Definition: hash.h:226
fiftyoneDegreesResultsHashGetValuesStringAllProperties
size_t fiftyoneDegreesResultsHashGetValuesStringAllProperties(fiftyoneDegreesResultsHash *results, char *const buffer, size_t const length, char *const separator, fiftyoneDegreesException *exception)
Sets the buffer the values associated in the results for all the available properties where each line...
fiftyoneDegreesDataSetHashHeader::nodes
const fiftyoneDegreesCollectionHeader nodes
Size and location of the nodes collection.
Definition: hash.h:173
fiftyoneDegreesConfigHash::drift
int32_t drift
The maximum drift to allow when matching hashes.
Definition: hash.h:206
fiftyoneDegreesDataSetDeviceDetection
Device detection data set structure which contains the 'must have's for all device detection data set...
Definition: dataset-dd.h:52
fiftyoneDegreesConfigHash::components
fiftyoneDegreesCollectionConfig components
Components collection config.
Definition: hash.h:190
fiftyoneDegreesHashBalancedConfig
EXTERNAL_VAR fiftyoneDegreesConfigHash fiftyoneDegreesHashBalancedConfig
Uses caching to balance memory usage and performance.
Definition: hash.h:367
fiftyoneDegreesDataSetHash::rootNodes
fiftyoneDegreesCollection * rootNodes
Collection of all root nodes.
Definition: hash.h:258
fiftyoneDegreesHashRootNodes::performanceNodeOffset
uint32_t performanceNodeOffset
Offset in the nodes collection of the root node for the performance graph.
Definition: hash.h:224
fiftyoneDegreesHashRootNodes
Data structure containing the root nodes for the combination of an evidence item and a component.
Definition: hash.h:223
fiftyoneDegreesResultHash
Singular User-Agent result returned by a Hash process method.
Definition: hash.h:274
fiftyoneDegreesCollectionHeader
Collection header structure which defines the size and location of the collection data.
Definition: collection.h:278
fiftyoneDegreesStatusCode
fiftyoneDegreesStatusCode
Status returned from the initialisation of a resource.
Definition: status.h:77
fiftyoneDegreesConfigHash::properties
fiftyoneDegreesCollectionConfig properties
Properties collection config.
Definition: hash.h:193
fiftyoneDegreesDataSetHashHeader::versionMinor
const int32_t versionMinor
Minor version of the data file loaded.
Definition: hash.h:139
fiftyoneDegreesDataSetHash::maps
fiftyoneDegreesCollection * maps
Collection data file maps.
Definition: hash.h:254
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 refe...
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 memor...
fiftyoneDegreesResultsHashGetNoValueReasonMessage
const char * fiftyoneDegreesResultsHashGetNoValueReasonMessage(fiftyoneDegreesResultsNoValueReason reason)
Gets a fuller description of the reason why a value is missing.
fiftyoneDegreesHashInMemoryConfig
EXTERNAL_VAR fiftyoneDegreesConfigHash fiftyoneDegreesHashInMemoryConfig
DETECTION CONFIGURATIONS.
Definition: hash.h:330
fiftyoneDegreesResultsHashGetValuesStringByRequiredPropertyIndex
size_t fiftyoneDegreesResultsHashGetValuesStringByRequiredPropertyIndex(fiftyoneDegreesResultsHash *results, const int requiredPropertyIndex, char *const buffer, size_t const length, char *const separator, fiftyoneDegreesException *exception)
Sets the buffer the values associated in the results for the property name.
fiftyoneDegreesResultHash::b
fiftyoneDegreesResultUserAgent b
Base User-Agent result.
Definition: hash.h:275
fiftyoneDegreesResultHash::profileOffsets
uint32_t * profileOffsets
Array of profile offsets where the index is the component index.
Definition: hash.h:276
fiftyoneDegreesResultsHashFree
void fiftyoneDegreesResultsHashFree(fiftyoneDegreesResultsHash *results)
Frees the results structure created by the fiftyoneDegreesResultsHashCreate method.
fiftyoneDegreesConfigHash::nodes
fiftyoneDegreesCollectionConfig nodes
Nodes collection config.
Definition: hash.h:199
fiftyoneDegreesResultsHashGetNoValueReason
fiftyoneDegreesResultsNoValueReason fiftyoneDegreesResultsHashGetNoValueReason(fiftyoneDegreesResultsHash *results, int requiredPropertyIndex, fiftyoneDegreesException *exception)
Gets the reason why a results does not contain valid values for a given property.
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 ...
fiftyoneDegreesHashSizeManagerFromMemory
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 ...
fiftyoneDegreesResultsHashGetValuesString
size_t fiftyoneDegreesResultsHashGetValuesString(fiftyoneDegreesResultsHash *results, const char *propertyName, char *const buffer, size_t const length, char *const separator, fiftyoneDegreesException *exception)
Sets the buffer the values associated in the results for the property name.
fiftyoneDegreesHashGetDeviceIdFromResult
char * fiftyoneDegreesHashGetDeviceIdFromResult(fiftyoneDegreesDataSetHash *dataSet, fiftyoneDegreesResultHash *result, char *const buffer, size_t const length, fiftyoneDegreesException *exception)
Get the device id string from the single result provided.
fiftyoneDegreesCollectionItem
Used to store a handle to the underlying item that could be used to release the item when it's finish...
Definition: collection.h:309
fiftyoneDegreesHashGetDeviceIdFromResults
char * fiftyoneDegreesHashGetDeviceIdFromResults(fiftyoneDegreesResultsHash *results, char *const buffer, size_t const length, fiftyoneDegreesException *exception)
Get the device id string from the results provided.
fiftyoneDegreesHashSizeManagerFromFile
size_t fiftyoneDegreesHashSizeManagerFromFile(fiftyoneDegreesConfigHash *config, fiftyoneDegreesPropertiesRequired *properties, const char *fileName, fiftyoneDegreesException *exception)
EXTERNAL METHODS.
fiftyoneDegreesResultsHashGetValues
fiftyoneDegreesCollectionItem * fiftyoneDegreesResultsHashGetValues(fiftyoneDegreesResultsHash *results, int requiredPropertyIndex, fiftyoneDegreesException *exception)
Populates the list of values in the results instance with value structure instances associated with t...
fiftyoneDegreesDataSetHash::header
const fiftyoneDegreesDataSetHashHeader header
Dataset header.
Definition: hash.h:241
fiftyoneDegreesDataSetHash::strings
fiftyoneDegreesCollection * strings
Collection of all strings.
Definition: hash.h:243
fiftyoneDegreesResultsHashFromEvidence
void fiftyoneDegreesResultsHashFromEvidence(fiftyoneDegreesResultsHash *results, fiftyoneDegreesEvidenceKeyValuePairArray *evidence, fiftyoneDegreesException *exception)
Processes the evidence value pairs in the evidence collection and populates the result in the results...
fiftyoneDegreesConfigHash::usePerformanceGraph
bool usePerformanceGraph
True if the performance optimized graph should be used for processing.
Definition: hash.h:209
fiftyoneDegreesResultHash::profileIsOverriden
bool * profileIsOverriden
Array of boolean flags indicating whether the result profile offset at the same index is one which ha...
Definition: hash.h:278
fiftyoneDegreesDataSetHashHeader::versionMajor
const int32_t versionMajor
Major version of the data file loaded.
Definition: hash.h:138
fiftyoneDegreesDate
Used to store the date when the dataset was produced and next date 51Degrees expect to provide a new ...
Definition: date.h:58
fiftyoneDegreesDataSetHashHeader::nextUpdate
const fiftyoneDegreesDate nextUpdate
Date when the next data file will be available.
Definition: hash.h:156
fiftyoneDegreesDataSetHash::componentHeaders
fiftyoneDegreesHeaderPtrs ** componentHeaders
Array of headers for each component index.
Definition: hash.h:247
fiftyoneDegreesHashHighPerformanceConfig
EXTERNAL_VAR fiftyoneDegreesConfigHash fiftyoneDegreesHashHighPerformanceConfig
Highest performance configuration.
Definition: hash.h:340
fiftyoneDegreesConfigHash::usePredictiveGraph
bool usePredictiveGraph
True if the predictive optimized graph should be used for processing.
Definition: hash.h:211
fiftyoneDegreesDataSetHashHeader::rootNodes
const fiftyoneDegreesCollectionHeader rootNodes
Root nodes which point to the start of each graph used in detection.
Definition: hash.h:170
fiftyoneDegreesDataSetHashHeader::versionBuild
const int32_t versionBuild
Build version of the data file loaded.
Definition: hash.h:140
fiftyoneDegreesDataSetHash::components
fiftyoneDegreesCollection * components
Collection of all components.
Definition: hash.h:244
fiftyoneDegreesResultHashArray
Array of items of type fiftyoneDegreesResultHash used to easily access and track the size of the arra...
Definition: hash.h:311
fiftyoneDegreesResultsHashGetHasValues
bool fiftyoneDegreesResultsHashGetHasValues(fiftyoneDegreesResultsHash *results, int requiredPropertyIndex, fiftyoneDegreesException *exception)
Gets whether or not the results provided contain valid values for the property index provided.
fiftyoneDegreesDataSetHash::values
fiftyoneDegreesCollection * values
Collection of all values.
Definition: hash.h:256
fiftyoneDegreesDataSetHashHeader::age
const int16_t age
Age of the data set format.
Definition: hash.h:147
fiftyoneDegreesDataSetHash::config
const fiftyoneDegreesConfigHash config
Copy of the configuration.
Definition: hash.h:242
fiftyoneDegreesDataSetHashHeader::profiles
const fiftyoneDegreesCollectionHeader profiles
Size and location of the profiles collection.
Definition: hash.h:168
fiftyoneDegreesConfigHash::profiles
fiftyoneDegreesCollectionConfig profiles
Profiles collection config.
Definition: hash.h:196
fiftyoneDegreesResultHash::matchedNodes
int32_t matchedNodes
The number of hashes matched in the User-Agent.
Definition: hash.h:289
fiftyoneDegreesDataSetHash::nodes
fiftyoneDegreesCollection * nodes
Collection of all hash nodes.
Definition: hash.h:259
fiftyoneDegreesHashDefaultConfig
EXTERNAL_VAR fiftyoneDegreesConfigHash fiftyoneDegreesHashDefaultConfig
Default detection configuration.
Definition: hash.h:388
fiftyoneDegreesDataSetHash
Data set structure containing all the components used for detections.
Definition: hash.h:239
fiftyoneDegreesDataSetHash::componentsAvailableCount
uint32_t componentsAvailableCount
Number of components with properties.
Definition: hash.h:252
fiftyoneDegreesHashMatchMethod
fiftyoneDegreesHashMatchMethod
DATA STRUCTURES.
Definition: hash.h:127
fiftyoneDegreesHashBalancedTempConfig
EXTERNAL_VAR fiftyoneDegreesConfigHash fiftyoneDegreesHashBalancedTempConfig
Balanced configuration modified to create a temporary file copy of the source data file to avoid lock...
Definition: hash.h:377
fiftyoneDegreesDataSetHashHeader::properties
const fiftyoneDegreesCollectionHeader properties
Size and location of the properties collection.
Definition: hash.h:164
fiftyoneDegreesHeaderPtrArray
Array of header indexes.
Definition: headers.h:131
fiftyoneDegreesDataSetHashHeader::components
const fiftyoneDegreesCollectionHeader components
Size and location of the components collection.
Definition: hash.h:160
fiftyoneDegreesDataSetHash::b
fiftyoneDegreesDataSetDeviceDetection b
Base data set.
Definition: hash.h:240
fiftyoneDegreesConfigHash::values
fiftyoneDegreesCollectionConfig values
Values collection config.
Definition: hash.h:195
fiftyoneDegreesDataSetHashHeader::profileOffsets
const fiftyoneDegreesCollectionHeader profileOffsets
Size and location of the profile offsets collection.
Definition: hash.h:175
fiftyoneDegreesDataSetHashRelease
void fiftyoneDegreesDataSetHashRelease(fiftyoneDegreesDataSetHash *dataSet)
Release the reference to a data set returned by the fiftyoneDegreesDataSetHashGet method.
fiftyoneDegreesResultsHashCreate
fiftyoneDegreesResultsHash * fiftyoneDegreesResultsHashCreate(fiftyoneDegreesResourceManager *manager, uint32_t overridesCapacity)
Allocates a results structure containing a reference to the Hash data set managed by the resource man...
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 point...
fiftyoneDegreesResultsNoValueReason
fiftyoneDegreesResultsNoValueReason
Enum containing reasons which cause a value to not be present or valid.
Definition: results.h:56
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.
fiftyoneDegreesDataSetHash::profiles
fiftyoneDegreesCollection * profiles
Collection of all profiles.
Definition: hash.h:257
fiftyoneDegreesResultsHashGetValuesJson
size_t fiftyoneDegreesResultsHashGetValuesJson(fiftyoneDegreesResultsHash *results, char *const buffer, size_t const length, fiftyoneDegreesException *exception)
Sets the buffer to a JSON string that represents all the available properties and values in the resul...
fiftyoneDegreesDataSetHashHeader::published
const fiftyoneDegreesDate published
Date when the data file was published.
Definition: hash.h:154
fiftyoneDegreesDataSetHashHeader::maps
const fiftyoneDegreesCollectionHeader maps
Size and location of the maps collection.
Definition: hash.h:162
fiftyoneDegreesResultUserAgent
Singular User-Agent result returned by a device detection process method.
Definition: results-dd.h:49
fiftyoneDegreesConfigHash::maps
fiftyoneDegreesCollectionConfig maps
Maps collection config.
Definition: hash.h:192
fiftyoneDegreesList
List structure which contains a list of collection items.
Definition: list.h:112
fiftyoneDegreesHashLowMemoryConfig
EXTERNAL_VAR fiftyoneDegreesConfigHash fiftyoneDegreesHashLowMemoryConfig
Low memory configuration.
Definition: hash.h:353
fiftyoneDegreesConfigHash::strings
fiftyoneDegreesCollectionConfig strings
Strings collection config.
Definition: hash.h:189
fiftyoneDegreesPropertiesRequired
Defines a set of properties which are required by a caller.
Definition: properties.h:175
fiftyoneDegreesDataSetHashGet
fiftyoneDegreesDataSetHash * fiftyoneDegreesDataSetHashGet(fiftyoneDegreesResourceManager *manager)
Gets a safe reference to the Hash data set from the resource manager.
fiftyoneDegreesEvidenceKeyValuePairArray
Array of evidence key value pairs and a pointer to the next array if present or NULL of not present.
Definition: evidence.h:191
fiftyoneDegreesDataSetHashHeader::formatOffset
const int32_t formatOffset
Offset of the data file format in the strings collection.
Definition: hash.h:152
fiftyoneDegreesResourceManager
Manager structure used to provide access to a shared and changing resource.
Definition: resource.h:173
fiftyoneDegreesCollectionConfig
Collection configuration structure which defines how the collection should be created by the create m...
Definition: collection.h:289
fiftyoneDegreesResultHash::iterations
int32_t iterations
Number of iterations required to get the device offset.
Definition: hash.h:283
fiftyoneDegreesDataSetHashHeader::strings
const fiftyoneDegreesCollectionHeader strings
Size and location of the strings collection.
Definition: hash.h:158
fiftyoneDegreesConfigHash::difference
int32_t difference
The maximum difference to allow when matching hashes.
Definition: hash.h:202
fiftyoneDegreesResultsHashFromUserAgent
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.
fiftyoneDegreesDataSetHash::profileOffsets
fiftyoneDegreesCollection * profileOffsets
Collection of all offsets to profiles in the profiles collection.
Definition: hash.h:260
fiftyoneDegreesDataSetHashHeader
Dataset header containing information about the dataset.
Definition: hash.h:137
fiftyoneDegreesException
Structure used to represent a 51Degrees exception and passed into methods that might generate excepti...
Definition: exceptions.h:111
fiftyoneDegreesResultsHashFromDeviceId
int 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.
evidence
Definition: GettingStarted.c:64
fiftyoneDegreesConfigHash::b
fiftyoneDegreesConfigDeviceDetection b
Base configuration.
Definition: hash.h:188
fiftyoneDegreesConfigHash
Hash specific configuration structure.
Definition: hash.h:187
fiftyoneDegreesConfigHash::rootNodes
fiftyoneDegreesCollectionConfig rootNodes
Root nodes collection config.
Definition: hash.h:197
fiftyoneDegreesDataSetHashHeader::copyrightOffset
const int32_t copyrightOffset
Offset of the copyright string in the strings collection.
Definition: hash.h:145
fiftyoneDegreesDataSetHashHeader::minUserAgentCount
const int32_t minUserAgentCount
Minimum count for a User-Agent to be included in the data file export.
Definition: hash.h:148
fiftyoneDegreesResultHash::method
fiftyoneDegreesHashMatchMethod method
The method used to provide the match result.
Definition: hash.h:281
fiftyoneDegreesDataSetHashHeader::values
const fiftyoneDegreesCollectionHeader values
Size and location of the values collection.
Definition: hash.h:166
fiftyoneDegreesGraphTraceNode
Trace node structure used to trace the route taken when evaluating a graph.
Definition: graph.h:144
fiftyoneDegreesDataSetHash::componentsList
fiftyoneDegreesList componentsList
List of component items from the components collection.
Definition: hash.h:245
fiftyoneDegreesConfigHash::profileOffsets
fiftyoneDegreesCollectionConfig profileOffsets
Profile offsets collection config.
Definition: hash.h:200
fiftyoneDegreesConfigDeviceDetection
Device detection configuration structure containing device detection specific configuration options,...
Definition: config-dd.h:52
fiftyoneDegreesConfigHash::traceRoute
bool traceRoute
True if the route through each graph should be traced during processing.
Definition: hash.h:213
fiftyoneDegreesResultHash::drift
int32_t drift
The maximum drift for a matched substring from the character position where it was expected to be fou...
Definition: hash.h:287
fiftyoneDegreesDataSetHash::componentsAvailable
bool * componentsAvailable
Array of flags indicating if there are any properties available for the component with the matching i...
Definition: hash.h:249
fiftyoneDegreesProfileIterateMethod
bool(* fiftyoneDegreesProfileIterateMethod)(void *state, fiftyoneDegreesCollectionItem *item)
Definition of a callback function which is passed an item of a type determined by the iteration metho...
Definition: profile.h:142
fiftyoneDegreesHashReloadManagerFromOriginalFile
fiftyoneDegreesStatusCode fiftyoneDegreesHashReloadManagerFromOriginalFile(fiftyoneDegreesResourceManager *manager, fiftyoneDegreesException *exception)
Reload the data set being used by the resource manager using the data file location which was used wh...
fiftyoneDegreesDataSetHashHeader::versionRevision
const int32_t versionRevision
Revision version of the data file loaded.
Definition: hash.h:141
fiftyoneDegreesDataSetHashHeader::nameOffset
const int32_t nameOffset
Offset of the data file name in the strings collection.
Definition: hash.h:150
fiftyoneDegreesCollection
All the shared methods and fields required by file, memory and cached collections.
Definition: collection.h:402
fiftyoneDegreesResultHash::trace
fiftyoneDegreesGraphTraceNode * trace
The graph trace constructed during processing if the option was enabled (and the executable was compi...
Definition: hash.h:290
fiftyoneDegreesResultHash::difference
int32_t difference
The total difference in hash code values between the matched substring and the actual substring.
Definition: hash.h:285
FIFTYONE_DEGREES_HASH_MATCH_METHODS_LENGTH
The length of the enum.
Definition: hash.h:132
FIFTYONE_DEGREES_RESULTS_HASH_MEMBERS
#define FIFTYONE_DEGREES_RESULTS_HASH_MEMBERS
Macro defining the common members of a Hash result.
Definition: hash.h:301
fiftyoneDegreesDataSetHash::properties
fiftyoneDegreesCollection * properties
Collection of all properties.
Definition: hash.h:255

Generated by doxygen 1.8.15