//  Copyright (c) 2007, Monju System Architects
//
//  Released under the Monju-Public copyright license:
//
//  Permission is hereby granted, free of charge, to any person or entity
//  obtaining a copy of this software and associated documentation files
//  (the "Software"), to deal in the Software without restriction,
//  including without limitation the rights to use, copy, modify, merge,
//  publish, distribute, sublicense, and/or sell copies and modifications
//  of the Software, and to permit persons to whom the Software is
//  furnished to do so, subject to the following conditions:
//
//  The above copyright notice and this permission notice shall be
//  included in all copies or substantial portions of published, sold, or
//  ownership-transferred versions of the Software. The notices are not
//  required for binary-only releases or binary-only derivatives of the
//  Software, or documentation provided with binary-only releases and
//  binary-only derivatives.
//
//  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
//  EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
//  MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
//  IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
//  CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
//  TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
//  SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.



#ifndef _PUBLIC_SIGNAL_H
#define _PUBLIC_SIGNAL_H



//  INCLUDES
#ifdef _WIN32
	#include "Windows.h"
#endif

#include "public/mutex.h"


//  TYPEDEFS.
#ifdef _WIN32

	typedef HANDLE  SIGNAL_TYPE;
	typedef HANDLE  WAITABLE_TYPE; 

#else

	struct Signal {
	    MUTEX_TYPE  m_mutex;
	    int         m_pipe[2];
	    bool        m_isSignalled;
	};

	typedef struct Signal   SIGNAL_TYPE;
	typedef int             WAITABLE_TYPE; 


#endif



//  FUNCTION DECLARATIONS.
SIGNAL_TYPE     createSignal();
bool            isSignalSet(const SIGNAL_TYPE& signal);
SIGNAL_TYPE&    getExitSignal();
void            resetSignal(SIGNAL_TYPE& signal);
void            signalSignal(SIGNAL_TYPE& signal);
void            closeSignal(SIGNAL_TYPE& signal);

WAITABLE_TYPE   _getWaitableObjectFromSignal(const SIGNAL_TYPE& signal);


#endif //  #ifndef _PUBLIC_SIGNAL_H