UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Public Member Functions | List of all members
TClosableLockFreePointerListUnorderedSingleConsumer< T, TPaddingForCacheContention > Class Template Reference

#include <LockFreeList.h>

+ Inheritance diagram for TClosableLockFreePointerListUnorderedSingleConsumer< T, TPaddingForCacheContention >:

Public Member Functions

void Reset ()
 
bool PushIfNotClosed (T *NewItem)
 
template<typename ContainerType >
void PopAllAndClose (ContainerType &Output)
 
bool IsClosed () const
 

Member Function Documentation

◆ IsClosed()

template<class T , int TPaddingForCacheContention>
bool TClosableLockFreePointerListUnorderedSingleConsumer< T, TPaddingForCacheContention >::IsClosed ( ) const
inline

Check if the list is closed

Returns
true if the list is closed.

◆ PopAllAndClose()

template<class T , int TPaddingForCacheContention>
template<typename ContainerType >
void TClosableLockFreePointerListUnorderedSingleConsumer< T, TPaddingForCacheContention >::PopAllAndClose ( ContainerType &  Output)
inline

Pop all items from the list and atomically close it.

Parameters
OutputThe array to hold the returned items. Must be empty.

◆ PushIfNotClosed()

template<class T , int TPaddingForCacheContention>
bool TClosableLockFreePointerListUnorderedSingleConsumer< T, TPaddingForCacheContention >::PushIfNotClosed ( T *  NewItem)
inline

Push an item onto the head of the list, unless the list is closed

Parameters
NewItem,thenew item to push on the list, cannot be NULL
Returns
true if the item was pushed on the list, false if the list was closed.

◆ Reset()

template<class T , int TPaddingForCacheContention>
void TClosableLockFreePointerListUnorderedSingleConsumer< T, TPaddingForCacheContention >::Reset ( )
inline

Reset the list to the initial state. Not thread safe, but used for recycling when we know all users are gone.

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