1/* *********************************************************************

2 * This Original Work is copyright of 51 Degrees Mobile Experts Limited.

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_COLLECTION_KEY_H_INCLUDED

24#define FIFTYONE_DEGREES_COLLECTION_KEY_H_INCLUDED

25

26#ifdef FIFTYONE_DEGREES_IPI_SYMBOLS

27#include "ipiSymbols.h"

28#endif

29

38

39#include <stdint.h>

40#include "propertyValueType.h"

41#include "exceptions.h"

42

49typedef uint32_t (*fiftyoneDegreesCollectionGetVariableSizeMethod)(

50 const void *initial,

51 fiftyoneDegreesException *exception);

52

56typedef union fiftyone_degrees_collection_index_or_offset_t {

57 uint32_t index;

58 uint32_t offset;

59} fiftyoneDegreesCollectionIndexOrOffset;

60

61static const fiftyoneDegreesCollectionIndexOrOffset

62 fiftyoneDegreesCollectionIndexOrOffset_Zero = { 0 };

63

67typedef struct fiftyone_degrees_collection_key_type_t {

68 const fiftyoneDegreesPropertyValueType valueType;

69 uint32_t initialBytesCount;

70 const fiftyoneDegreesCollectionGetVariableSizeMethod getFinalSizeMethod;

71} fiftyoneDegreesCollectionKeyType;

72

76typedef struct fiftyone_degrees_collection_key_t {

77 fiftyoneDegreesCollectionIndexOrOffset indexOrOffset;

78 const fiftyoneDegreesCollectionKeyType *keyType;

79} fiftyoneDegreesCollectionKey;

80

84

85#endif

fiftyoneDegreesCollectionGetVariableSizeMethod

uint32_t(* fiftyoneDegreesCollectionGetVariableSizeMethod)(const void *initial, fiftyoneDegreesException *exception)

Passed a pointer to the first part of a variable size item and returns the size of the entire item.

Definition collectionKey.h:49

fiftyoneDegreesCollectionKey

Explains to a collection (or cache) what the consumer is looking for.

Definition collectionKey.h:76

fiftyoneDegreesCollectionKey::keyType

const fiftyoneDegreesCollectionKeyType * keyType

Not used if collection is fixed width.

Definition collectionKey.h:78

fiftyoneDegreesCollectionKey::indexOrOffset

fiftyoneDegreesCollectionIndexOrOffset indexOrOffset

Where to look for the item.

Definition collectionKey.h:77

fiftyoneDegreesCollectionKeyType

Explains to a collection how to properly extract the requested value.

Definition collectionKey.h:67

fiftyoneDegreesCollectionKeyType::valueType

const fiftyoneDegreesPropertyValueType valueType

Size of known-length "head" of the item.

Definition collectionKey.h:68

fiftyoneDegreesCollectionKeyType::initialBytesCount

uint32_t initialBytesCount

Size of known-length "head" of the item.

Definition collectionKey.h:69

fiftyoneDegreesCollectionKeyType::getFinalSizeMethod

const fiftyoneDegreesCollectionGetVariableSizeMethod getFinalSizeMethod

Size of unknown-length "tail" of the item.

Definition collectionKey.h:70

fiftyoneDegreesException

Structure used to represent a 51Degrees exception and passed into methods that might generate excepti...

Definition exceptions.h:115

fiftyoneDegreesCollectionIndexOrOffset

Location of the item within the Collection.

Definition collectionKey.h:56

fiftyoneDegreesCollectionIndexOrOffset::offset

uint32_t offset

byte offset of the item from the start of collection.

Definition collectionKey.h:58

fiftyoneDegreesCollectionIndexOrOffset::index

uint32_t index

index of the item in the collection.

Definition collectionKey.h:57