sopc_circular_log_file.h File Reference

#include <stdarg.h>
#include <stdbool.h>
#include <stdint.h>

Go to the source code of this file.

Data Structures
struct	SOPC_CircularLogFile_Configuration
	structure containing the file system log configuration More...

Typedefs
typedef struct SOPC_CircularLogFile	SOPC_CircularLogFile
typedef struct SOPC_CircularLogFile_Configuration	SOPC_CircularLogFile_Configuration
	structure containing the file system log configuration

Functions
SOPC_CircularLogFile *	SOPC_CircularLogFile_Create (const SOPC_CircularLogFile_Configuration *config)
char *	SOPC_CircularLogFile_GetFileName (const SOPC_CircularLogFile *pFile)
	Get the name of the current log file.
void	SOPC_CircularLogFile_PutLine (SOPC_CircularLogFile *pFile, const char *line)
void	SOPC_CircularLogFile_Delete (SOPC_CircularLogFile **ppFile)

Typedef Documentation

SOPC_CircularLogFile

typedef struct SOPC_CircularLogFile SOPC_CircularLogFile

SOPC_CircularLogFile_Configuration

typedef struct SOPC_CircularLogFile_Configuration SOPC_CircularLogFile_Configuration

structure containing the file system log configuration

Function Documentation

SOPC_CircularLogFile_Create()

SOPC_CircularLogFile * SOPC_CircularLogFile_Create

(

const SOPC_CircularLogFile_Configuration *

config

)

Create a circular output text file.

Parameters

config

The files configuration

Returns

A new allocated object, that must be freed by caller using SOPC_CircularLogFile_Delete after use

SOPC_CircularLogFile_GetFileName()

char * SOPC_CircularLogFile_GetFileName

(

const SOPC_CircularLogFile *

pFile

)

Get the name of the current log file.

Parameters

pFile

An existing circular file

Returns

Name of current output log file or NULL if not applicable. The returned value must be deallocated by the caller.

SOPC_CircularLogFile_PutLine()

void SOPC_CircularLogFile_PutLine	(	SOPC_CircularLogFile *	pFile,
		const char *	line )

Writes a line in the circular files, and if the limit size is reached:

• close current file
• creates and prepare next file

  Parameters

  pFile	The circular file to write into
  line	The line to write in files.

SOPC_CircularLogFile_Delete()

void SOPC_CircularLogFile_Delete

(

SOPC_CircularLogFile **

ppFile

)

Clears a circular log file object, previously created by SOPC_CircularLogFile_Create

Parameters

ppFile

The file to clear