Writer functions

Functions for writing to log or config files. More...

Functions
int	addFileHeader (FILE *logFile, uint16_t index, HeaderData *headerData, unsigned int *seed)
	Writes header information to the log file.
FILE *	openLogForWriting (const char *subject, const char *tag, uint16_t index, size_t chunkSize, HeaderData *headerData, Config *config, const char *configFile)
	Opens a log file for writing.
FILE *	openNewLogForWriting (const char *subject, const char *tag, uint16_t index, size_t chunkSize, HeaderData *headerData, Config *config, unsigned int *seed, const char *configFile)
	Opens a new log file for writing.

Detailed Description

Functions for writing to log or config files.

Function Documentation

addFileHeader()

int addFileHeader	(	FILE *	logFile,
		uint16_t	index,
		HeaderData *	headerData,
		unsigned int *	seed )

Writes header information to the log file.

Parameters

logFile	Pointer to the log file.
index	The index of the log file.
headerData	Pointer to the header data structure.
seed	Pointer to random number seed. If NULL, file header generates new seed; otherwise use this seed for random generator.

Returns

0 if header was successfully written, 1 otherwise.

openLogForWriting()

FILE * openLogForWriting	(	const char *	subject,
		const char *	tag,
		uint16_t	index,
		size_t	chunkSize,
		HeaderData *	headerData,
		Config *	config,
		const char *	configFile )

Opens a log file for writing.

Parameters

subject	The subject of the log file.
tag	The tag of the log file.
index	The index of the log file.
chunkSize	The size of each data chunk.
headerData	Pointer to the header data structure.
config	Pointer to the logger configuration.
configFile	The file and path of the configuration file.

Returns

A pointer to the opened log file if successful, NULL otherwise.

openNewLogForWriting()

FILE * openNewLogForWriting	(	const char *	subject,
		const char *	tag,
		uint16_t	index,
		size_t	chunkSize,
		HeaderData *	headerData,
		Config *	config,
		unsigned int *	seed,
		const char *	configFile )

Opens a new log file for writing.

Parameters

subject	The subject of the log file.
tag	The tag of the log file.
index	The index of the log file.
chunkSize	The size of each data chunk.
headerData	Pointer to the header data structure.
config	Pointer to the logger configuration.
seed	Pointer to random generator seed. If NULL, file header generates new seed; otherwise use this seed for random generator.
configFile	The file and path of the configuration file.

Returns

A pointer to the opened log file if successful, NULL otherwise.