FMessageEndpointBuilder | Unreal Engine 5.5 Documentation

API > API/Runtime > API/Runtime/MessagingCommon

References


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

Syntax

struct FMessageEndpointBuilder

Remarks

Implements a message endpoint builder.

Constructors

	Type	Name	Description
		FMessageEndpointBuilder ( const FName& InName )	Creates and initializes a new builder using the default message bus.
		FMessageEndpointBuilder ( const FName& InName, const TSharedRef< IMessageBus, ESPMode::ThreadSafe >& InBus )	Creates and initializes a new builder using the specified message bus.

Functions

Type	Name	Description
TSharedPtr< FMessageEndpoint, ESPMode::ThreadSafe >	Build ()	Builds the message endpoint as configured.
FMessageEndpointBuilder &	Handling ( typename TFunctionMessageHandler< MessageType >::FuncType HandlerFunc )	Adds a message handler for the given type of messages (via TFunction object).
FMessageEndpointBuilder &	Handling ( HandlerType* Handler, typename TRawMessageHandler< MessageType, HandlerType >::FuncType HandlerFunc )	Adds a message handler for the given type of messages (via raw function pointers).
FMessageEndpointBuilder &	NotificationHandling ( FOnBusNotification&& InHandler )
FMessageEndpointBuilder &	ReceivingOnAnyThread ()	Configures the endpoint to receive messages on any thread.
FMessageEndpointBuilder &	ReceivingOnThread ( ENamedThreads::Type NamedThread )	Configured the endpoint to receive messages on a specific thread.
FMessageEndpointBuilder &	ThatIsDisabled ()	Disables the endpoint.
FMessageEndpointBuilder &	WithCatchall ( FFunctionMessageCatchall::FuncType HandlerFunc )	Adds a message handler for the given type of messages (via TFunction object).
FMessageEndpointBuilder &	WithCatchall ( HandlerType* Handler, typename TRawMessageCatchall< HandlerType >::FuncType HandlerFunc )	Adds a message handler for the given type of messages (via raw function pointers).
FMessageEndpointBuilder &	WithHandler ( const TSharedRef< IMessageHandler, ESPMode::ThreadSafe >& Handler )	Registers a message handler with the endpoint.
FMessageEndpointBuilder &	WithInbox ()	Enables the endpoint's message inbox.The inbox is disabled by default.