ext_status.h File Reference

External interface for storing/loading Kaa status. More...

Go to the source code of this file.

Functions
void	ext_status_read (char **buffer, size_t *buffer_size, bool *needs_deallocation)
	Called on Kaa startup to restore the persisted state. More...
void	ext_status_store (const char *buffer, size_t buffer_size)
	Called when Kaa is ready to persist its state. More...
void	ext_status_delete (void)
	Deletes a status storage. More...

Detailed Description

External interface for storing/loading Kaa status.

Function Documentation

void ext_status_delete

(

void

)

Deletes a status storage.

void ext_status_read	(	char **	buffer,
		size_t *	buffer_size,
		bool *	needs_deallocation
	)

Called on Kaa startup to restore the persisted state.

Fetch persisted state to buffer and provide a valid size of it in buffer_size. If *buffer == NULL or *buffer_size == 0 Kaa library will use default values. Set *needs_deallocation = true if buffer should be deallocated by Kaa, false otherwise.

Parameters

[out]	buffer	Pointer to buffer which should be filled with Kaa status data.
[out]	buffer_size	Pointer to buffer's size.
[out]	needs_deallocation	Indicates if the Kaa library should deallocate buffer by itself.

void ext_status_store	(	const char *	buffer,
		size_t	buffer_size
	)

Called when Kaa is ready to persist its state.

Parameters

[in]	buffer	Valid pointer to buffer which contains the current Kaa status data.
[in]	buffer_size	The buffer's size.