#include <evo/atomic.h>

Inheritance diagram for AtomicPtr< T >:

Detailed Description

template<class T>
class evo::AtomicPtr< T >

Atomic dumb pointer to single object.

This is an atomic version of Ptr with increment/decrement operator support
All operations are atomic
- Caution: This does not make the pointed type thread safe!
- Caution: T should be atomic or thread safe, unless you're sure only one thread will use an item at a time
Specialized for array pointer: AtomicPtr<T[]>

Template Parameters

T	Type to use pointer to (not the raw pointer type)

Public Types
typedef PtrBase< T, Atomic< T * > >	Base
	Base type. More...

typedef void	EvoNullableType
	Identify as nullable type. More...

typedef PtrBase< T >	PtrBaseT
	Managed pointer base type. More...

typedef AtomicPtr< T >	This
	This type. More...

Public Member Functions
	AtomicPtr ()
	Default constructor sets as NULL. More...

	AtomicPtr (T *ptr)
	Constructor. More...

	AtomicPtr (const T *ptr)
	Constructor. More...

	AtomicPtr (const This &src)
	Copy constructor. More...

	AtomicPtr (const Base &src)
	Copy constructor to reference pointer. More...

	AtomicPtr (const PtrBaseT &src)
	Copy constructor to reference pointer. More...

This &	clear ()
	Clear pointer, setting as null. More...

T *	detach ()
	Detach and return pointer. More...

bool	null () const
	Get whether pointer is null. More...

	operator SafeBoolType () const
	Safe (explicit) evaluation as bool type. More...

bool	operator! () const
	Negation operator checks if NULL. More...

bool	operator!= (const PtrBaseT &ptr) const
	Inequality operator. More...

bool	operator!= (const Base &ptr) const
	Inequality operator. More...

bool	operator!= (void *ptr) const
	Inequality operator. More...

const T &	operator* () const
	Dereference operator (const). More...

T &	operator* ()
	Dereference operator (mutable). More...

T *	operator++ ()
	Prefix increment operator. More...

T *	operator++ (int)
	Prefix increment operator. More...

This &	operator+= (int count)
	Increment by count operator. More...

T *	operator-- ()
	Prefix decrement operator. More...

T *	operator-- (int)
	Postfix decrement operator. More...

This &	operator-= (int count)
	Decrement by count operator. More...

const T *	operator-> () const
	Member access operator (const). More...

T *	operator-> ()
	Member access operator (mutable). More...

bool	operator< (const PtrBaseT &ptr) const
	Less-than operator. More...

bool	operator< (const Base &ptr) const
	Less-than operator. More...

bool	operator< (void *ptr) const
	Less-than operator. More...

bool	operator<= (const PtrBaseT &ptr) const
	Less-than-or-equals operator. More...

bool	operator<= (const Base &ptr) const
	Less-than-or-equals operator. More...

bool	operator<= (void *ptr) const
	Less-than-or-equals operator. More...

This &	operator= (const This &src)
	Copy/Assignment operator. More...

This &	operator= (const Base &src)
	Assignment operator to reference pointer. More...

This &	operator= (const PtrBaseT &src)
	Assignment operator to reference pointer. More...

This &	operator= (T *ptr)
	Assignment operator for raw pointer. More...

This &	operator= (const T *ptr)
	Assignment operator for raw pointer. More...

bool	operator== (const PtrBaseT &ptr) const
	Equality operator. More...

bool	operator== (const Base &ptr) const
	Equality operator. More...

bool	operator== (void *ptr) const
	Equality operator. More...

bool	operator> (const PtrBaseT &ptr) const
	Greater-than operator. More...

bool	operator> (const Base &ptr) const
	Greater-than operator. More...

bool	operator> (void *ptr) const
	Greater-than operator. More...

bool	operator>= (const PtrBaseT &ptr) const
	Greater-than-or-equals operator. More...

bool	operator>= (const Base &ptr) const
	Greater-than-or-equals operator. More...

bool	operator>= (void *ptr) const
	Greater-than-or-equals operator. More...

const T &	operator[] (ulong index) const
	Array access operator (const). More...

T &	operator[] (ulong index)
	Array access operator (mutable). More...

const T *	ptr () const
	Get current pointer (const). More...

T *	ptr ()
	Get current pointer (mutable). More...

bool	valid () const
	Get whether pointer is valid (not null). More...

Public Attributes
Atomic< T * >	ptr_
	Pointer. More...

Member Typedef Documentation

◆ EvoNullableType

typedef void EvoNullableType

inherited

Identify as nullable type.

Member Function Documentation

◆ null()

bool null ( ) const

inlineinherited

Get whether pointer is null.

Returns: Whether null

◆ operator SafeBoolType()

operator SafeBoolType ( ) const

inlineinherited

Safe (explicit) evaluation as bool type.

This is called when object is directly evaluated as a bool, and is equivalent to: !operator!()
See SafeBool

◆ operator!()

bool operator! ( ) const

inlineinherited

Negation operator checks if NULL.

Returns: Whether NULL

◆ operator!=() [1/2]

bool operator!= ( const Base & ptr ) const

inlineinherited

Inequality operator.

Parameters

ptr	Pointer to compare to

Returns: Whether not equal

◆ operator!=() [2/2]

bool operator!= ( void * ptr ) const

inlineinherited

Inequality operator.

Parameters

ptr	Pointer to compare to

Returns: Whether not equal

◆ operator*() [1/2]

const T& operator* ( ) const

inlineinherited

Dereference operator (const).

Results are undefined if pointer is NULL

Returns: Dereferenced pointer

◆ operator*() [2/2]

T& operator* ( )

inlineinherited

Dereference operator (mutable).

Results are undefined if pointer is NULL

Returns: Dereferenced pointer

◆ operator->() [1/2]

const T* operator-> ( ) const

inlineinherited

Member access operator (const).

Results are undefined if pointer is NULL

Returns: Pointer

◆ operator->() [2/2]

T* operator-> ( )

inlineinherited

Member access operator (mutable).

Results are undefined if pointer is NULL

Returns: Pointer

◆ operator<() [1/2]

bool operator< ( const Base & ptr ) const

inlineinherited

Less-than operator.

Parameters

ptr	Pointer to compare to

Returns: Whether less than ptr

◆ operator<() [2/2]

bool operator< ( void * ptr ) const

inlineinherited

Less-than operator.

Parameters

ptr	Pointer to compare to

Returns: Whether less than ptr

◆ operator<=() [1/2]

bool operator<= ( const Base & ptr ) const

inlineinherited

Less-than-or-equals operator.

Parameters

ptr	Pointer to compare to

Returns: Whether less than or equal to ptr

◆ operator<=() [2/2]

bool operator<= ( void * ptr ) const

inlineinherited

Less-than-or-equals operator.

Parameters

ptr	Pointer to compare to

Returns: Whether less than or equal to ptr

◆ operator==() [1/2]

bool operator== ( const Base & ptr ) const

inlineinherited

Equality operator.

Parameters

ptr	Pointer to compare to

Returns: Whether equal

◆ operator==() [2/2]

bool operator== ( void * ptr ) const

inlineinherited

Equality operator.

Parameters

ptr	Pointer to compare to

Returns: Whether equal

◆ operator>() [1/2]

bool operator> ( const Base & ptr ) const

inlineinherited

Greater-than operator.

Parameters

ptr	Pointer to compare to

Returns: Whether greater than ptr

◆ operator>() [2/2]

bool operator> ( void * ptr ) const

inlineinherited

Greater-than operator.

Parameters

ptr	Pointer to compare to

Returns: Whether greater than ptr

◆ operator>=() [1/2]

bool operator>= ( const Base & ptr ) const

inlineinherited

Greater-than-or-equals operator.

Parameters

ptr	Pointer to compare to

Returns: Whether greater than or equal to ptr

◆ operator>=() [2/2]

bool operator>= ( void * ptr ) const

inlineinherited

Greater-than-or-equals operator.

Parameters

ptr	Pointer to compare to

Returns: Whether greater than or equal to ptr

◆ operator[]() [1/2]

const T& operator[] ( ulong index ) const

inlineinherited

Array access operator (const).

Results are undefined if pointer is NULL or index is out of bounds

Returns: Item reference

◆ operator[]() [2/2]

T& operator[] ( ulong index )

inlineinherited

Array access operator (mutable).

Results are undefined if pointer is NULL or index is out of bounds

Returns: Item reference

◆ ptr() [1/2]

const T* ptr ( ) const

inlineinherited

Get current pointer (const).

Caution: This does not release ownership of the pointer

Returns: Current pointer, or NULL if none

◆ ptr() [2/2]

T* ptr ( )

inlineinherited

Get current pointer (mutable).

Caution: This does not release ownership of the pointer

Returns: Current pointer, or NULL if none

◆ valid()

bool valid ( ) const

inlineinherited

Get whether pointer is valid (not null).

Returns: Whether valid

Member Data Documentation

◆ ptr_

Atomic< T *> ptr_

inherited

Pointer.

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

evo/atomic.h

Detailed Description

template<class T> class evo::AtomicPtr< T >

Public Types

Public Member Functions

Public Attributes

Member Typedef Documentation

◆ EvoNullableType

Member Function Documentation

◆ null()

◆ operator SafeBoolType()

◆ operator!()

◆ operator!=() [1/2]

◆ operator!=() [2/2]

◆ operator*() [1/2]

◆ operator*() [2/2]

◆ operator->() [1/2]

◆ operator->() [2/2]

◆ operator<() [1/2]

◆ operator<() [2/2]

◆ operator<=() [1/2]

◆ operator<=() [2/2]

◆ operator==() [1/2]

◆ operator==() [2/2]

◆ operator>() [1/2]

◆ operator>() [2/2]

◆ operator>=() [1/2]

◆ operator>=() [2/2]

◆ operator[]() [1/2]

◆ operator[]() [2/2]

◆ ptr() [1/2]

◆ ptr() [2/2]

◆ valid()

Member Data Documentation

◆ ptr_

template<class T>
class evo::AtomicPtr< T >