/******************************************************************************

Copyright (c) 2009-2012, Intel Corporation 
All rights reserved.

Redistribution and use in source and binary forms, with or without 
modification, are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice, 
this list of conditions and the following disclaimer.

2. Redistributions in binary form must reproduce the above copyright 
notice, this list of conditions and the following disclaimer in the 
documentation and/or other materials provided with the distribution.

3. Neither the name of the Intel Corporation nor the names of its 
contributors may be used to endorse or promote products derived from 
this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 
ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE 
LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 
CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 
SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 
INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 
ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
POSSIBILITY OF SUCH DAMAGE.

******************************************************************************/

#ifndef STOPPABLE_HPP
#define STOPPABLE_HPP

#include <Windows.h>
#include <gptp_log.hpp>

/**@file*/

/**
 * @brief Provides an interface to stop threads
 */
class Stoppable {
protected:
	bool exit_waiting;	/*!< Waiting to exit */
	HANDLE thread;		/*!< Thread handler */
public:
	/**
	 * @brief Initializes interface
	 */
	Stoppable() { thread = NULL; exit_waiting = false; }
	/**
	 * @brief  Stops thread
	 * @return TRUE in case of success. FALSE otherwise.
	 */
	bool stop() {
		if( thread == NULL ) return false;
		exit_waiting = true;
		if( WaitForSingleObject( thread, INFINITE ) == WAIT_FAILED ) {
			char *errstr;
			GPTP_LOG_ERROR( "Wait for thread exit failed %s", errstr );
			delete errstr;
		}
		exit_waiting = false;
		return true;
	}
	/**
	 * @brief destroys the interface
	 */
	virtual ~Stoppable() = 0 {};
};

#endif/*STOPPABLE_HPP*/
