Files
pip/libs/main/thread/piprotectedvariable.h
peri4 4655d72554 new class PISemaphore
doc for PIProtectedVariable
2024-11-12 18:50:22 +03:00

82 lines
2.2 KiB
C++

/*! \file piprotectedvariable.h
* \ingroup Thread
* \~\brief
* \~english Thread-safe variable
* \~russian Потокобезопасная переменная
*/
/*
PIP - Platform Independent Primitives
Thread-safe variable
Ivan Pelipenko peri4ko@yandex.ru, Stephan Fomenko, Andrey Bychkov work.a.b@yandex.ru
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Lesser General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef PIPROTECTEDVARIABLE_H
#define PIPROTECTEDVARIABLE_H
#include "pimutex.h"
template<typename T>
class PIP_EXPORT PIProtectedVariable {
public:
//! \~english Sets value to copy of \"v\"
//! \~russian Устанавливает значение как копию \"v\"
void set(const T & v) {
PIMutexLocker _ml(mutex);
var = v;
}
//! \~english Sets value by moving \"v\"
//! \~russian Устанавливает значение перемещением \"v\"
void set(T && v) {
PIMutexLocker _ml(mutex);
var = std::move(v);
}
//! \~english Returns copy of value
//! \~russian Возвращает копию значения
T get() const {
PIMutexLocker _ml(mutex);
return var;
}
//! \~english Lock mutex and returns reference of value
//! \~russian Блокирует мьютекс и возвращает ссылку на значение
T & lock() {
mutex.lock();
return var;
}
//! \~english Unlock mutex
//! \~russian Разблокирует мьютекс
void unlock() { mutex.unlock(); }
//! \~english Sets value to copy of \"v\"
//! \~russian Устанавливает значение как копию \"v\"
PIProtectedVariable<T> & operator=(const T & v) {
set(v);
return *this;
}
private:
mutable PIMutex mutex;
T var;
};
#endif