FMessageEndpointBuilder::ReceivingOnAnyThread

Configures the endpoint to receive messages on any thread.

Windows
MacOS
Linux

References

Module

MessagingCommon

Header

/Engine/Source/Runtime/MessagingCommon/Public/MessageEndpointBuilder.h

Include

#include "MessageEndpointBuilder.h"

Syntax

FMessageEndpointBuilder & ReceivingOnAnyThread()

Remarks

Configures the endpoint to receive messages on any thread.

By default, the builder initializes the message endpoint to receive on the current thread. Use this method to receive on any available thread instead.

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.

Returns

This instance (for method chaining).

See Also

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