File Logger

File Logger. More...

Typedefs
typedef enum fl_err_tag	fl_err_t
typedef bool(*	fl_iter_cb_t) (void *data, uint32_t data_len, void *arg)

Enumerations
enum	fl_err_tag {   FL_OK,   FL_ERROR,   FL_NOT_INIT,   FL_INVALID_DATA_LEN,   FL_WRITE_ERR,   FL_READ_ERR }

Functions
void *	file_logger_init (const char *name, uint32_t max_len)
fl_err_t	file_logger_write (void *logger, void *data, uint32_t data_len)
fl_err_t	file_logger_iter (void *logger, fl_iter_cb_t cb, void *arg)
fl_err_t	file_logger_clear (void *logger)
fl_err_t	file_logger_flush (void *logger)
fl_err_t	file_logger_close (void *logger)

Detailed Description

File Logger.

Function Documentation

file_logger_clear()

fl_err_t file_logger_clear

(

void *

logger

)

Clear all data in file logger

Parameters

[in]

logger

file logger handle created by file_logger_init

Returns

result

file_logger_close()

fl_err_t file_logger_close

(

void *

logger

)

close the file logger

Pending data would be flushed

Parameters

[in]

logger

file logger handle created by file_logger_init

Returns

result

file_logger_flush()

fl_err_t file_logger_flush

(

void *

logger

)

Flush all data to storage, ensure all data is written in storage instead of remaining in cache

Parameters

[in]

logger

file logger handle created by file_logger_init

Returns

result

file_logger_init()

void* file_logger_init	(	const char *	name,
		uint32_t	max_len
	)

Create a file logger

If the file already exists, it would be opened for write, otherwise a new file is created

Parameters

[in]	name	file full path
[in]	max_len	file max size

Returns

file logger handle

file_logger_iter()

fl_err_t file_logger_iter	(	void *	logger,
		fl_iter_cb_t	cb,
		void *	arg
	)

Iterate all data in file logger in write sequence

Parameters

[in]	logger	file logger handle created by file_logger_init
[in]	cb	callback for each data
[in]	arg	argument which would be passed to callback

Returns

result

file_logger_write()

fl_err_t file_logger_write	(	void *	logger,
		void *	data,
		uint32_t	data_len
	)

Write data in file logger

Parameters

[in]	logger	file logger handle created by file_logger_init
[in]	data	point to data to be written
[in]	data_len	data length in byte

Returns

result