LogConnectionFilter Class Reference

Implements a log connection that filters repeated messages. More...

#include <LogConnectionFilter.h>

Inheritance diagram for LogConnectionFilter:

Collaboration diagram for LogConnectionFilter:

Public Member Functions
	LogConnectionFilter (LogConnectionBase *logConnection)
	The constructor.
virtual	~LogConnectionFilter ()
	The LogConnectionFilter destructor.
bool	sendMessage (const LogMessage &message) override
	Sends a log message.
bool	isConnected () override
	Returns true if the log connection could be established.
void	finalizeOnAbort () override
	Finalize on Abort: make sure last repetition is printed if there is any and that connected connection is also finalized.

Private Member Functions
void	printRepetitions ()
	If there are repeated messages print the number of repetitions.

Private Attributes
std::unique_ptr< LogConnectionBase >	m_logConnection
	The actual log connection.
LogMessage	m_previousMessage
	The previous log message.
int	m_repeatCounter
	Counter for repeated messages.

Detailed Description

Implements a log connection that filters repeated messages.

This connection can be used to prevent printing of the same message again and again. Messages are suppressed if they match with the one previously sent.

Definition at line 28 of file LogConnectionFilter.h.

Constructor & Destructor Documentation

LogConnectionFilter()

LogConnectionFilter ( LogConnectionBase *  logConnection )

explicit

The constructor.

Parameters

logConnection

The log connection that actually prints the messages.

Definition at line 14 of file LogConnectionFilter.cc.

                                                                         :
  m_logConnection(logConnection),
  m_previousMessage(LogConfig::c_Default, "", "", "", "", 0),
  m_repeatCounter(0)
{
}

~LogConnectionFilter()

~LogConnectionFilter ( )

virtual

The LogConnectionFilter destructor.

Definition at line 22 of file LogConnectionFilter.cc.

{
  printRepetitions();
}

Member Function Documentation

finalizeOnAbort()

void finalizeOnAbort ( )

inlineoverridevirtual

Finalize on Abort: make sure last repetition is printed if there is any and that connected connection is also finalized.

Reimplemented from LogConnectionBase.

Definition at line 62 of file LogConnectionFilter.h.

    {
      printRepetitions();
      m_logConnection->finalizeOnAbort();
    }

isConnected()

bool isConnected ( )

overridevirtual

Returns true if the log connection could be established.

Returns

True if the log connection could be established.

Implements LogConnectionBase.

Definition at line 28 of file LogConnectionFilter.cc.

{
  return (m_logConnection && m_logConnection->isConnected());
}

printRepetitions()

void printRepetitions ( )

private

If there are repeated messages print the number of repetitions.

Definition at line 51 of file LogConnectionFilter.cc.

{
  if (m_repeatCounter > 0) {
    const std::string message{" ... message repeated " + std::to_string(m_repeatCounter) + " times"};
    LogMessage repeatMessage(m_previousMessage.getLogLevel(), message, "", "", "", 0);
    repeatMessage.setLogInfo(LogConfig::c_Message);
    m_logConnection->sendMessage(repeatMessage);
  }
  m_repeatCounter = 0;
}

sendMessage()

bool sendMessage ( const LogMessage &  message )

overridevirtual

Sends a log message.

Parameters

message

The log message object.

Returns

Returns true if the message could be send.

Implements LogConnectionBase.

Definition at line 34 of file LogConnectionFilter.cc.

{
 
  if (message == m_previousMessage) {
    m_repeatCounter++;
    // return true anyway since we will print the repeat message later so we
    // consider this successful
    return true;
  }
 
  printRepetitions();
  m_previousMessage = message;
 
  return m_logConnection->sendMessage(message);
}

Member Data Documentation

m_logConnection

std::unique_ptr<LogConnectionBase> m_logConnection

private

The actual log connection.

Definition at line 72 of file LogConnectionFilter.h.

m_previousMessage

LogMessage m_previousMessage

private

The previous log message.

Definition at line 73 of file LogConnectionFilter.h.

m_repeatCounter

int m_repeatCounter

private

Counter for repeated messages.

Definition at line 74 of file LogConnectionFilter.h.

---

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

• framework/logging/include/LogConnectionFilter.h
• framework/logging/src/LogConnectionFilter.cc