collection.h
bool fiftyoneDegreesCollectionGetIsMemoryOnly()
Determines if in memory collection methods have been compiled so they are fully optimized.
fiftyoneDegreesCollection * source
The source collection used to load items into the cache.
Definition: collection.h:460
Type of collection where items are cached as they are used.
Definition: collection.h:459
fiftyoneDegreesCollectionFileRead read
Read method used to read an item from file at an offset or index.
Definition: collection.h:449
Collection header structure which defines the size and location of the collection data.
Definition: collection.h:277
void * fiftyoneDegreesCollectionReadFileFixed(const fiftyoneDegreesCollectionFile *file, uint32_t index, fiftyoneDegreesData *data, fiftyoneDegreesException *exception)
Used with collections where each item is a fixed number of bytes recorded in elementSize.
fiftyoneDegreesCache * cache
Loading cache to use as data source.
Definition: collection.h:462
int(* fiftyoneDegreesCollectionItemComparer)(void *state, fiftyoneDegreesCollectionItem *item, fiftyoneDegreesException *exception)
Compares two items and returns the difference between them for the purposes of a binary search of ord...
Definition: collection.h:370
int32_t fiftyoneDegreesCollectionGetInteger32(fiftyoneDegreesCollection *collection, uint32_t indexOrOffset, fiftyoneDegreesException *exception)
Returns a 32 bit integer from collections that provide such values.
fiftyoneDegreesCollectionHeader fiftyoneDegreesCollectionHeaderFromFile(FILE *file, uint32_t elementSize, bool isCount)
Reads the 4 bytes at the current reader position and configures the collection header.
long fiftyoneDegreesCollectionBinarySearch(fiftyoneDegreesCollection *collection, fiftyoneDegreesCollectionItem *item, uint32_t lowerIndex, uint32_t upperIndex, void *state, fiftyoneDegreesCollectionItemComparer comparer, fiftyoneDegreesException *exception)
Where a collection is fixed width and contains an ordered list of items this method is used to perfor...
fiftyoneDegreesCollection * collection
The generic collection.
Definition: collection.h:445
bool(* fiftyoneDegreesCollectionIterateMethod)(void *state, uint32_t key, void *data)
Method used to iterate over data held in a collection.
Definition: collection.h:397
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
void(* fiftyoneDegreesCollectionReleaseMethod)(fiftyoneDegreesCollectionItem *item)
Releases the item so that the collection can free the memory or take other actions when the caller no...
Definition: collection.h:380
fiftyoneDegreesFileHandle * fiftyoneDegreesCollectionReadFilePosition(const fiftyoneDegreesCollectionFile *file, uint32_t offset, fiftyoneDegreesException *exception)
Get a handle from the file pool associated with the collection and position the file handle at the of...
Used to read data from memory in a similar manner to a file handle.
Definition: memory.h:58
void *(* fiftyoneDegreesCollectionFileRead)(const fiftyoneDegreesCollectionFile *collection, uint32_t offsetOrIndex, fiftyoneDegreesData *data, fiftyoneDegreesException *exception)
Reads the item from the underlying data file.
Definition: collection.h:354
Cache structure to store the root of the red black tree and a list of allocated cache nodes.
Definition: cache.h:184
fiftyoneDegreesCollectionFreeMethod freeCollection
Frees collection and all items retrieved from the collection will become invalid.
Definition: collection.h:414
void *(* fiftyoneDegreesCollectionGetMethod)(fiftyoneDegreesCollection *collection, uint32_t indexOrOffset, fiftyoneDegreesCollectionItem *item, fiftyoneDegreesException *exception)
Gets an item from the collection.
Definition: collection.h:329
fiftyoneDegreesCollection * fiftyoneDegreesCollectionCreateFromFile(FILE *file, fiftyoneDegreesFilePool *reader, const fiftyoneDegreesCollectionConfig *config, fiftyoneDegreesCollectionHeader header, fiftyoneDegreesCollectionFileRead read)
Creates a collection from the file handle at the current position in the file.
uint32_t count
The number of items, or 0 if not available.
Definition: collection.h:424
Type of collection where the collection is streamed from file.
Definition: collection.h:444
fiftyoneDegreesCollection * collection
Collection the item came from which may not have been set.
Definition: collection.h:312
uint32_t capacity
Number of items the cache should store, 0 for no cache.
Definition: collection.h:291
byte * firstByte
The first byte in memory of the collection.
Definition: collection.h:435
uint32_t fiftyoneDegreesCollectionGetCount(fiftyoneDegreesCollection *collection)
Gets the actual number of items in the collection by iterating through to the base collection.
Data structure used for reusing memory which may have been allocated in a previous operation.
Definition: data.h:106
uint32_t count
Number of entities in the collection.
Definition: collection.h:280
fiftyoneDegreesCollectionHeader fiftyoneDegreesCollectionHeaderFromMemory(fiftyoneDegreesMemoryReader *reader, uint32_t elementSize, bool isCount)
Reads the 4 bytes at the current reader position and configures the collection header.
void * handle
A handle that relates to the data.
Definition: collection.h:311
uint32_t startPosition
Start position in the data file of the entities.
Definition: collection.h:278
long offset
Offset to the collection in the source data structure.
Definition: collection.h:448
void * memoryToFree
Memory to free when freeing the collection, or NULL if no memory to free.
Definition: collection.h:437
fiftyoneDegreesCollection * next
The next collection implementation or NULL.
Definition: collection.h:422
fiftyoneDegreesFilePool * reader
Reader used to load items into the cache, or NULL if no cache.
Definition: collection.h:446
uint16_t concurrency
Expected number of concurrent requests, 1 or greater.
Definition: collection.h:293
uint32_t elementSize
The size of each entry, or 0 if variable length.
Definition: collection.h:425
fiftyoneDegreesCollectionGetMethod get
Gets an entry into the item provided.
Definition: collection.h:408
void * state
Pointer to data for memory, cache or file.
Definition: collection.h:418
uint32_t loaded
Number of items to load into memory from the start of the collection.
Definition: collection.h:289
void * memoryToFree
Memory to free when freeing the collection, or NULL if no memory to free.
Definition: collection.h:437
fiftyoneDegreesCollection * next
The next collection implementation or NULL.
Definition: collection.h:422
fiftyoneDegreesFilePool * reader
Reader used to load items into the cache, or NULL if no cache.
Definition: collection.h:446
uint16_t concurrency
Expected number of concurrent requests, 1 or greater.
Definition: collection.h:293
uint32_t elementSize
The size of each entry, or 0 if variable length.
Definition: collection.h:425
fiftyoneDegreesCollectionGetMethod get
Gets an entry into the item provided.
Definition: collection.h:408
void * state
Pointer to data for memory, cache or file.
Definition: collection.h:418
uint32_t loaded
Number of items to load into memory from the start of the collection.
Definition: collection.h:289
Collection configuration structure which defines how the collection should be created by the create m...
Definition: collection.h:288
void * fiftyoneDegreesCollectionReadFileVariable(const fiftyoneDegreesCollectionFile *file, fiftyoneDegreesData *data, uint32_t offset, void *initial, size_t initialSize, fiftyoneDegreesCollectionGetFileVariableSizeMethod getFinalSize, fiftyoneDegreesException *exception)
Reads a variable size item from the file where the initial bytes can be used to calculate the size of...
void(* fiftyoneDegreesCollectionFreeMethod)(fiftyoneDegreesCollection *collection)
Frees all the memory and handles associated with the collection.
Definition: collection.h:387
Structure used to represent a 51Degrees exception and passed into methods that might generate excepti...
Definition: exceptions.h:116
Type of collection where the collection is held in continuous memory.
Definition: collection.h:433
fiftyoneDegreesCollection * fiftyoneDegreesCollectionCreateFromMemory(fiftyoneDegreesMemoryReader *reader, fiftyoneDegreesCollectionHeader header)
Creates the collection from a memory reader where the collection maps to the memory allocated to the ...
Stack of handles used to read data from a single source file.
Definition: file.h:222
uint32_t length
Length in bytes of all the entities.
Definition: collection.h:279
All the shared methods and fields required by file, memory and cached collections.
Definition: collection.h:407
fiftyoneDegreesData data
Item data including allocated memory.
Definition: collection.h:310
fiftyoneDegreesCollectionReleaseMethod release
Releases the item handle.
Definition: collection.h:412
byte * lastByte
The last byte in memory of the collection.
Definition: collection.h:436
fiftyoneDegreesCollection * collection
The generic collection.
Definition: collection.h:434
uint32_t size
Number of bytes in the source data structure containing the collection's data.
Definition: collection.h:426
uint32_t(* fiftyoneDegreesCollectionGetFileVariableSizeMethod)(void *initial)
Passed a pointer to the first part of a variable size item and returns the size of the entire item.
Definition: collection.h:341