QCA::Logger Class Reference
[QCA user API]

A simple logging system. More...

#include <QtCrypto>

Inheritance diagram for QCA::Logger:

QObject
Collaboration diagram for QCA::Logger:

Collaboration graph
[legend]

List of all members.

Public Types

enum  Severity {
  Quiet = 0, Emergency = 1, Alert = 2, Critical = 3,
  Error = 4, Warning = 5, Notice = 6, Information = 7,
  Debug = 8
}

Public Member Functions

QStringList currentLogDevices () const
Severity level () const
void logBinaryMessage (const QByteArray &blob, Severity=Information)
void logTextMessage (const QString &message, Severity=Information)
void registerLogDevice (AbstractLogDevice *logger)
void setLevel (Severity level)
void unregisterLogDevice (const QString &loggerName)

Friends

class Global


Detailed Description

A simple logging system.

This class provides a simple but flexible approach to logging information that may be used for debugging or system operation diagnostics.

There is a single Logger for each application that uses QCA. You do not need to create this Logger yourself - QCA automatically creates it on startup. You can get access to the Logger using the global QCA::logger() method.

By default the Logger just accepts all messages (binary and text). If you want to get access to those messages, you need to subclass AbstractLogDevice, and register your subclass (using registerLogDevice()). You can then take whatever action is appropriate (e.g. show to the user using the GUI, log to a file or send to standard error).


Member Enumeration Documentation

The severity of the message.

This information may be used by the log device to determine what the appropriate action is.

Enumerator:
Quiet  Quiet: turn of logging.
Emergency  Emergency: system is unusable.
Alert  Alert: action must be taken immediately.
Critical  Critical: critical conditions.
Error  Error: error conditions.
Warning  Warning: warning conditions.
Notice  Notice: normal but significant condition.
Information  Informational: informational messages.
Debug  Debug: debug-level messages.


Member Function Documentation

QStringList QCA::Logger::currentLogDevices (  )  const

Get a list of the names of all registered log devices.

Severity QCA::Logger::level (  )  const [inline]

Get the current logging level.

Returns:
Current level

void QCA::Logger::logBinaryMessage ( const QByteArray blob,
Severity  = Information 
)

Log a binary blob to all available log devices.

Parameters:
blob the information to log
Note:
how this is handled is quite logger specific. For example, it might be logged as a binary, or it might be encoded in some way

void QCA::Logger::logTextMessage ( const QString message,
Severity  = Information 
)

Log a message to all available log devices.

Parameters:
message the text to log

void QCA::Logger::registerLogDevice ( AbstractLogDevice logger  ) 

Add an AbstractLogDevice subclass to the existing list of loggers.

Parameters:
logger the LogDevice to add

void QCA::Logger::setLevel ( Severity  level  ) 

Set the current logging level.

Parameters:
level new logging level
Only severities less or equal than the log level one will be logged

void QCA::Logger::unregisterLogDevice ( const QString loggerName  ) 

Remove an AbstractLogDevice subclass from the existing list of loggers.

Parameters:
loggerName the name of the LogDevice to remove
Note:
If there are several log devices with the same name, all will be removed.


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

Generated on Wed Apr 29 15:16:05 2009 for Qt Cryptographic Architecture by  doxygen 1.5.5