OsSysLogTask Class Reference

#include <OsSysLogTask.h>

Inheritance diagram for OsSysLogTask:

Collaboration diagram for OsSysLogTask:

Public Member Functions
	OsSysLogTask (const int maxInMemoryLogEntries=0, const int options=OsSysLog::OPT_NONE)
virtual	~OsSysLogTask ()
virtual UtlBoolean	handleMessage (OsMsg &eventMessage)
OsStatus	clear ()
OsStatus	flush (const OsTime &rTimeout=OsTime::OS_INFINITY)
OsTimer *	getTimer ()
OsStatus	getMaxEntries (int &maxEntries)
OsStatus	getLogEntries (const int maxEntries, char *entries[], int &actualEntries)
	param maxEntries - The maximum number of in-memory log entries More...
Public Member Functions inherited from OsServerTask
	OsServerTask (const UtlString &name="", void *pArg=NULL, const int maxRequestQMsgs=DEF_MAX_MSGS, const int priority=DEF_PRIO, const int options=DEF_OPTIONS, const int stackSize=DEF_STACKSIZE)
	Main constructor for OsServerTask. More...
virtual	~OsServerTask ()
virtual OsStatus	postMessage (const OsMsg &rMsg, const OsTime &rTimeout=OsTime::OS_INFINITY, UtlBoolean sentFromISR=FALSE)
virtual void	requestShutdown (void)
OsMsgQ *	getMessageQueue ()

Protected Member Functions
OsStatus	processAdd (char *pEntry)
OsStatus	processAddTail (char *pEntry)
OsStatus	processConsoleEnable (const UtlBoolean enable)
OsStatus	processHeadCommand (const int iEntries)
OsStatus	processTailCommand (const int iEntries)
OsStatus	processSetFile (const char *szFile)
OsStatus	processAddSocket (const char *remoteHost)
OsStatus	processSetFlushPeriod (const int iPeriod)
OsStatus	processFlushLog (OsEvent *pEvent)
OsStatus	processSetCallback (OsSysLogCallback pCallback)
Protected Member Functions inherited from OsServerTask
virtual OsStatus	receiveMessage (OsMsg *&rpMsg)
virtual OsStatus	receiveMessage (OsMsg *&rpMsg, const OsTime &rTimeout)
virtual int	run (void *pArg)

Protected Attributes
UtlBoolean	mConsoleEnabled
	param: maxEntries - The maximum number of entries to fetch. param: entries - Array of char* large enough to accommodate More...
char **	mpRingBuffer
int	mLogCount
int	mRingBufferLength
int	mRingBufferNext
FILE *	mpUnboundedLog
UtlString	mUnboundedLogFile
UtlString	mBoundedLogFile
int	mFlushPeriod
UtlBoolean	mLogChanged
OsTimer *	mpTimer
OsSocket *	mpSockets [MAX_SOCKET_TARGETS]
OsSysLogCallback	mpCallback
OsRWMutex	mRWMutex
OsTime	mpLastReopen
int	mOptions
Protected Attributes inherited from OsServerTask
OsMsgQ	mIncomingQ

Additional Inherited Members
Static Public Attributes inherited from OsServerTask
static const int	DEF_MAX_MSGS = OsMsgQ::DEF_MAX_MSGS

Constructor & Destructor Documentation

OsSysLogTask	(	const int	maxInMemoryLogEntries = 0,
		const int	options = OsSysLog::OPT_NONE
	)

~OsSysLogTask ( )

virtual

Member Function Documentation

UtlBoolean handleMessage ( OsMsg &  eventMessage )

virtual

Implements OsServerTask.

OsStatus clear

(

)

OsStatus flush

(

const OsTime &

rTimeout = OsTime::OS_INFINITY

)

OsTimer* getTimer ( )

inline

OsStatus getMaxEntries

(

int &

maxEntries

)

OsStatus getLogEntries	(	const int	maxEntries,
		char *	entries[],
		int &	actualEntries
	)

param maxEntries - The maximum number of in-memory log entries

OsStatus processAdd ( char *  pEntry )

protected

OsStatus processAddTail ( char *  pEntry )

protected

OsStatus processConsoleEnable ( const UtlBoolean  enable )

protected

OsStatus processHeadCommand ( const int  iEntries )

protected

OsStatus processTailCommand ( const int  iEntries )

protected

OsStatus processSetFile ( const char *  szFile )

protected

OsStatus processAddSocket ( const char *  remoteHost )

protected

OsStatus processSetFlushPeriod ( const int  iPeriod )

protected

OsStatus processFlushLog ( OsEvent *  pEvent )

protected

OsStatus processSetCallback ( OsSysLogCallback  pCallback )

protected

Member Data Documentation

UtlBoolean mConsoleEnabled

protected

param: maxEntries - The maximum number of entries to fetch. param: entries - Array of char* large enough to accommodate

param: actualEntries - The actual number of entries returned. This

char** mpRingBuffer

protected

int mLogCount

protected

int mRingBufferLength

protected

int mRingBufferNext

protected

FILE* mpUnboundedLog

protected

UtlString mUnboundedLogFile

protected

UtlString mBoundedLogFile

protected

int mFlushPeriod

protected

UtlBoolean mLogChanged

protected

OsTimer* mpTimer

protected

OsSocket* mpSockets[MAX_SOCKET_TARGETS]

protected

OsSysLogCallback mpCallback

protected

OsRWMutex mRWMutex

protected

OsTime mpLastReopen

protected

int mOptions

protected