fml::SyncSwitch Class Reference

#include <sync_switch.h>

Classes
struct	Handlers
	Represents the 2 code paths available when calling |SyncSwitchExecute|. More...
class	Observer
	Observes changes to the SyncSwitch. More...

Public Member Functions
	SyncSwitch (bool value=false)
void	Execute (const Handlers &handlers) const
void	SetSwitch (bool value)
void	AddObserver (Observer *observer) const
	Threadsafe.
void	RemoveObserver (Observer *observer) const
	Threadsafe.

Detailed Description

A threadsafe structure that allows you to switch between 2 different execution paths.

Execution and setting the switch is exclusive, i.e. only one will happen at a time.

Definition at line 22 of file sync_switch.h.

Constructor & Destructor Documentation

SyncSwitch()

fml::SyncSwitch::SyncSwitch ( bool  value = false )

explicit

Create a |SyncSwitch| with the specified value.

Parameters

[in]

value

Default value for the |SyncSwitch|.

Definition at line 24 of file sync_switch.cc.

: value_(value) {}

References value.

Member Function Documentation

AddObserver()

void fml::SyncSwitch::AddObserver

(

Observer *

observer

)

const

Threadsafe.

Definition at line 45 of file sync_switch.cc.

                                                     {
  std::unique_lock lock(mutex_);
  if (std::find(observers_.begin(), observers_.end(), observer) ==
      observers_.end()) {
    observers_.push_back(observer);
  }
}

Execute()

void fml::SyncSwitch::Execute

(

const Handlers &

handlers

)

const

Diverge execution between true and false values of the SyncSwitch.

This can be called on any thread. Note that attempting to call |SetSwitch| inside of the handlers will result in a self deadlock.

Parameters

[in]

handlers

Called for the correct value of the |SyncSwitch|.

Definition at line 26 of file sync_switch.cc.

                                                                 {
  std::shared_lock lock(mutex_);
  if (value_) {
    handlers.true_handler();
  } else {
    handlers.false_handler();
  }
}

References fml::SyncSwitch::Handlers::false_handler, and fml::SyncSwitch::Handlers::true_handler.

Referenced by TEST(), TEST(), and TEST().

RemoveObserver()

void fml::SyncSwitch::RemoveObserver

(

Observer *

observer

)

const

Threadsafe.

Definition at line 53 of file sync_switch.cc.

                                                        {
  std::unique_lock lock(mutex_);
  observers_.erase(std::remove(observers_.begin(), observers_.end(), observer),
                   observers_.end());
}

SetSwitch()

void fml::SyncSwitch::SetSwitch

(

bool

value

)

Set the value of the SyncSwitch.

This can be called on any thread.

Parameters

[in]

value

New value for the |SyncSwitch|.

Definition at line 35 of file sync_switch.cc.

                                     {
  {
    std::unique_lock lock(mutex_);
    value_ = value;
  }
  for (Observer* observer : observers_) {
    observer->OnSyncSwitchUpdate(value);
  }
}

References value.

Referenced by TEST(), and TEST().

---

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

• fml/synchronization/sync_switch.h
• fml/synchronization/sync_switch.cc