| threaddb 2.0 A file mapped memory container extension

Classes | Macros | Typedefs | Enumerations
threaddbTypes.h File Reference

Basic data types used by the interface. More...

`#include <stdint.h>`
`#include <stddef.h>`

Go to the source code of this file.

## Classes
struct | threadDB_LinkInfo
| Data item entry index. More...
struct | threadDB_ItemInfo
| Random access managment information. More...
struct | threadDB_ReadInfo
| Stream reading control information. More...

## Macros
#define | DLLEXPORT_

## Typedefs
typedef struct threadDB_LinkInfo | threadDB_LinkInfo
| Data item entry index. More...
typedef struct threadDB_ItemInfo | threadDB_ItemInfo
| Random access managment information. More...
typedef struct threadDB_ReadInfo | threadDB_ReadInfo
| Stream reading control information. More...
typedef int32_t | threadDB_ReturnCode

## Enumerations
enum | threadDB_RelocationType { eCopyFileTo = 0, eMoveFileTo = 1 }
| Type of action to be performed when relocating a temporary database file. More...

## Detailed Description

Basic data types used by the interface.

This module provides the underlying data structures required to interact with the database.

## Macro Definition Documentation

## ◆ DLLEXPORT_

#define DLLEXPORT_

## Typedef Documentation

## ◆ threadDB_ItemInfo

typedef struct threadDB_ItemInfo threadDB_ItemInfo

Random access managment information.

This structure reflects the information required for random access of indivdual database items. It provides information on the position of the item and the size of the stored data record. The datastructure has to be preallocated and - if required - provided to the ThreadDB_Store routine. It can then be used in the ThreadDB_OpenItem and ThreadDB_RecoverRandom function to read individual data items.

## ◆ threadDB_LinkInfo

typedef struct threadDB_LinkInfo threadDB_LinkInfo

Data item entry index.

This structure reflects the information required to uniquely identify a data item in the database. It provides information on the temporary database file, the file position of the data record and the position within the data record.

## ◆ threadDB_ReadInfo

typedef struct threadDB_ReadInfo threadDB_ReadInfo

Stream reading control information.

This structure reflects the information required for continious stream reading of data items. It provides information on the position of the item, the size of the stored data record, a temporary record buffer and the allocated buffers size. The read information is created by the functions ThreadDB_Open and @ ref ThreadDB_OpenItem and required for the call to ThreadDB_RecoverContinous function.

## ◆ threadDB_ReturnCode

typedef int32_t threadDB_ReturnCode

## Enumeration Type Documentation

## ◆ threadDB_RelocationType

enum threadDB_RelocationType

Type of action to be performed when relocating a temporary database file.

The parameter defines if a temporary database file should be copied or moved when transferred to another path or partition.

Enumerator
eCopyFileTo | Indicates copy operation has to be executed.
eMoveFileTo | Indicates move operation has to be exectued.