UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
TLockFreePointerListFIFO< T, TPaddingForCacheContention > Class Template Reference

#include <LockFreeList.h>

+ Inheritance diagram for TLockFreePointerListFIFO< T, TPaddingForCacheContention >:

Public Member Functions

void Push (T *NewItem)
 
T * Pop ()
 
template<typename ContainerType >
void PopAll (ContainerType &Output)
 
UE_FORCEINLINE_HINT bool IsEmpty () const
 

Member Function Documentation

◆ IsEmpty()

template<class T , int TPaddingForCacheContention>
UE_FORCEINLINE_HINT bool TLockFreePointerListFIFO< T, TPaddingForCacheContention >::IsEmpty ( ) const
inline

Check if the list is empty.

Returns
true if the list is empty. CAUTION: This methods safety depends on external assumptions. For example, if another thread could add to the list at any time, the return value is no better than a best guess. As typically used, the list is not being access concurrently when this is called.

◆ Pop()

template<class T , int TPaddingForCacheContention>
T * TLockFreePointerListFIFO< T, TPaddingForCacheContention >::Pop ( )
inline

Pop an item from the list or return NULL if the list is empty.

Returns
The popped item, if any.

◆ PopAll()

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

Pop all items from the list.

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

◆ Push()

template<class T , int TPaddingForCacheContention>
void TLockFreePointerListFIFO< T, TPaddingForCacheContention >::Push ( T *  NewItem)
inline

Push an item onto the head of the list.

Parameters
NewItem,thenew item to push on the list, cannot be NULL.

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