AlexaClientSDK  1.26.0
A cross-platform, modular SDK for interacting with the Alexa Voice Service
Namespaces | Macros
Logging.h File Reference
#include <AVSCommon/Utils/Logger/Logger.h>
Include dependency graph for Logging.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Namespaces

 alexaClientSDK
 Whether or not curl logs should be emitted.
 
 alexaClientSDK::avsCommon
 
 alexaClientSDK::avsCommon::utils
 
 alexaClientSDK::avsCommon::utils::logger
 
 alexaClientSDK::acsdkProperties
 Properties Implementation.
 

Macros

#define LX(event)   ::alexaClientSDK::avsCommon::utils::logger::LogEntry(TAG, event)
 Create a LogEntry. More...
 
#define LX_CFG(event, configUri)   LX(event).d(::alexaClientSDK::acsdkProperties::CONFIG_URI, configUri)
 Create a LogEntry for configuration event. More...
 
#define LX_CFG_KEY(event, configUri, key)   LX_CFG(event, configUri).d(::alexaClientSDK::acsdkProperties::KEY, key)
 Create a LogEntry for configuration event. More...
 
#define ACSDK_UNUSED_VARIABLE(var)   (void)var
 Macro to help compiler happy when variable is unused. More...
 

Macro Definition Documentation

◆ ACSDK_UNUSED_VARIABLE

#define ACSDK_UNUSED_VARIABLE (   var)    (void)var

Macro to help compiler happy when variable is unused.

When variables are passed for logging events, compiler complains when logging is disabled (as variables become unused. This macro marks variable as used to suppress build errors.

Parameters
[in]varVariable name.

◆ LX

#define LX (   event)    ::alexaClientSDK::avsCommon::utils::logger::LogEntry(TAG, event)

Create a LogEntry.

Create a LogEntry using TAG constant and the specified event string.

Parameters
[in]eventThe event string for this LogEntry.

◆ LX_CFG

#define LX_CFG (   event,
  configUri 
)    LX(event).d(::alexaClientSDK::acsdkProperties::CONFIG_URI, configUri)

Create a LogEntry for configuration event.

Parameters
[in]eventThe event string for this LogEntry.
[in]configUriConfiguration URI.

◆ LX_CFG_KEY

#define LX_CFG_KEY (   event,
  configUri,
  key 
)    LX_CFG(event, configUri).d(::alexaClientSDK::acsdkProperties::KEY, key)

Create a LogEntry for configuration event.

Parameters
[in]eventThe event string for this LogEntry.
[in]configUriConfiguration URI.
[in]keyKey name.

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