entropic_compaction.cpp File Reference

C API facade for compaction operations. More...

#include "engine_handle.h"
#include <entropic/entropic.h>
#include <entropic/types/logging.h>

Include dependency graph for entropic_compaction.cpp:

Go to the source code of this file.

Functions
static entropic_error_t	check_compactor (entropic_handle_t h)
	Check handle prerequisites for compaction APIs.
ENTROPIC_EXPORT entropic_error_t	entropic_compact (entropic_handle_t handle, const char *identity, char **result_json)
	Trigger compaction on current context.
ENTROPIC_EXPORT entropic_error_t	entropic_register_compactor (entropic_handle_t handle, const char *identity, entropic_compactor_fn compactor, void *user_data)
	Register a custom compactor for an identity.
ENTROPIC_EXPORT entropic_error_t	entropic_deregister_compactor (entropic_handle_t handle, const char *identity)
	Deregister a custom compactor for an identity.
ENTROPIC_EXPORT entropic_error_t	entropic_get_default_compactor (entropic_handle_t handle, entropic_compactor_fn *compactor, void **user_data)
	Get the built-in default compactor function pointer.

Variables
static auto	logger = entropic::log::get("facade.compaction")

Detailed Description

C API facade for compaction operations.

Implements entropic_compact, entropic_register_compactor, entropic_deregister_compactor, and entropic_get_default_compactor.

Version

2.0.0

Definition in file entropic_compaction.cpp.

Function Documentation

check_compactor()

static entropic_error_t check_compactor ( entropic_handle_t  h )

static

Check handle prerequisites for compaction APIs.

Parameters

h	Engine handle.

Returns

ENTROPIC_OK if valid, error code otherwise.

Definition at line 26 of file entropic_compaction.cpp.

entropic_compact()

ENTROPIC_EXPORT entropic_error_t entropic_compact	(	entropic_handle_t	handle,
		const char *	identity,
		char **	result_json
	)

Trigger compaction on current context.

Trigger compaction on the current context.

Parameters

handle	Engine handle returned by entropic_create.
identity	Identity name from configured tier set.
result_json	Out-param: newly allocated JSON string (caller owns; free with entropic_free).

Returns

ENTROPIC_OK on success.

Definition at line 43 of file entropic_compaction.cpp.

entropic_deregister_compactor()

ENTROPIC_EXPORT entropic_error_t entropic_deregister_compactor	(	entropic_handle_t	handle,
		const char *	identity
	)

Deregister a custom compactor for an identity.

Parameters

handle	Engine handle returned by entropic_create.
identity	Identity name from configured tier set.

Returns

ENTROPIC_OK on success.

Definition at line 100 of file entropic_compaction.cpp.

entropic_get_default_compactor()

ENTROPIC_EXPORT entropic_error_t entropic_get_default_compactor	(	entropic_handle_t	handle,
		entropic_compactor_fn *	compactor,
		void **	user_data
	)

Get the built-in default compactor function pointer.

Parameters

handle	Engine handle returned by entropic_create.
compactor	Out-param: receives function pointer to current compactor.
user_data	Opaque pointer passed back to the callback.

Returns

ENTROPIC_OK on success.

Definition at line 123 of file entropic_compaction.cpp.

entropic_register_compactor()

ENTROPIC_EXPORT entropic_error_t entropic_register_compactor	(	entropic_handle_t	handle,
		const char *	identity,
		entropic_compactor_fn	compactor,
		void *	user_data
	)

Register a custom compactor for an identity.

Parameters

handle	Engine handle returned by entropic_create.
identity	Identity name from configured tier set.
compactor	Function pointer to consumer-supplied compactor.
user_data	Opaque pointer passed back to the callback.

Returns

ENTROPIC_OK on success.

Definition at line 72 of file entropic_compaction.cpp.

Variable Documentation

logger

auto logger = entropic::log::get("facade.compaction")

static

Definition at line 17 of file entropic_compaction.cpp.