QXmpp  Version:1.3.0
Public Types | Public Slots | Signals | Public Member Functions | Static Public Member Functions | Properties | List of all members
QXmppLogger Class Reference

The QXmppLogger class represents a sink for logging messages. More...

#include <QXmppLogger.h>

Inherits QObject.

Public Types

enum  LoggingType { NoLogging = 0, FileLogging = 1, StdoutLogging = 2, SignalLogging = 4 }
 This enum describes how log message are handled. More...
 
enum  MessageType {
  NoMessage = 0, DebugMessage = 1, InformationMessage = 2, WarningMessage = 4,
  ReceivedMessage = 8, SentMessage = 16, AnyMessage = 31
}
 This enum describes a type of log message. More...
 

Public Slots

virtual void setGauge (const QString &gauge, double value)
 
virtual void updateCounter (const QString &counter, qint64 amount)
 
void log (QXmppLogger::MessageType type, const QString &text)
 
void reopen ()
 

Signals

void message (QXmppLogger::MessageType type, const QString &text)
 This signal is emitted whenever a log message is received.
 

Public Member Functions

 QXmppLogger (QObject *parent=nullptr)
 
QXmppLogger::LoggingType loggingType ()
 Returns the handler for logging messages.
 
void setLoggingType (QXmppLogger::LoggingType type)
 
QString logFilePath ()
 
void setLogFilePath (const QString &path)
 
QXmppLogger::MessageTypes messageTypes ()
 Returns the types of messages to log.
 
void setMessageTypes (QXmppLogger::MessageTypes types)
 

Static Public Member Functions

static QXmppLoggergetLogger ()
 

Properties

QString logFilePath
 The path to which logging messages should be written.
 
LoggingType loggingType
 The handler for logging messages.
 
MessageTypes messageTypes
 The types of messages to log.
 

Detailed Description

The QXmppLogger class represents a sink for logging messages.

Member Enumeration Documentation

◆ LoggingType

This enum describes how log message are handled.

Enumerator
NoLogging 

Log messages are discarded.

FileLogging 

Log messages are written to a file.

StdoutLogging 

Log messages are written to the standard output.

SignalLogging 

Log messages are emitted as a signal.

◆ MessageType

This enum describes a type of log message.

Enumerator
NoMessage 

No message type.

DebugMessage 

Debugging message.

InformationMessage 

Informational message.

WarningMessage 

Warning message.

ReceivedMessage 

Message received from server.

SentMessage 

Message sent to server.

AnyMessage 

Any message type.

Constructor & Destructor Documentation

◆ QXmppLogger()

QXmppLogger::QXmppLogger ( QObject *  parent = nullptr)

Constructs a new QXmppLogger.

Parameters
parent

Member Function Documentation

◆ getLogger()

QXmppLogger * QXmppLogger::getLogger ( )
static

Returns the default logger.

◆ log

void QXmppLogger::log ( QXmppLogger::MessageType  type,
const QString &  text 
)
slot

Add a logging message.

Parameters
type
text

◆ logFilePath()

QString QXmppLogger::logFilePath ( )

Returns the path to which logging messages should be written.

See also
loggingType()

◆ reopen

void QXmppLogger::reopen ( )
slot

If logging to a file, causes the file to be re-opened.

◆ setGauge

void QXmppLogger::setGauge ( const QString &  gauge,
double  value 
)
virtualslot

Sets the given gauge to value.

NOTE: the base implementation does nothing.

◆ setLogFilePath()

void QXmppLogger::setLogFilePath ( const QString &  path)

Sets the path to which logging messages should be written.

Parameters
path
See also
setLoggingType()

◆ setLoggingType()

void QXmppLogger::setLoggingType ( QXmppLogger::LoggingType  type)

Sets the handler for logging messages.

Parameters
type

◆ setMessageTypes()

void QXmppLogger::setMessageTypes ( QXmppLogger::MessageTypes  types)

Sets the types of messages to log.

Parameters
types

◆ updateCounter

void QXmppLogger::updateCounter ( const QString &  counter,
qint64  amount 
)
virtualslot

Updates the given counter by amount.

NOTE: the base implementation does nothing.


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