audacity::sentry::anonymous_namespace{SentryReport.cpp}::ExceptionContext Class Reference

Helper class to store additional details about the exception. More...

Collaboration diagram for audacity::sentry::anonymous_namespace{SentryReport.cpp}::ExceptionContext:

Public Member Functions
void	Add (std::string parameterName, AnonymizedMessage parameterValue)
	Adds a new item to the exception context. More...
std::vector< ExceptionData >	MoveParameters ()
	Return the current context and reset it. More...

Static Public Member Functions
static ExceptionContext &	Get ()
	Get an instance of the ExceptionContext. More...

Private Member Functions
	ExceptionContext ()=default

Private Attributes
std::mutex	mDataMutex
std::vector< ExceptionData >	mData

Detailed Description

Helper class to store additional details about the exception.

This small class is a thread safe store for the information we want to add to the exception before the exception occurs. For example, we may log SQLite3 return codes here, as otherwise they wont be available when everything fails

Definition at line 49 of file SentryReport.cpp.

Constructor & Destructor Documentation

ExceptionContext()

audacity::sentry::anonymous_namespace{SentryReport.cpp}::ExceptionContext::ExceptionContext ( )

privatedefault

Member Function Documentation

Add()

void audacity::sentry::anonymous_namespace{SentryReport.cpp}::ExceptionContext::Add ( std::string  parameterName, AnonymizedMessage  parameterValue  )

inline

Adds a new item to the exception context.

Definition at line 53 of file SentryReport.cpp.

   {
      std::lock_guard<std::mutex> lock(mDataMutex);
      mData.emplace_back(std::move(parameterName), std::move(parameterValue));
   }

Get()

static ExceptionContext & audacity::sentry::anonymous_namespace{SentryReport.cpp}::ExceptionContext::Get ( )

inlinestatic

Get an instance of the ExceptionContext.

Definition at line 72 of file SentryReport.cpp.

   {
      static ExceptionContext instance;
      return instance;
   }

MoveParameters()

std::vector< ExceptionData > audacity::sentry::anonymous_namespace{SentryReport.cpp}::ExceptionContext::MoveParameters ( )

inline

Return the current context and reset it.

Definition at line 60 of file SentryReport.cpp.

   {
      std::lock_guard<std::mutex> lock(mDataMutex);
 
      std::vector<ExceptionData> emptyVector;
 
      std::swap(mData, emptyVector);
 
      return emptyVector;
   }

References anonymous_namespace{NoteTrack.cpp}::swap().

Here is the call graph for this function:

Member Data Documentation

mData

std::vector<ExceptionData> audacity::sentry::anonymous_namespace{SentryReport.cpp}::ExceptionContext::mData

private

Definition at line 82 of file SentryReport.cpp.

mDataMutex

std::mutex audacity::sentry::anonymous_namespace{SentryReport.cpp}::ExceptionContext::mDataMutex

private

Definition at line 81 of file SentryReport.cpp.

---

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

• SentryReport.cpp