IArchLog Class Reference

Interface for architecture dependent logging. More...

#include <IArchLog.h>

Inherits IInterface.

Inherited by CArch, CArchLogUnix, and CArchLogWindows.

Collaboration diagram for IArchLog:
Collaboration graph
[legend]

List of all members.

Public Types

enum  ELevel {
  kERROR, kWARNING, kNOTE, kINFO,
  kDEBUG
}
 

Log levels.

More...

Public Member Functions

manipulators



virtual void openLog (const char *name)=0
 Open the log.
virtual void closeLog ()=0
virtual void showLog (bool showIfEmpty)=0
 Show the log.
virtual void writeLog (ELevel, const char *)=0
 Write to the log.

Detailed Description

Interface for architecture dependent logging.

This interface defines the logging operations required by synergy. Each architecture must implement this interface.

Definition at line 25 of file IArchLog.h.


Member Enumeration Documentation

Log levels.

The logging priority levels in order of highest to lowest priority.

Enumerator:
kERROR 

For serious or fatal errors.

kWARNING 

For minor errors and warnings.

kNOTE 

For messages about notable events.

kINFO 

For informational messages.

kDEBUG 

For debugging messages.

Definition at line 31 of file IArchLog.h.


Member Function Documentation

virtual void IArchLog::closeLog (  )  [pure virtual]

Close the log.

Implemented in CArch, CArchLogUnix, and CArchLogWindows.

Referenced by CArch::closeLog().

virtual void IArchLog::openLog ( const char *  name  )  [pure virtual]

Open the log.

Opens the log for writing. The log must be opened before being written to.

Implemented in CArch, CArchLogUnix, and CArchLogWindows.

Referenced by CArch::openLog().

virtual void IArchLog::showLog ( bool  showIfEmpty  )  [pure virtual]

Show the log.

Causes the log to become visible. This generally only makes sense for a log in a graphical user interface. Other implementations will do nothing. Iff showIfEmpty is false then the implementation may optionally only show the log if it's not empty.

Implemented in CArch, CArchLogUnix, and CArchLogWindows.

Referenced by CArch::showLog().

virtual void IArchLog::writeLog ( ELevel  ,
const char *   
) [pure virtual]

Write to the log.

Writes the given string to the log with the given level.

Implemented in CArch, CArchLogUnix, and CArchLogWindows.

Referenced by CArch::writeLog().


The documentation for this class was generated from the following file:

Generated on 12 Nov 2010 for synergy-plus by  doxygen 1.6.1