ocf_cleaner.h File Reference

OCF cleaner API for synchronization dirty data. More...

Go to the source code of this file.

Typedefs
typedef void(*	ocf_cleaner_end_t) (ocf_cleaner_t cleaner, uint32_t interval)
	OCF Cleaner completion. More...

Functions
void	ocf_cleaner_set_cmpl (ocf_cleaner_t cleaner, ocf_cleaner_end_t fn)
	Set cleaner completion function. More...
void	ocf_cleaner_run (ocf_cleaner_t c, ocf_queue_t queue)
	Run cleaner. More...
void	ocf_cleaner_set_priv (ocf_cleaner_t c, void *priv)
	Set cleaner private data. More...
void *	ocf_cleaner_get_priv (ocf_cleaner_t c)
	Get cleaner private data. More...
ocf_cache_t	ocf_cleaner_get_cache (ocf_cleaner_t c)
	Get cache instance to which cleaner belongs. More...

Detailed Description

OCF cleaner API for synchronization dirty data.

Typedef Documentation

ocf_cleaner_end_t

typedef void(* ocf_cleaner_end_t) (ocf_cleaner_t cleaner, uint32_t interval)

OCF Cleaner completion.

Note

Completion function for cleaner

Parameters

[in]	cleaner	Cleaner instance
[in]	interval	Time to sleep before next cleaner iteration

Function Documentation

ocf_cleaner_get_cache()

ocf_cache_t ocf_cleaner_get_cache

(

ocf_cleaner_t

c

)

Get cache instance to which cleaner belongs.

Parameters

[in]

c

Cleaner handle

Return values

Cache

instance

ocf_cleaner_get_priv()

void* ocf_cleaner_get_priv

(

ocf_cleaner_t

c

)

Get cleaner private data.

Parameters

[in]

c

Cleaner handle

Return values

Cleaner

private data

ocf_cleaner_run()

void ocf_cleaner_run	(	ocf_cleaner_t	c,
		ocf_queue_t	queue
	)

Run cleaner.

Parameters

[in]	c	Cleaner instance to run
[in]	queue	IO queue handle

ocf_cleaner_set_cmpl()

void ocf_cleaner_set_cmpl	(	ocf_cleaner_t	cleaner,
		ocf_cleaner_end_t	fn
	)

Set cleaner completion function.

Parameters

[in]	cleaner	Cleaner instance
[in]	fn	Completion function

ocf_cleaner_set_priv()

void ocf_cleaner_set_priv	(	ocf_cleaner_t	c,
		void *	priv
	)

Set cleaner private data.

Parameters

[in]	c	Cleaner handle
[in]	priv	Private data