qx::threads_shared< data_t, synchronization_primitive_t > Class Template Reference

A class that provides thread-safe access to an object, including construction and destruction. More...

#include <threads_shared.h>

Public Member Functions
template<class... args_t>
	threads_shared (args_t &&... args)
	threads_shared object constructor More...
	~threads_shared ()
	threads_shared object destructor
proxy	lock ()
	Wait for other threads to finish work with data object and retrieve proxy object. More...
std::optional< proxy >	try_lock ()
	Try to lock synchronization primitive and get proxy. More...

Detailed Description

template<class data_t, class synchronization_primitive_t = std::mutex>
class qx::threads_shared< data_t, synchronization_primitive_t >

A class that provides thread-safe access to an object, including construction and destruction.

Template Parameters

data_t	- data type
synchronization_primitive_t	- synchronization primitive type

Author

Khrapov

Date

20.08.2021

Definition at line 81 of file threads_shared.h.

Constructor & Destructor Documentation

threads_shared()

template<class data_t , class synchronization_primitive_t >

template<class... args_t>

qx::threads_shared< data_t, synchronization_primitive_t >::threads_shared ( args_t &&...  args )

inline

threads_shared object constructor

Template Parameters

args_t

- template parameter pack type

Parameters

args	- arguments to constructing Data object

Definition at line 115 of file threads_shared.inl.

Member Function Documentation

lock()

template<class data_t , class synchronization_primitive_t >

threads_shared< data_t, synchronization_primitive_t >::proxy qx::threads_shared< data_t, synchronization_primitive_t >::lock

inline

Wait for other threads to finish work with data object and retrieve proxy object.

Return values

-	proxy that provides access to an object stored in threads_shared and provides raii for synchronization primitives

Definition at line 135 of file threads_shared.inl.

try_lock()

template<class data_t , class synchronization_primitive_t >

std::optional< typename threads_shared< data_t, synchronization_primitive_t >::proxy > qx::threads_shared< data_t, synchronization_primitive_t >::try_lock

inline

Try to lock synchronization primitive and get proxy.

Return values

-	proxy that provides access to an object stored in threads_shared or std::nullopt

Definition at line 143 of file threads_shared.inl.

---

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

• include/qx/threads_shared.h
• include/qx/threads_shared.inl