olaf_config.h File Reference

Olaf configuration pramameters. More...

#include <stdbool.h>
#include <string.h>
#include <stdlib.h>
#include <stdio.h>

Go to the source code of this file.

Data Structures
struct	Olaf_Config
	Configuration parameters defining the behaviour of Olaf. More...

Typedefs
typedef struct Olaf_Config	Olaf_Config

Functions
Olaf_Config *	olaf_config_default (void)
Olaf_Config *	olaf_config_test (void)
Olaf_Config *	olaf_config_esp_32 (void)
Olaf_Config *	olaf_config_mem (void)
void	olaf_config_destroy (Olaf_Config *config)

Detailed Description

Olaf configuration pramameters.

Holds the compile time configuration parameters.

To create a new queue, use olaf_config_default. To destroy a queue, use olaf_config_destroy.

Function Documentation

olaf_config_default()

Olaf_Config * olaf_config_default

(

void

)

The default configuration to use on traditional computers.

Returns

A new configuration struct, or NULL if it was not possible to allocate the memory.

olaf_config_destroy()

void olaf_config_destroy

(

Olaf_Config *

config

)

Free the memory used by the configuration struct

Parameters

config

The configuration struct to destroy.

olaf_config_esp_32()

Olaf_Config * olaf_config_esp_32

(

void

)

The configuration to use on ESP32 microcontrollers.

Returns

A new configuration struct, or NULL if it was not possible to allocate the memory.

olaf_config_mem()

Olaf_Config * olaf_config_mem

(

void

)

The configuration to use for an in memory database. This is mainly to test the ESP32 code.

Returns

A new configuration struct, or NULL if it was not possible to allocate the memory.

olaf_config_test()

Olaf_Config * olaf_config_test

(

void

)

The configuration to use for (unit) tests.

Returns

A new configuration struct, or NULL if it was not possible to allocate the memory.