//------------------------------------------------------------------------------
// Lamp : Open source game middleware
// Copyright (C) 2004  Junpei Ohtani ( Email : junpee@users.sourceforge.jp )
//
// This library 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 2.1 of the License, or (at your option) any later version.
//
// This library 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 library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
//------------------------------------------------------------------------------

/** @file
 * ウェイトセットヘッダ
 * @author Junpee
 */

#ifndef WAIT_SET_H_
#define WAIT_SET_H_

#include <Core/Thread/LockObject.h>
#include <Core/Container/Deque.h>

namespace Lamp{

class Thread;

//------------------------------------------------------------------------------
/**
 * ウェイトセット
 */
class WaitSet : public LockObject{
public:
	/**
	 * コンストラクタ
	 *
	 * クリティカルセクションによる同期制御を行う
	 */
	WaitSet();

	/**
	 * コンストラクタ
	 * @param lockObject ロックオブジェクト
	 * @param deleteLockObject ロックオブジェクトをWaitSetが削除するならtrue
	 */
	WaitSet(LockObject* lockObject, bool deleteLockObject);

	/**
	 * デストラクタ
	 */
	virtual ~WaitSet();

	//--------------------------------------------------------------------------
	/**
	 * 待機
	 * @param thread 待機させるスレッド
	 *
	 * 引数のスレッドを待機させます。呼び出すにはWaitSetに対するロックが必要。
	 * カレントスレッド版より高速に動作します。
	 */
	virtual void wait(const Thread* thread);

	/**
	 * 待機
	 * カレントスレッドを待機させます。呼び出すにはWaitSetに対するロックが必要。
	 */
	virtual void wait();

	/**
	 * 待機解除
	 *
	 * 一つのスレッドの待機を解除します。呼び出すにはWaitSetに対するロックが必要。
	 */
	virtual void notify();

	/**
	 * 待機全解除
	 *
	 * 全てのスレッドの待機を解除します。呼び出すにはWaitSetに対するロックが必要。
	 */
	virtual void notifyAll();

	//--------------------------------------------------------------------------
	/**
	 * ロック
	 */
	virtual void lock(){ lockObject_->lock(); }

	/**
	 * アンロック
	 */
	virtual void unlock(){ lockObject_->unlock(); }

	/**
	 * カレントスレッドによってロックされているか
	 * @return カレントスレッドによってロックされていればtrue
	 */
	virtual bool isLockedByCurrentThread() const{
		return lockObject_->isLockedByCurrentThread();
	}

private:
	// スレッド配列
	Deque<HANDLE> waitingThreads_;
	// ロックオブジェクト
	LockObject* lockObject_;
	// ロックオブジェクト削除フラグ
	bool deleteLockObject_;

};

//------------------------------------------------------------------------------
} // End of namespace Lamp
#endif // End of WAIT_SET_H_
//------------------------------------------------------------------------------

