//! \~\file pithreadnotifier.h
//! \~\ingroup Thread
//! \~\brief
//! \~english Counting notification helper for coordination between threads
//! \~russian Счетный помощник уведомления для координации между потоками
/*
    PIP - Platform Independent Primitives
    Class for simply notify and wait in different threads
	Ivan Pelipenko peri4ko@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 PITHREADNOTIFIER_H
#define PITHREADNOTIFIER_H

#include "piconditionvar.h"


//! \~\ingroup Thread
//! \~\brief
//! \~english Thread notifier class for synchronization between threads.
//! \~russian Класс уведомления потоков для синхронизации между потоками.
//! \~\details
//! \~english
//! Each \a notify() stores one pending wake-up. A later \a wait() or
//! \a waitFor() consumes one stored notification; with multiple waiters the
//! resume order is unspecified.
//! \~russian
//! Каждый вызов \a notify() сохраняет одно ожидающее пробуждение. Последующий
//! \a wait() или \a waitFor() потребляет одно сохраненное уведомление; при
//! нескольких ожидающих потоках порядок возобновления не определен.
class PIP_EXPORT PIThreadNotifier {
public:
	PIThreadNotifier();

	//! \~english Start waiting, return if other thread call \a notify()
	//! \~russian Начать ожидание, продолжает когда другой поток вызовет \a notify()
	void wait();

	//! \~english Start waiting no longer than "timeout", return \b true if other thread call \a notify(), \b false if timeout expired
	//! \~russian Начать ожидание не дольше чем "timeout", возвращает \b true когда другой поток вызовал \a notify(), \b false если таймаут
	//! истек
	bool waitFor(PISystemTime timeout);

	//! \~english Notify one waiting thread, which waiting on \a wait() function
	//! \~russian Уведомить один из ожидающих потоков, которые висят на методе \a wait()
	void notify();

private:
	ullong cnt;
	PIMutex m;
	PIConditionVariable v;
};

#endif // PITHREADNOTIFIER_H
