Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > MessagingCommon > FMessageEndpoint > FMessageEndpoint::SetRecipientThread

Light Theme

Dark Theme

FMessageEndpoint::SetRecipientThread

Sets the name of the thread to receive messages on.

Windows

MacOS

Linux

References

Module	MessagingCommon
Header	/Engine/Source/Runtime/MessagingCommon/Public/MessageEndpoint.h
Include	#include "MessageEndpoint.h"

Syntax

void SetRecipientThread
(
const ENamedThreads::Type & NamedThread
)

Remarks

Sets the name of the thread to receive messages on.

Use this method to receive messages on a particular thread, for example, if the consumer owning this endpoint is not thread-safe. The default value is ThreadAny.

ThreadAny is the fastest way to receive messages. It should be used if the receiving code is completely thread-safe and if it is sufficiently fast. ThreadAny MUST NOT be used if the receiving code is not thread-safe. It also SHOULD NOT be used if the code includes time consuming operations, because it will block the message router, causing no other messages to be delivered in the meantime.

Parameters

Parameter	Description
NamedThread	The name of the thread to receive messages on.

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss