Belle II Software development
LogConnectionBase Class Referenceabstract

Abstract base class for the different types of log connections. More...

#include <LogConnectionBase.h>

Inheritance diagram for LogConnectionBase:
LogConnectionConsole LogConnectionFilter LogConnectionJSON LogConnectionTxtFile LogConnectionUDP

Public Member Functions

 LogConnectionBase ()
 The LogConnectionBase default constructor.
 
virtual ~LogConnectionBase ()
 The LogConnectionBase destructor.
 
virtual bool sendMessage (const LogMessage &message)=0
 Sends a log message.
 
virtual bool isConnected ()=0
 Returns true if the connection could be established.
 
virtual void finalizeOnAbort ()
 Called just before the system exists after a fatal error.
 

Detailed Description

Abstract base class for the different types of log connections.

Definition at line 21 of file LogConnectionBase.h.

Constructor & Destructor Documentation

◆ LogConnectionBase()

LogConnectionBase ( )
inline

The LogConnectionBase default constructor.

Definition at line 26 of file LogConnectionBase.h.

26{}

◆ ~LogConnectionBase()

virtual ~LogConnectionBase ( )
inlinevirtual

The LogConnectionBase destructor.

Definition at line 29 of file LogConnectionBase.h.

29{}

Member Function Documentation

◆ finalizeOnAbort()

virtual void finalizeOnAbort ( )
inlinevirtual

Called just before the system exists after a fatal error.

Can be used to flush the output or close the file

Reimplemented in LogConnectionConsole, LogConnectionFilter, LogConnectionJSON, and LogConnectionTxtFile.

Definition at line 48 of file LogConnectionBase.h.

48{}

◆ isConnected()

virtual bool isConnected ( )
pure virtual

Returns true if the connection could be established.

Returns
True if the connection could be established.

Implemented in LogConnectionUDP, LogConnectionConsole, LogConnectionFilter, LogConnectionJSON, and LogConnectionTxtFile.

◆ sendMessage()

virtual bool sendMessage ( const LogMessage message)
pure virtual

Sends a log message.

Parameters
messageThe log message object.
Returns
Returns true if the message could be send.

Implemented in LogConnectionUDP, LogConnectionConsole, LogConnectionFilter, LogConnectionJSON, and LogConnectionTxtFile.


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