msgLog.h

Go to the documentation of this file.

/* msgLog.h - header file for msgLogLib */

/* 
 * Tim Nicholls, Real Time Systems Group
 * CLRC Rutherford Appleton Laboratory
 */ 

/*
 * Current CVS Tag:
 * $Header: /cvs/minoscvs/rep1/minossoft/OnlineUtil/msgLogLib/msgLog.h,v 1.2 2005/09/06 19:06:49 rhatcher Exp $
 */

/* 
 * Modification History : DO NOT EDIT - MAINTAINED BY CVS 
 * $Log: msgLog.h,v $
 * Revision 1.2  2005/09/06 19:06:49  rhatcher
 * Synch with online CVS repository as of 2005-08-25.  This includes fixes
 * for const correctness on char* format strings.  Alas, it now uses
 * clock_gettime() rather than gettimeofday() -- this exists on Linux,
 * but doesn't for MacOSX, but does require linkage to -lrt library.
 *
 * Revision 1.9  2005/08/25 17:37:24  howcroft
 * Added a function that allows a process to set its own max message repeat rate
 *
 * Revision 1.8  2005/08/25 17:20:43  howcroft
 * VxWorks and Linux now share code for time based message rate limiting. replaced the linux calls to gettimeofday with clock_getttime.
 *
 * Also, change char pointers to const pointers for format args.
 *
 * Revision 1.7  2005/05/03 10:12:39  tcn
 * Added function msgLogPidSet
 *
 * Revision 1.6  2003/10/24 13:34:53  howcroft
 * Bug fix, typo
 *
 * Revision 1.5  2003/10/24 13:30:22  howcroft
 *
 * MsgLogLib:
 * o Messages go via UDP to runControl directly rather than via syslog.
 * o Include a header with infomation about node Id, and message counter, we can now tell when messages are dropped.
 *
 * o msgLogger.c builds a little binary to act like the logger script.
 * o msgRead, a library to extract the messages from the UDP socket and fill a common struct defined in msgCommon.h
 *
 * Revision 1.4  2002/03/01 11:19:01  tcn
 * Implemented new debug message scheme with specifiable debug level and
 * and reporting threshold.
 *
 * Revision 1.3  2001/08/16 12:13:57  tcn
 * Added protos for msgLogInit and logNotice
 *
 * Revision 1.2  2001/06/18 10:53:05  tcn
 * Implemented multi-level message logging.
 *
 * Revision 1.1  2001/04/05 13:35:19  tcn
 * First commit of msgogLib
 *
 *
 */ 

#ifndef _MSG_LOG_LIB_H
#define _MSG_LOG_LIB_H
#ifdef __cplusplus 
extern "C" { 
#endif /* __cplusplus */

/* includes */

/* defines */

/* VxWorks doesn't have syslog so define the levels for the proxy */
#ifdef VxWorks
#define LOG_EMERG       0
#define LOG_ALERT       1
#define LOG_CRIT        2
#define LOG_ERR         3
#define LOG_WARNING     4
#define LOG_NOTICE      5
#define LOG_INFO        6
#define LOG_DEBUG       7
#endif
/* typedefs */

/* global variable declarations*/   

/* function prototype declarations */

void msgLogInit(const char *ident);
void msgLogCleanup(void);
void msgLogNodeIdSet(long nodeid);
void msgLogPidSet(long pid);
void msgLogLocalEchoSet(int enable);
void msgLogResetMsgCount(long count);
long msgLogGetMsgCount();
void logDebugLevelSet(unsigned int level);
void logMaxRepRateSet(long max_dt_ns);
void logCritical(const char *fmt, ...);
void logError(const char *fmt, ...);
void logWarn(const char *fmt, ...);
void logNotice(const char *fmt, ...);
void logInfo(const char *fmt, ...);
void logDebug(unsigned int level, const char *fmt, ...);

#ifdef __cplusplus 
} 
#endif /* __cplusplus */ 

#endif /* _MSG_LOG_LIB_H */

---