audacity::concurrency::CancellationContext Class Reference

#include <CancellationContext.h>

Collaboration diagram for audacity::concurrency::CancellationContext:

Classes
struct	Tag

Public Types
using	CancellableWPtr = std::weak_ptr< ICancellable >

Public Member Functions
	CancellationContext (Tag)
	CancellationContext (const CancellationContext &)=delete
	CancellationContext (CancellationContext &&)=delete
CancellationContext &	operator= (const CancellationContext &)=delete
CancellationContext &	operator= (CancellationContext &&)=delete
void	Cancel ()
void	OnCancelled (CancellableWPtr cancellable)

Static Public Member Functions
static CancellationContextPtr	Create ()

Private Attributes
std::atomic< bool >	mCancelled { false }
std::mutex	mCancellableObjectsMutex
std::vector< CancellableWPtr >	mCancellableObjects

Detailed Description

Definition at line 21 of file CancellationContext.h.

Member Typedef Documentation

CancellableWPtr

using audacity::concurrency::CancellationContext::CancellableWPtr = std::weak_ptr<ICancellable>

Definition at line 39 of file CancellationContext.h.

Constructor & Destructor Documentation

CancellationContext() [1/3]

audacity::concurrency::CancellationContext::CancellationContext ( Tag  )

explicit

Definition at line 15 of file CancellationContext.cpp.

{
}

CancellationContext() [2/3]

audacity::concurrency::CancellationContext::CancellationContext ( const CancellationContext &  )

delete

CancellationContext() [3/3]

audacity::concurrency::CancellationContext::CancellationContext ( CancellationContext &&  )

delete

Member Function Documentation

Cancel()

void audacity::concurrency::CancellationContext::Cancel

(

)

Definition at line 24 of file CancellationContext.cpp.

{
   if (mCancelled.exchange(true))
      return;
 
   std::vector<CancellableWPtr> cancellableObjects;
 
   {
      auto lock = std::lock_guard { mCancellableObjectsMutex };
      std::swap(cancellableObjects, mCancellableObjects);
   }
 
   std::for_each(
      cancellableObjects.begin(), cancellableObjects.end(),
      [](auto& wptr)
      {
         if (auto lock = wptr.lock())
            lock->Cancel();
      });
}

References mCancellableObjects, mCancellableObjectsMutex, mCancelled, and anonymous_namespace{NoteTrack.cpp}::swap().

Here is the call graph for this function:

Create()

std::shared_ptr< CancellationContext > audacity::concurrency::CancellationContext::Create ( )

static

Definition at line 19 of file CancellationContext.cpp.

{
   return std::make_shared<CancellationContext>(Tag {});
}

Referenced by audacity::cloud::audiocom::sync::MissingBlocksUploader::Create(), audacity::cloud::audiocom::sync::ProjectsListDialog::ProjectsTableData::Refresh(), audacity::cloud::audiocom::sync::DataUploader::Upload(), audacity::cloud::audiocom::sync::MixdownUploader::Upload(), and audacity::cloud::audiocom::sync::UploadMixdown().

Here is the caller graph for this function:

OnCancelled()

void audacity::concurrency::CancellationContext::OnCancelled

(

CancellableWPtr

cancellable

)

Definition at line 45 of file CancellationContext.cpp.

{
   auto locked = cancellable.lock();
   if (!locked)
      return;
 
   if (mCancelled.load(std::memory_order_acquire))
   {
      locked->Cancel();
      return;
   }
 
   auto lock = std::lock_guard { mCancellableObjectsMutex };
   mCancellableObjects.erase(
      std::remove_if(
         mCancellableObjects.begin(), mCancellableObjects.end(),
         [](auto& wptr) { return wptr.expired(); }),
      mCancellableObjects.end());
 
   mCancellableObjects.push_back(std::move(cancellable));
}

References mCancellableObjects, mCancellableObjectsMutex, and mCancelled.

operator=() [1/2]

CancellationContext & audacity::concurrency::CancellationContext::operator= ( CancellationContext &&  )

delete

operator=() [2/2]

CancellationContext & audacity::concurrency::CancellationContext::operator= ( const CancellationContext &  )

delete

Member Data Documentation

mCancellableObjects

std::vector<CancellableWPtr> audacity::concurrency::CancellationContext::mCancellableObjects

private

Definition at line 46 of file CancellationContext.h.

Referenced by Cancel(), and OnCancelled().

mCancellableObjectsMutex

std::mutex audacity::concurrency::CancellationContext::mCancellableObjectsMutex

private

Definition at line 45 of file CancellationContext.h.

Referenced by Cancel(), and OnCancelled().

mCancelled

std::atomic<bool> audacity::concurrency::CancellationContext::mCancelled { false }

private

Definition at line 43 of file CancellationContext.h.

Referenced by Cancel(), and OnCancelled().

---

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

• CancellationContext.h
• CancellationContext.cpp