/*! \file pithreadnotifier.h
 * \ingroup Thread
 * \~\brief
 * \~english Class for simple notify and wait in different threads
 * \~russian Класс для простого уведомления и ожидания в различных потоках
 */
/*
	PIP - Platform Independent Primitives
	Class for simply notify and wait in different threads
	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 PITHREADNOTIFIER_H
#define PITHREADNOTIFIER_H

#include "piconditionvar.h"


class PIP_EXPORT PIThreadNotifier {
public:
	PIThreadNotifier();

	//! Start waiting, return if other thread call \a notifyOnce().
	//! If \a notifyOnce() has been called before, then returns immediately.
	//! If notifyOnce() has been called "n" times, then returns immediately "n" times,
	//! but only if wait in one thread.
	//! If many threads waiting, then If notifyOnce() has been called "n" times,
	//! All threads total returns "n" times in random sequence.
	void wait();

	//! Notify one waiting thread, wich waiting on \a wait() function.
	//! If many threads waiting, then notify randomly one.
	//! If call this "n" times, then notify any waiting threads totally "n" times.
	void notifyOnce();

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

#endif // PITHREADNOTIFIER_H