RealtimeEffectState::AccessState Class Reference

Mediator of two-way inter-thread communication of changes of settings. More...

Inheritance diagram for RealtimeEffectState::AccessState:

Collaboration diagram for RealtimeEffectState::AccessState:

Classes
struct	CounterAndOutputs
struct	FromMainSlot
struct	ToMainSlot

Public Member Functions
	AccessState (const EffectSettingsManager &effect, RealtimeEffectState &state)
void	Initialize (const EffectSettings &settings, const EffectInstance::Message *pMessage, const EffectOutputs *pOutputs)
void	MainRead ()
void	MainWrite (SettingsAndCounter &&settings, std::unique_ptr< EffectInstance::Message > pMessage)
void	MainWrite (SettingsAndCounter::Counter counter, std::unique_ptr< EffectInstance::Message > pMessage)
void	WorkerRead ()
void	WorkerWrite ()

Public Attributes
const EffectSettingsManager &	mEffect
RealtimeEffectState &	mState
MessageBuffer< FromMainSlot >	mChannelFromMain
Response::Counter	mCounter
SettingsAndCounter	mLastSettings
MessageBuffer< ToMainSlot >	mChannelToMain
std::mutex	mLockForCV
std::condition_variable	mCV
std::thread::id	mMainThreadId

Detailed Description

Mediator of two-way inter-thread communication of changes of settings.

Definition at line 24 of file RealtimeEffectState.cpp.

Constructor & Destructor Documentation

AccessState()

RealtimeEffectState::AccessState::AccessState ( const EffectSettingsManager &  effect, RealtimeEffectState &  state  )

inline

Definition at line 26 of file RealtimeEffectState.cpp.

      : mEffect{ effect }
      , mState{ state }
   {
      // Clean initial state of the counter
      state.mMainSettings.counter = 0;
      Initialize(state.mMainSettings.settings,
         state.mMessage.get(), state.mMovedOutputs.get());
   }

References Initialize(), RealtimeEffectState::mMainSettings, RealtimeEffectState::mMessage, and RealtimeEffectState::mMovedOutputs.

Here is the call graph for this function:

Member Function Documentation

Initialize()

void RealtimeEffectState::AccessState::Initialize ( const EffectSettings &  settings, const EffectInstance::Message *  pMessage, const EffectOutputs *  pOutputs  )

inline

Definition at line 36 of file RealtimeEffectState.cpp.

   {
      mLastSettings = { settings, 0 };
      // Initialize each message buffer with two copies
      mChannelToMain.Write(ToMainSlot{ { 0,
         pOutputs ? pOutputs->Clone() : nullptr } });
      mChannelToMain.Write(ToMainSlot{ { 0,
         pOutputs ? pOutputs->Clone() : nullptr } });
      mChannelFromMain.Write(FromMainSlot{ settings, pMessage });
      mChannelFromMain.Write(FromMainSlot{ settings, pMessage });
 
      mMainThreadId = std::this_thread::get_id();
   }

References EffectOutputs::Clone(), mChannelFromMain, mChannelToMain, mLastSettings, mMainThreadId, and settings().

Referenced by AccessState().

Here is the call graph for this function:

Here is the caller graph for this function:

MainRead()

void RealtimeEffectState::AccessState::MainRead ( )

inline

Definition at line 52 of file RealtimeEffectState.cpp.

                   {
      mChannelToMain.Read<ToMainSlot::Reader>(mState.mMovedOutputs.get(),
         mCounter);
   }

References mChannelToMain, mCounter, RealtimeEffectState::mMovedOutputs, and mState.

MainWrite() [1/2]

void RealtimeEffectState::AccessState::MainWrite ( SettingsAndCounter &&  settings, std::unique_ptr< EffectInstance::Message >  pMessage  )

inline

Definition at line 56 of file RealtimeEffectState.cpp.

                                                     {
      // Main thread may simply swap new content into place
      mChannelFromMain.Write(FromMainSlot::Message{
         std::move(settings.settings), settings.counter, std::move(pMessage) });
   }

References mChannelFromMain, and settings().

Here is the call graph for this function:

MainWrite() [2/2]

void RealtimeEffectState::AccessState::MainWrite ( SettingsAndCounter::Counter  counter, std::unique_ptr< EffectInstance::Message >  pMessage  )

inline

Definition at line 62 of file RealtimeEffectState.cpp.

                                                     {
      mChannelFromMain.Write(FromMainSlot::ShortMessage{
         counter, std::move(pMessage) });
   }

References mChannelFromMain.

WorkerRead()

void RealtimeEffectState::AccessState::WorkerRead ( )

inline

Definition at line 72 of file RealtimeEffectState.cpp.

                     {
      // Worker thread avoids memory allocation.  It copies the contents of any
      mChannelFromMain.Read<FromMainSlot::Reader>(mEffect, mState);
   }

References mChannelFromMain, mEffect, and mState.

WorkerWrite()

void RealtimeEffectState::AccessState::WorkerWrite ( )

inline

Definition at line 76 of file RealtimeEffectState.cpp.

                      {
 
      {
         std::unique_lock lk(mLockForCV);
 
         // Worker thread avoids memory allocation.
         mChannelToMain.Write(CounterAndOutputs{
            mState.mWorkerSettings.counter, mState.mOutputs.get() });
      }
      mCV.notify_one();
   }

References mChannelToMain, mCV, mLockForCV, RealtimeEffectState::mOutputs, mState, and RealtimeEffectState::mWorkerSettings.

Member Data Documentation

mChannelFromMain

MessageBuffer<FromMainSlot> RealtimeEffectState::AccessState::mChannelFromMain

Definition at line 179 of file RealtimeEffectState.cpp.

Referenced by Initialize(), MainWrite(), and WorkerRead().

mChannelToMain

MessageBuffer<ToMainSlot> RealtimeEffectState::AccessState::mChannelToMain

Definition at line 183 of file RealtimeEffectState.cpp.

Referenced by Initialize(), MainRead(), and WorkerWrite().

mCounter

Response::Counter RealtimeEffectState::AccessState::mCounter

Definition at line 180 of file RealtimeEffectState.cpp.

Referenced by MainRead().

mCV

std::condition_variable RealtimeEffectState::AccessState::mCV

Definition at line 186 of file RealtimeEffectState.cpp.

Referenced by WorkerWrite().

mEffect

const EffectSettingsManager& RealtimeEffectState::AccessState::mEffect

Definition at line 176 of file RealtimeEffectState.cpp.

Referenced by WorkerRead().

mLastSettings

SettingsAndCounter RealtimeEffectState::AccessState::mLastSettings

Definition at line 181 of file RealtimeEffectState.cpp.

Referenced by Initialize().

mLockForCV

std::mutex RealtimeEffectState::AccessState::mLockForCV

Definition at line 185 of file RealtimeEffectState.cpp.

Referenced by WorkerWrite().

mMainThreadId

std::thread::id RealtimeEffectState::AccessState::mMainThreadId

Definition at line 188 of file RealtimeEffectState.cpp.

Referenced by Initialize().

mState

RealtimeEffectState& RealtimeEffectState::AccessState::mState

Definition at line 177 of file RealtimeEffectState.cpp.

Referenced by MainRead(), WorkerRead(), and WorkerWrite().

---

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

• RealtimeEffectState.cpp