ILogger_interface.h File Reference

Interface for ILogger wrapper. More...

Go to the source code of this file.

Functions
ILogger	ILogger_Create (PtrOnReceivedMessageFn ptrOnReceivedMessageFn, idrs_exception *pargException)
	Creates a new ILogger object.
void	ILogger_Destroy (ILogger argILogger, idrs_exception *pargException)
	Destroys a ILogger handle.
void	ILogger_OnReceivedMessage (ILogger argILogger, enum SeverityLevel const evSeverityLevel, const idrs_string strMessage, idrs_exception *pargException)
	OnReceivedMessage is a method which will be called on reception of meaningful events to provide information about the status and the type of the event. Function will provide information only to events that occur with a severity level equal or higher than the critical severity level provided by user.

Detailed Description

Interface for ILogger wrapper.

Function Documentation

ILogger_Create()

ILogger ILogger_Create	(	PtrOnReceivedMessageFn	ptrOnReceivedMessageFn,
		idrs_exception *	pargException
	)

Creates a new ILogger object.

Parameters

ptrOnReceivedMessageFn	OnReceivedMessage function pointer
pargException	Pointer to exception structure that will be filled if an exception occurs

Returns

The newly created ILogger

ILogger_Destroy()

void ILogger_Destroy	(	ILogger	argILogger,
		idrs_exception *	pargException
	)

Destroys a ILogger handle.

Parameters

argILogger	ILogger handle to destroy
pargException	Pointer to exception structure that will be filled if an exception occurs

ILogger_OnReceivedMessage()

void ILogger_OnReceivedMessage	(	ILogger	argILogger,
		enum SeverityLevel const	evSeverityLevel,
		const idrs_string	strMessage,
		idrs_exception *	pargException
	)

OnReceivedMessage is a method which will be called on reception of meaningful events to provide information about the status and the type of the event. Function will provide information only to events that occur with a severity level equal or higher than the critical severity level provided by user.

Parameters

argILogger	ILogger handle
evSeverityLevel	The severity level of the events that will be logged
strMessage	A message providing more information about the occurred event
pargException	Pointer to exception structure that will be filled if an exception occurs