IQueuedWorkInternalData Class Reference

#include <IQueuedWork.h>

Inheritance diagram for IQueuedWorkInternalData:

Public Member Functions
virtual bool	Retract ()=0
virtual	~IQueuedWorkInternalData ()
Public Member Functions inherited from FThreadSafeRefCountedObject
	FThreadSafeRefCountedObject ()=default
	FThreadSafeRefCountedObject (const FThreadSafeRefCountedObject &Rhs)=delete
FThreadSafeRefCountedObject &	operator= (const FThreadSafeRefCountedObject &Rhs)=delete
virtual	~FThreadSafeRefCountedObject ()
FReturnedRefCountValue	AddRef () const
uint32	Release () const
uint32	GetRefCount () const

Detailed Description

Interface for internal data of queued work objects.

This interface can be used to track some data between the individual function invokations of the FQueuedThreadPool Usually it is used to store some internal state to support cancellation without having to look it up from a map.

Constructor & Destructor Documentation

~IQueuedWorkInternalData()

virtual IQueuedWorkInternalData::~IQueuedWorkInternalData ( )

inlinevirtual

Virtual destructor so that child implementations are guaranteed a chance to clean up any resources they allocated.

Member Function Documentation

Retract()

virtual bool IQueuedWorkInternalData::Retract ( )

pure virtual

called during retraction, when a task is pulled from being worked on. the return value specifies if the cancellation succeded

---

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

• Engine/Source/Runtime/Core/Public/Misc/IQueuedWork.h