2008-03-08 08:52:38 -05:00
|
|
|
/////////////////////////////////////////////////////////////////////////////
|
2008-03-08 09:43:31 -05:00
|
|
|
// Name: atomic.h
|
2008-03-10 11:24:38 -04:00
|
|
|
// Purpose: interface of global functions
|
2008-03-08 09:43:31 -05:00
|
|
|
// Author: wxWidgets team
|
|
|
|
// RCS-ID: $Id$
|
|
|
|
// Licence: wxWindows license
|
|
|
|
/////////////////////////////////////////////////////////////////////////////
|
|
|
|
|
2008-03-14 11:35:10 -04:00
|
|
|
|
|
|
|
// ============================================================================
|
|
|
|
// Global functions/macros
|
|
|
|
// ============================================================================
|
|
|
|
|
|
|
|
/** @ingroup group_funcmacro_atomic */
|
|
|
|
//@{
|
|
|
|
|
2008-03-08 09:43:31 -05:00
|
|
|
/**
|
2008-03-14 11:35:10 -04:00
|
|
|
This function increments @a value in an atomic manner.
|
2008-03-19 04:02:01 -04:00
|
|
|
|
2008-06-02 16:42:23 -04:00
|
|
|
Whenever possible wxWidgets provides an efficient, CPU-specific,
|
|
|
|
implementation of this function. If such implementation is available, the
|
|
|
|
symbol wxHAS_ATOMIC_OPS is defined. Otherwise this function still exists
|
|
|
|
but is implemented in a generic way using a critical section which can be
|
|
|
|
prohibitively expensive for use in performance-sensitive code.
|
|
|
|
|
2008-03-19 04:02:01 -04:00
|
|
|
@header{wx/atomic.h}
|
2008-03-08 08:52:38 -05:00
|
|
|
*/
|
|
|
|
void wxAtomicInc(wxAtomicInt& value);
|
|
|
|
|
2008-03-14 11:35:10 -04:00
|
|
|
/**
|
2008-06-02 16:42:23 -04:00
|
|
|
This function decrements value in an atomic manner.
|
|
|
|
|
|
|
|
Returns 0 if value is 0 after decrement or any non-zero value (not
|
|
|
|
necessarily equal to the value of the variable) otherwise.
|
|
|
|
|
|
|
|
@see wxAtomicInc
|
2008-03-19 04:02:01 -04:00
|
|
|
|
|
|
|
@header{wx/atomic.h}
|
2008-03-14 11:35:10 -04:00
|
|
|
*/
|
|
|
|
wxInt32 wxAtomicDec(wxAtomicInt& value);
|
2008-03-08 08:52:38 -05:00
|
|
|
|
2008-03-14 11:35:10 -04:00
|
|
|
//@}
|
2008-03-19 04:02:01 -04:00
|
|
|
|