BS::signaller Class Reference

A utility class to allow simple signalling between threads. More...

#include <BS_thread_pool_utils.hpp>

Public Member Functions
	signaller ()
	Construct a new signaller.
	signaller (const signaller &)=delete
signaller &	operator= (const signaller &)=delete
	signaller (signaller &&)=default
signaller &	operator= (signaller &&)=default
void	ready ()
	Inform any waiting threads that the signaller is ready.
void	wait ()
	Wait until the signaller is ready.

Private Attributes
std::promise< void >	promise
	A promise used to set the state of the signaller.
std::shared_future< void >	future
	A future used to wait for the signaller.

Detailed Description

A utility class to allow simple signalling between threads.

Constructor & Destructor Documentation

signaller()

BS::signaller::signaller ( )

inline

Construct a new signaller.

: promise(), future(promise.get_future()) {}

Member Function Documentation

ready()

void BS::signaller::ready ( )

inline

Inform any waiting threads that the signaller is ready.

    {
        promise.set_value();
    }

Here is the caller graph for this function:

wait()

void BS::signaller::wait ( )

inline

Wait until the signaller is ready.

    {
        future.wait();
    }

Here is the caller graph for this function:

---

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

• external/threadpool/include/BS_thread_pool_utils.hpp