Log

Description détaillée

Graphe de collaboration de Log:

Fonctions
static int	iLogMask (void)
	Lecture du masque des priorités en cours. Plus de détails...
static FILE *	pxLogFile (void)
	Fichier de log courant. Plus de détails...
const char *	sLogPriorityString (int priority)
	Chaîne de caractère correspondant à la priorité Plus de détails...
void	vLog (int priority, const char *format,...)
	Affichage ou écriture d'un message de log. Plus de détails...
void	vLog_P (int priority, const char *format,...)
	Affichage ou écriture d'un message de log, version FLASH. Plus de détails...
static void	vLogSetFile (FILE *f)
	Modifie le fichier de log. Plus de détails...
static void	vLogSetMask (int mask)
	Fixe le masque des priorités. Plus de détails...

Macros
#define	LOG_ALERT   3
#define	LOG_CRIT   3
#define	LOG_DEBUG   7
#define	LOG_EMERG   3
#define	LOG_ERR   3
#define	LOG_INFO   6
#define	LOG_MASK(p)
	Masque de validation du bit correspondant à la priorité p.
#define	LOG_NOTICE   5
#define	LOG_UPTO(p)
	Masque de validation de toutes les priorités jusqu'à p incluses.
#define	LOG_WARNING   4
#define	PDEBUG(fmt, ...)
	Affiche ou écrit un message de log niveau LOG_DEBUG. Plus de détails...
#define	PERROR(fmt, ...)
	Affiche ou écrit un message de log niveau LOG_ERROR. Plus de détails...
#define	PINFO(fmt, ...)
	Affiche ou écrit un message de log niveau LOG_INFO. Plus de détails...
#define	PNOTICE(fmt, ...)
	Affiche ou écrit un message de log niveau LOG_NOTICE. Plus de détails...
#define	PWARNING(fmt, ...)
	Affiche ou écrit un message de log niveau LOG_WARNING. Plus de détails...

Documentation des macros

#define LOG_ALERT   3

action must be taken immediately

Définition à la ligne 33 du fichier log.h.

#define LOG_CRIT   3

critical conditions

Définition à la ligne 34 du fichier log.h.

#define LOG_DEBUG   7

debug-level messages

Définition à la ligne 39 du fichier log.h.

#define LOG_EMERG   3

system is unusable

Définition à la ligne 32 du fichier log.h.

#define LOG_ERR   3

error conditions

Définition à la ligne 35 du fichier log.h.

#define LOG_INFO   6

informational

Définition à la ligne 38 du fichier log.h.

#define LOG_NOTICE   5

normal but significant condition

Définition à la ligne 37 du fichier log.h.

#define LOG_WARNING   4

warning conditions

Définition à la ligne 36 du fichier log.h.

#define PDEBUG	(		fmt,
			...
	)

Affiche ou écrit un message de log niveau LOG_DEBUG.

Cette macro est inactivée si la constante DEBUG n'est pas définie à la compilation ou si la constante NLOG est définie à la compilation.

Paramètres

fmt	chaîne de format conforme à la syntaxe de la fonction printf() suivie des paramètres optionnels. Il s'agit d'une chaîne statique qui sera stockée en FLASH (pour utiliser un format déjà stocké en RAM utiliser vLog(), pour utiliser un format déjà stocké en FLASH utiliser vLog_P())

Exemples:

net/onewire/ds2438/demo_ow_ds2438.c, et net/onewire/scan/demo_ow_scan.c.

Définition à la ligne 69 du fichier log.h.

#define PERROR	(		fmt,
			...
	)

Affiche ou écrit un message de log niveau LOG_ERROR.

Cette macro est inactivée si la constante NLOG est définie à la compilation.

Paramètres

fmt	chaîne de format conforme à la syntaxe de la fonction printf() suivie des paramètres optionnels. Il s'agit d'une chaîne statique qui sera stockée en FLASH (pour utiliser un format déjà stocké en RAM utiliser vLog(), pour utiliser un format déjà stocké en FLASH utiliser vLog_P())

Définition à la ligne 117 du fichier log.h.

#define PINFO	(		fmt,
			...
	)

Affiche ou écrit un message de log niveau LOG_INFO.

Cette macro est inactivée si la constante NLOG est définie à la compilation.

Paramètres

fmt	chaîne de format conforme à la syntaxe de la fonction printf() suivie des paramètres optionnels. Il s'agit d'une chaîne statique qui sera stockée en FLASH (pour utiliser un format déjà stocké en RAM utiliser vLog(), pour utiliser un format déjà stocké en FLASH utiliser vLog_P())

Définition à la ligne 81 du fichier log.h.

#define PNOTICE	(		fmt,
			...
	)

Affiche ou écrit un message de log niveau LOG_NOTICE.

Cette macro est inactivée si la constante NLOG est définie à la compilation.

Paramètres

fmt	chaîne de format conforme à la syntaxe de la fonction printf() suivie des paramètres optionnels. Il s'agit d'une chaîne statique qui sera stockée en FLASH (pour utiliser un format déjà stocké en RAM utiliser vLog(), pour utiliser un format déjà stocké en FLASH utiliser vLog_P())

Définition à la ligne 93 du fichier log.h.

#define PWARNING	(		fmt,
			...
	)

Affiche ou écrit un message de log niveau LOG_WARNING.

Cette macro est inactivée si la constante NLOG est définie à la compilation.

Paramètres

fmt	chaîne de format conforme à la syntaxe de la fonction printf() suivie des paramètres optionnels. Il s'agit d'une chaîne statique qui sera stockée en FLASH (pour utiliser un format déjà stocké en RAM utiliser vLog(), pour utiliser un format déjà stocké en FLASH utiliser vLog_P())

Définition à la ligne 105 du fichier log.h.

Documentation des fonctions

static int iLogMask ( void  )

inlinestatic

Lecture du masque des priorités en cours.

Cette fonction est inactivée si la constante NLOG est définie à la compilation.

Renvoie

la valeur du masque

static FILE* pxLogFile ( void  )

inlinestatic

Fichier de log courant.

Cette fonction est inactivée si la constante NLOG est définie à la compilation.

Renvoie

pointeur sur le fichier, stderr par défaut

const char* sLogPriorityString

(

int

priority

)

Chaîne de caractère correspondant à la priorité

Paramètres

priority

priorité

Renvoie

chaîne constante en RAM

void vLog	(	int	priority,
		const char *	format,
			...
	)

Affichage ou écriture d'un message de log.

Le message est écrit dans le fichier de log scpécifié par pxLogFile(), par défaut stderr.

Cette fonction est inactivée si la constante NLOG est définie à la compilation.

Paramètres

priority	priorité du message
format	chaîne de format conforme à la syntaxe de la fonction printf() suivie des paramètres optionnels.

void vLog_P	(	int	priority,
		const char *	format,
			...
	)

Affichage ou écriture d'un message de log, version FLASH.

Le message est écrit dans le fichier de log scpécifié par pxLogFile(), par défaut stderr.

Cette fonction est inactivée si la constante NLOG est définie à la compilation.

Paramètres

priority	priorité
format	chaîne de format conforme à la syntaxe de la fonction printf() suivie des paramètres optionnels. La chaîne réside en FLASH

static void vLogSetFile ( FILE *  f )

inlinestatic

Modifie le fichier de log.

Cette fonction est inactivée si la constante NLOG est définie à la compilation.

Paramètres

f	pointeur sur le fichier

static void vLogSetMask ( int  mask )

inlinestatic

Fixe le masque des priorités.

Les huit priorités sont LOG_EMERG, LOG_ALERT, LOG_CRIT, LOG_ERR, LOG_WARNING, LOG_NOTICE, LOG_INFO et LOG_DEBUG.
Cette fonction est inactivée si la constante NLOG est définie à la compilation.

Paramètres

mask	le bit correspondant à la priorité p est LOG_MASK(p), LOG_UPTO(p) pour le masque de toutes les priorités jusqu'à p incluses.