[wxWidgets.git] / interface / atomic.h

/////////////////////////////////////////////////////////////////////////////
// Name:        atomic.h
// Purpose:     interface of global functions
// Author:      wxWidgets team
// RCS-ID:      $Id$
// Licence:     wxWindows license
/////////////////////////////////////////////////////////////////////////////


// ============================================================================
// Global functions/macros
// ============================================================================

/** @ingroup group_funcmacro_atomic */
//@{

/**
    This function increments @a value in an atomic manner.
*/
void wxAtomicInc(wxAtomicInt& value);

/**
    This function decrements value in an atomic manner.
    Returns 0 if value is 0 after decrementation or any non-zero value
    (not necessarily equal to the value of the variable) otherwise.
*/
wxInt32 wxAtomicDec(wxAtomicInt& value);

//@}
Commit	Line	Data
23324ae1	1	/////////////////////////////////////////////////////////////////////////////
7c913512	2	// Name: atomic.h
e54c96f1	3	// Purpose: interface of global functions
7c913512 FM	4	// Author: wxWidgets team
	5	// RCS-ID: $Id$
	6	// Licence: wxWindows license
	7	/////////////////////////////////////////////////////////////////////////////
	8
39fb8056 FM	9
	10	// ============================================================================
	11	// Global functions/macros
	12	// ============================================================================
	13
	14	/** @ingroup group_funcmacro_atomic */
	15	//@{
	16
7c913512	17	/**
39fb8056	18	This function increments @a value in an atomic manner.
23324ae1 FM	19	*/
	20	void wxAtomicInc(wxAtomicInt& value);
	21
39fb8056 FM	22	/**
	23	This function decrements value in an atomic manner.
	24	Returns 0 if value is 0 after decrementation or any non-zero value
	25	(not necessarily equal to the value of the variable) otherwise.
	26	*/
	27	wxInt32 wxAtomicDec(wxAtomicInt& value);
23324ae1	28
39fb8056	29	//@}