Threading::Interlocked::AtomicCounter Struct Reference

#include <interlocked.h>

Detailed Description

Atomic value only used to decrement, increment and read a 32 bit value.

Public Member Functions
	AtomicCounter ()
	AtomicCounter (int initial)
	Constructor.
bool	operator== (int value) const
	Equals.
bool	operator!= (int value) const
	Not-equals.
bool	operator> (int value) const
	Greater.
bool	operator>= (int value) const
	Greater or equal.
bool	operator< (int value) const
	Less.
bool	operator<= (int value) const
	Less or equal.
int	Increment ()
	Increment and return the new value.
int	Decrement ()
	Decrement and return the new value.
int	Add (int addend)
	Add and return the old value.
int	Subtract (int subtractor)
	Subtract and return the old value.
int	Exchange (int value)
	Exchange and return the old value.
void	RaceDecrement ()
	Unsafe decrement, only use before or after contention is possible.
void	RaceIncrement ()
	Unsafe increment, only use before or after contention is possible.
void	RaceExchange (int value)
	Unsafe exchange, only use before or after contention is possible.

Public Attributes
volatile int	counter

Constructor & Destructor Documentation

AtomicCounter() [1/2]

Threading::Interlocked::AtomicCounter::AtomicCounter ( )

inline

AtomicCounter() [2/2]

Threading::Interlocked::AtomicCounter::AtomicCounter ( int initial )

inline

Constructor.

Member Function Documentation

Add()

int Threading::Interlocked::AtomicCounter::Add ( int addend )

inline

Add and return the old value.

Decrement()

int Threading::Interlocked::AtomicCounter::Decrement ( )

inline

Decrement and return the new value.

Exchange()

int Threading::Interlocked::AtomicCounter::Exchange ( int value )

inline

Exchange and return the old value.

Increment()

int Threading::Interlocked::AtomicCounter::Increment ( )

inline

Increment and return the new value.

operator!=()

bool Threading::Interlocked::AtomicCounter::operator!= ( int value ) const

inline

Not-equals.

operator<()

bool Threading::Interlocked::AtomicCounter::operator< ( int value ) const

inline

Less.

operator<=()

bool Threading::Interlocked::AtomicCounter::operator<= ( int value ) const

inline

Less or equal.

operator==()

bool Threading::Interlocked::AtomicCounter::operator== ( int value ) const

inline

Equals.

operator>()

bool Threading::Interlocked::AtomicCounter::operator> ( int value ) const

inline

Greater.

operator>=()

bool Threading::Interlocked::AtomicCounter::operator>= ( int value ) const

inline

Greater or equal.

RaceDecrement()

void Threading::Interlocked::AtomicCounter::RaceDecrement ( )

inline

Unsafe decrement, only use before or after contention is possible.

RaceExchange()

void Threading::Interlocked::AtomicCounter::RaceExchange ( int value )

inline

Unsafe exchange, only use before or after contention is possible.

RaceIncrement()

void Threading::Interlocked::AtomicCounter::RaceIncrement ( )

inline

Unsafe increment, only use before or after contention is possible.

Subtract()

int Threading::Interlocked::AtomicCounter::Subtract ( int subtractor )

inline

Subtract and return the old value.

Member Data Documentation

counter

volatile int Threading::Interlocked::AtomicCounter::counter

---

The documentation for this struct was generated from the following file:

• /github/workspace/code/foundation/threading/interlocked.h