RAII.hpp File Reference

#include "Mutex.hpp"

Include dependency graph for RAII.hpp:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
class	RAIIMutex

Functions
template<typename Function >
void	lockedRegion (Function lockedWork, Mutex &mutex)

Detailed Description

Resource Acquisition Is Initialization mutex. Locks when constructed and unlocks when destructed.

Author

Keeton Feavel (keeto.nosp@m.n@xy.nosp@m.r.is)

Version

0.1

Date

2022-01-26

Copyright

Copyright the Xyris Contributors (c) 2022

Definition in file RAII.hpp.

Function Documentation

lockedRegion()

template<typename Function >

void lockedRegion	(	Function	lockedWork,
		Mutex &	mutex
	)

Mutex protected region lambda function. Executed the provided function after locking the provided mutex. Unlocks before returning. Provided lambda function cannot return any value, but may return at any point safely.

Template Parameters

Function

Lambda function template

Parameters

lockedWork	Function to be executed in a safe manner
mutex	Mutex to lock before lambda execution

Definition at line 55 of file RAII.hpp.

{
    RAIIMutex raiiMutex(mutex);
    lockedWork();
}