UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
FMessageDispatchTask Class Reference

#include <MessageDispatchTask.h>

Public Member Functions

 FMessageDispatchTask (ENamedThreads::Type InThread, TSharedRef< IMessageContext, ESPMode::ThreadSafe > InContext, TWeakPtr< IMessageReceiver, ESPMode::ThreadSafe > InRecipient, TSharedPtr< FMessageTracer, ESPMode::ThreadSafe > InTracer)
 
void DoTask (ENamedThreads::Type CurrentThread, const FGraphEventRef &MyCompletionGraphEvent)
 
ENamedThreads::Type GetDesiredThread ()
 
TStatId GetStatId () const
 

Static Public Member Functions

static ESubsequentsMode::Type GetSubsequentsMode ()
 

Detailed Description

Implements an asynchronous task for dispatching a message to a recipient.

Constructor & Destructor Documentation

◆ FMessageDispatchTask()

FMessageDispatchTask::FMessageDispatchTask ( ENamedThreads::Type  InThread,
TSharedRef< IMessageContext, ESPMode::ThreadSafe InContext,
TWeakPtr< IMessageReceiver, ESPMode::ThreadSafe InRecipient,
TSharedPtr< FMessageTracer, ESPMode::ThreadSafe InTracer 
)

Creates and initializes a new instance.

Parameters
InThreadThe name of the thread to dispatch the message on.
InContextThe context of the message to dispatch.
InRecipientThe message recipient.
InTracerThe message tracer to notify.

Member Function Documentation

◆ DoTask()

void FMessageDispatchTask::DoTask ( ENamedThreads::Type  CurrentThread,
const FGraphEventRef MyCompletionGraphEvent 
)

Performs the actual task.

Parameters
CurrentThreadThe thread that this task is executing on.
MyCompletionGraphEventThe completion event.

◆ GetDesiredThread()

ENamedThreads::Type FMessageDispatchTask::GetDesiredThread ( )
inline

Returns the name of the thread that this task should run on.

Returns
Thread name.

◆ GetStatId()

TStatId FMessageDispatchTask::GetStatId ( ) const

Gets the task's stats tracking identifier.

Returns
Stats identifier.

◆ GetSubsequentsMode()

static ESubsequentsMode::Type FMessageDispatchTask::GetSubsequentsMode ( )
inlinestatic

Gets the mode for tracking subsequent tasks.

Returns
Always track subsequent tasks.

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