Rialto  0.1
Rialto media pipeline API
Public Member Functions | List of all members
firebolt::rialto::IClientLogControl Class Referenceabstract

The definition of the IClientLogControl interface. More...

#include <IClientLogControl.h>

Public Member Functions

 IClientLogControl (const IClientLogControl &)=delete
 
IClientLogControloperator= (const IClientLogControl &)=delete
 
 IClientLogControl (IClientLogControl &&)=delete
 
IClientLogControloperator= (IClientLogControl &&)=delete
 
virtual bool registerLogHandler (const std::shared_ptr< IClientLogHandler > &handler, bool ignoreLogLevels)=0
 Register a new log handler. More...
 

Detailed Description

The definition of the IClientLogControl interface.

This interface defines the public API for controlling Rialto client's log handling. This class is a singleton

Member Function Documentation

◆ registerLogHandler()

virtual bool firebolt::rialto::IClientLogControl::registerLogHandler ( const std::shared_ptr< IClientLogHandler > &  handler,
bool  ignoreLogLevels 
)
pure virtual

Register a new log handler.

Parameters
[in]handler: The user can pass in an object that will henceforth receive callbacks to it's log(...) method for rialto client log events. Please see IClientLogHandler for the parameters that log() must accept. To cancel callbacks then call this method again but pass a nullptr for the handler.
[in]ignoreLogLevels: If true then the handler will receive ALL log level messages regardless of the currently configured log level
Return values
trueif successful

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