Tracing and Logging
[System Utilities]

Collaboration diagram for Tracing and Logging:

Files
file	psLogMsg.h
	Procedures for logging messages.
file	psLogMsg.h
	Procedures for logging messages.
file	psTrace.h
	basic run-time trace facilities
Data Structures
struct	p_psComponent
	Basic structure for the component tree. More...
Defines
#define	PS_TRACE_ON   1
	Functions *************************************************************.
Typedefs
typedef p_psComponent	p_psComponent
	Basic structure for the component tree.
Enumerations
enum	{ PS_LOG_ABORT = 0, PS_LOG_ERROR, PS_LOG_WARN, PS_LOG_INFO }
	< Status codes for log messages More...
enum	{ PS_LOG_NONE, PS_LOG_TO_STDERR, PS_LOG_TO_STDOUT }
Functions
psBool	psLogSetDestination (const char *dest)
	This procedure sets the destination for future log messages.
psS32	psLogSetLevel (psS32 level)
	This procedure sets the message level for future log messages.
void	psLogSetFormat (const char *fmt)
	This procedure sets the log format for future log messages.
void	psLogMsg (const char *name, psS32 myLevel, const char *fmt,...)
	This procedure logs a message to the destination set by a prior call to psLogSetDestination(), if myLevel is less than the level specified by a prior call to psLogSetLevel().
void	psLogMsgV (const char *name, psS32 myLevel, const char *fmt, va_list ap)
	This procedure is functionally equivalent to psLogMsg(), except that it takes a va_list as the message parameter, not a printf-style string.
void	psTrace (const char *facil, psS32 myLevel,...)
psBool	psTraceSetLevel (const char *facil, psS32 level)
	Set trace level.
psS32	psTraceGetLevel (const char *facil)
	Get the trace level.
void	psTraceReset ()
	Set all trace levels to zero (do not free nodes in the component tree).
void	psTracePrintLevels (void)
	print trace levels
void	psTraceSetDestination (FILE *fp)
	Set the destination of future trace messages.
FILE *	psTraceGetDestination (void)
	Get the current destination for trace messages.

---

Define Documentation

#define PS_TRACE_ON   1

Functions *************************************************************. Definition at line 45 of file psTrace.h.

---

Typedef Documentation

typedef struct p_psComponent p_psComponent

Basic structure for the component tree. A component is a string of the form aaa.bbb.ccc, and may itself contain further subcomponents. The Component structure doesn't in fact contain it's full name, but only the last part.

---

Enumeration Type Documentation

anonymous enum

< Status codes for log messages Enumeration values: PS_LOG_ABORT  log message is a critical error, perform an abort after printing PS_LOG_ERROR  log message is an error, but don't abort PS_LOG_WARN  log message is a warning PS_LOG_INFO  log message is informational only Definition at line 88 of file psLogMsg.h.

anonymous enum

Enumeration values: PS_LOG_NONE  turn off logging PS_LOG_TO_STDERR  log to system's stderr PS_LOG_TO_STDOUT  log to system's stdout Definition at line 96 of file psLogMsg.h.

---

Function Documentation

void psLogMsg (  const char *  name, psS32  myLevel, const char *  fmt,   ... )

This procedure logs a message to the destination set by a prior call to psLogSetDestination(), if myLevel is less than the level specified by a prior call to psLogSetLevel(). The message is specified with a printf-type string and arguments. Parameters: name  name of the log source myLevel  severity level of this log message fmt  printf-style format command

void psLogMsgV (  const char *  name, psS32  myLevel, const char *  fmt, va_list  ap )

This procedure is functionally equivalent to psLogMsg(), except that it takes a va_list as the message parameter, not a printf-style string. Parameters: name  name of the log source myLevel  severity level of this log message fmt  printf-style format command ap  varargs argument list

psBool psLogSetDestination (  const char *  dest  )

This procedure sets the destination for future log messages. This procedure will take a character string as an argument which can specify general log destinations. Returns: psS32 true if set successfully, otherwise false. Parameters: dest  Specifies where to send messages.

void psLogSetFormat (  const char *  fmt  )

This procedure sets the log format for future log messages. The argument must be a character string consistsing of the letters H (host), L (level), M (message), N (name), and T (time). The default is "THLNM". Deleting a letter from the string will cause the associated information to not be logged. This procedure does not alter the order in which the messages are displayed. Parameters: fmt  Specifies the system log format

psS32 psLogSetLevel (  psS32  level  )

This procedure sets the message level for future log messages. Subsequent log messages, with a log level of "mylevel", will only be logged if "mylevel" is less than the current log level set by this procedure. Ie. higher values set by this procedure will cause more log messages to be displayed. The old log level will be returned. Returns: psS32 old logging level Parameters: level  Specifies the system log level

void psTrace (  const char *  facil, psS32  myLevel,   ... )

Parameters: facil  facilty of interest myLevel  desired trace level

FILE* psTraceGetDestination (  void   )

Get the current destination for trace messages.

psS32 psTraceGetLevel (  const char *  facil  )

Get the trace level. Parameters: facil  facilty of interest

void psTracePrintLevels (  void   )

print trace levels

void psTraceReset (   )

Set all trace levels to zero (do not free nodes in the component tree).

void psTraceSetDestination (  FILE *  fp  )

Set the destination of future trace messages.

psBool psTraceSetLevel (  const char *  facil, psS32  level )

Set trace level. Parameters: facil  facilty of interest level  desired trace level

---