Unigine::AtomicLockFreeAlign Class
Header: | #include <UnigineThread.h> |
AtomicLockFreeAlign<Type> is a lock-free atomic wrapper used when type <Type> does not exactly match a supported raw integer type (char, short, int, long long) in size or alignment but still fits within the atomic system's constraints.
Internally, it uses a union to convert between <Type> and RawType, ensuring alignment and layout correctness.
The value is stored in an aligned memory block, and all access is performed atomically without the need for external synchronization mechanisms like mutexes.
AtomicLockFreeAlign Class
Members
AtomicLockFreeAlign ( ) #
Default constructor.AtomicLockFreeAlign ( Type v ) #
Constructor. Initializes the value by copying the binary representation of the provided value.Arguments
- Type v - Initial value.
AtomicLockFreeAlign ( const AtomicLockFreeAlign& v ) #
Copy constructor. Initializes the object by copying the raw value from another atomic object, ensuring atomic consistency.Arguments
- const AtomicLockFreeAlign& v
Type operator Type() ( ) const#
Implicitly converts the AtomicLockFreeAlign object to a value of type Type. Internally calls fetch() to return a thread-safe snapshot of the current value.Return value
Returns copy of the current value.RawType & getUnsafeRawValue ( ) #
Provides direct, non-synchronized access to the internal raw value. Calling this bypasses all thread safety and must only be used when external synchronization is guaranteed by the caller.Return value
Returns a reference to the internal raw value.const RawType & getUnsafeRawValue ( ) const#
Const-qualified version of getUnsafeRawValue(). Provides read-only, non-thread-safe access to the stored value.Return value
Returns a const reference to the internal raw value.RawType * getRawValuePtr ( ) #
Returns a pointer to the internal raw value.Return value
Returns a pointer to the internal raw value.const RawType * getRawValuePtr ( ) const#
Const-qualified version of getRawValuePtr(). Provides read-only, non-thread-safe access to the stored value.Return value
Returns a const pointer to the internal raw value.Type & getUnsafeValue ( ) #
Provides direct, non-synchronized access to the internal logical value, reinterpreted from the raw data. Unsafe in multithreaded contexts unless externally synchronized.Return value
Returns non-thread-safe reference to the stored value.const Type & getUnsafeValue ( ) const#
Const-qualified version of getUnsafeValue(). Provides read-only, non-thread-safe access to the stored value.Return value
Returns non-thread-safe const reference to the stored value.Type * getValuePtr ( ) #
Returns a raw pointer to the internal value, reinterpreted from the raw data. Unsafe in multithreaded contexts unless externally synchronized.Return value
Returns pointer to the internal value.const Type * getValuePtr ( ) const#
Const-qualified version of getValuePtr(). Provides read-only, non-thread-safe access to the stored value.Return value
Returns const pointer to the internal value.Type fetch ( ) const#
Retrieves the current value in a lock-free, thread-safe manner. Performs an atomic read of the raw internal storage and reinterprets the result.Return value
Returns copy of the stored value.void store ( Type v ) #
Stores a new value by writing its raw binary representation atomically into internal storage.Arguments
- Type v - The new value to store.
Type operator= ( Type v ) #
Copy assignment operator. Stores the new value atomically by calling store().Arguments
- Type v - The new value to assign.
Return value
Returns the assigned value.Type operator= ( const AtomicLockFreeRaw& v ) #
Copy assignment operator. Atomically replaces the internal value with the one from another atomic object.Arguments
- const AtomicLockFreeRaw& v - Another atomic to copy from.
Return value
Returns the copied value.Type swap ( Type v ) #
Atomically replaces the current value with a new one and returns the old value.Arguments
- Type v - The new value to set.
Return value
Returns the value that was stored before swap.bool compareAndSwap ( Type old_value, Type new_value ) #
Performs a lock-free compare-and-swap operation. If the current value equals old_value, it is replaced with new_value.Arguments
- Type old_value - Expected current value.
- Type new_value - New value to assign if the current matches the expected.
Return value
Returns true if the internal value was updated; false if the current value did not match old_value.void spinLock ( Type old_value, Type new_value ) #
Continuously attempts to atomically swap the value from old_value to new_value using compareAndSwap().Arguments
- Type old_value - Expected current value.
- Type new_value - New value to assign if the current matches the expected.
void waitValue ( Type v ) #
Blocks the current thread in a spin loop until the internal value becomes equal to the provided one. Internally calls spinLock(v, v) and rechecks after each failure.Arguments
- Type v - The value to wait for.
The information on this page is valid for UNIGINE 2.20 SDK.
Last update:
2025-07-10
Help improve this article
Was this article helpful?
(or select a word/phrase and press Ctrl+Enter)