AlexaClientSDK  3.0.0
A cross-platform, modular SDK for interacting with the Alexa Voice Service
Public Member Functions | Static Public Member Functions | List of all members
alexaClientSDK::avsCommon::utils::logger::LoggerSinkManager Class Reference

#include <LoggerSinkManager.h>

Public Member Functions

void addSinkObserver (SinkObserverInterface *observer)
 
void removeSinkObserver (SinkObserverInterface *observer)
 
void setLevel (Level level)
 
void initialize (const std::shared_ptr< Logger > &sink)
 

Static Public Member Functions

static LoggerSinkManagerinstance ()
 

Detailed Description

A manager to manage the sink logger and notify SinkObservers of any changes.

Member Function Documentation

◆ addSinkObserver()

void alexaClientSDK::avsCommon::utils::logger::LoggerSinkManager::addSinkObserver ( SinkObserverInterface observer)

Add a SinkObserver to the manager.

Parameters
observerThe SinkObserverInterface be be added.

◆ initialize()

void alexaClientSDK::avsCommon::utils::logger::LoggerSinkManager::initialize ( const std::shared_ptr< Logger > &  sink)

Initialize the sink logger managed by the manager. This function can be called only before any other threads in the process have been created by the program.

Parameters
sinkThe new Logger to forward logs to.
Note
If this function is not called, the default sink logger is ConsoleLogger.

◆ instance()

static LoggerSinkManager& alexaClientSDK::avsCommon::utils::logger::LoggerSinkManager::instance ( )
static

Return the one and only LoggerSinkManager instance.

Returns
The one and only LoggerSinkManager instance.

◆ removeSinkObserver()

void alexaClientSDK::avsCommon::utils::logger::LoggerSinkManager::removeSinkObserver ( SinkObserverInterface observer)

Remove a SinkObserver from the manager.

Parameters
observerThe SinkObserverInterface to be removed.

◆ setLevel()

void alexaClientSDK::avsCommon::utils::logger::LoggerSinkManager::setLevel ( Level  level)

Set the minimum level of entries to log.

Parameters
levelThe minimum level of entries to log.

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

AlexaClientSDK 3.0.0 - Copyright 2016-2022 Amazon.com, Inc. or its affiliates. All Rights Reserved. Licensed under the Apache License, Version 2.0