\r\n

51Degrees Device Detection C/C++  4.4

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

dataset-dd.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 licensed under the European Union Public Licence
7  * (EUPL) v.1.2 and is subject to its terms as set out below.
8  *
9  * If a copy of the EUPL was not distributed with this file, You can obtain
10  * one at https://opensource.org/licenses/EUPL-1.2.
11  *
12  * The 'Compatible Licences' set out in the Appendix to the EUPL (as may be
13  * amended by the European Commission) shall be deemed incompatible for
14  * the purposes of the Work and the provisions of the compatibility
15  * clause in Article 5 of the EUPL shall not apply.
16  *
17  * If using the Work as, or as part of, a network application, by
18  * including the attribution notice(s) required under Article 5 of the EUPL
19  * in the end user terms of the application under an appropriate heading,
20  * such notice(s) shall fulfill the requirements of that article.
21  * ********************************************************************* */
22 
23 #ifndef FIFTYONE_DEGREES_DATASET_DEVICE_DETECTION_H_INCLUDED
24 #define FIFTYONE_DEGREES_DATASET_DEVICE_DETECTION_H_INCLUDED
25 
26 #include <stdlib.h>
27 #include "common-cxx/dataset.h"
28 #include "config-dd.h"
29 
51 typedef struct fiftyone_degrees_dataset_device_detection_t {
52  fiftyoneDegreesDataSetBase b;
53  int uniqueUserAgentHeaderIndex;
55 } fiftyoneDegreesDataSetDeviceDetection;
56 
60 void fiftyoneDegreesDataSetDeviceDetectionRelease(
61  fiftyoneDegreesDataSetDeviceDetection *dataSet);
62 
66 void fiftyoneDegreesDataSetDeviceDetectionFree(
67  fiftyoneDegreesDataSetDeviceDetection *dataSet);
68 
72 fiftyoneDegreesDataSetDeviceDetection*
73 fiftyoneDegreesDataSetDeviceDetectionGet(
74  fiftyoneDegreesResourceManager *manager);
75 
96 fiftyoneDegreesStatusCode
97 fiftyoneDegreesDataSetDeviceDetectionInitPropertiesAndHeaders(
98  fiftyoneDegreesDataSetDeviceDetection *dataSet,
99  fiftyoneDegreesPropertiesRequired *properties,
100  void *state,
101  fiftyoneDegreesPropertiesGetMethod getPropertyMethod,
102  fiftyoneDegreesHeadersGetMethod getHeaderMethod,
103  fiftyoneDegreesOverridesFilterMethod overridesFilter,
104  fiftyoneDegreesEvidencePropertiesGetMethod getEvidencePropertiesMethod) ;
105 
109 void fiftyoneDegreesDataSetDeviceDetectionReset(
110  fiftyoneDegreesDataSetDeviceDetection *dataSet);
111 
116 #endif
fiftyoneDegreesDataSetDeviceDetection
Device detection data set structure which contains the 'must have's for all device detection data set...
Definition: dataset-dd.h:51
fiftyoneDegreesStatusCode
fiftyoneDegreesStatusCode
Status returned from the initialisation of a resource.
Definition: status.h:77
fiftyoneDegreesDataSetDeviceDetectionReset
void fiftyoneDegreesDataSetDeviceDetectionReset(fiftyoneDegreesDataSetDeviceDetection *dataSet)
Resets a newly allocated data set structure ready for initialisation.
fiftyoneDegreesEvidencePropertiesGetMethod
uint32_t(* fiftyoneDegreesEvidencePropertiesGetMethod)(void *state, fiftyoneDegreesPropertyAvailable *property, fiftyoneDegreesEvidenceProperties *evidenceProperties)
Populates the evidence properties structure with the indexes of the properties required by the proper...
Definition: properties.h:213
fiftyoneDegreesOverridesFilterMethod
bool(* fiftyoneDegreesOverridesFilterMethod)(void *state, uint32_t requiredPropertyIndex)
Determines if the required property index is eligible for overriding considering the configuration of...
Definition: overrides.h:134
fiftyoneDegreesDataSetDeviceDetection::uniqueUserAgentHeaderIndex
int uniqueUserAgentHeaderIndex
The unique HTTP header for the field name "User-Agent".
Definition: dataset-dd.h:53
fiftyoneDegreesDataSetDeviceDetectionRelease
void fiftyoneDegreesDataSetDeviceDetectionRelease(fiftyoneDegreesDataSetDeviceDetection *dataSet)
Releases a reference to a data set which has been fetched via the DataSetGet method.
fiftyoneDegreesDataSetDeviceDetectionGet
fiftyoneDegreesDataSetDeviceDetection * fiftyoneDegreesDataSetDeviceDetectionGet(fiftyoneDegreesResourceManager *manager)
Gets a pointer to the active data set from a resource manager.
fiftyoneDegreesDataSetDeviceDetection::b
fiftyoneDegreesDataSetBase b
Base structure members.
Definition: dataset-dd.h:52
fiftyoneDegreesPropertiesGetMethod
fiftyoneDegreesString *(* fiftyoneDegreesPropertiesGetMethod)(void *state, uint32_t index, fiftyoneDegreesCollectionItem *item)
Returns a string for the property at the index provided or NULL if there is no property available at ...
Definition: properties.h:195
fiftyoneDegreesDataSetDeviceDetectionInitPropertiesAndHeaders
fiftyoneDegreesStatusCode fiftyoneDegreesDataSetDeviceDetectionInitPropertiesAndHeaders(fiftyoneDegreesDataSetDeviceDetection *dataSet, fiftyoneDegreesPropertiesRequired *properties, void *state, fiftyoneDegreesPropertiesGetMethod getPropertyMethod, fiftyoneDegreesHeadersGetMethod getHeaderMethod, fiftyoneDegreesOverridesFilterMethod overridesFilter, fiftyoneDegreesEvidencePropertiesGetMethod getEvidencePropertiesMethod)
Initialise the header and properties using the fiftyoneDegreesDataSetInitProperties and fiftyoneDegre...
fiftyoneDegreesPropertiesRequired
Defines a set of properties which are required by a caller.
Definition: properties.h:175
fiftyoneDegreesResourceManager
Manager structure used to provide access to a shared and changing resource.
Definition: resource.h:173
fiftyoneDegreesDataSetBase
Base data set structure which contains the 'must have's for all data sets.
Definition: dataset.h:102
fiftyoneDegreesHeadersGetMethod
long(* fiftyoneDegreesHeadersGetMethod)(void *state, uint32_t index, fiftyoneDegreesCollectionItem *nameItem)
Gets the unique id and name of the header at the requested index.
Definition: headers.h:159
fiftyoneDegreesDataSetDeviceDetectionFree
void fiftyoneDegreesDataSetDeviceDetectionFree(fiftyoneDegreesDataSetDeviceDetection *dataSet)
Closes the data set by freeing anything which has been initialised at creation.

Generated by doxygen 1.8.15