1. Epic GamesDeveloper
  3. FMessageEndpointBuilder

FMessageEndpointBuilder

Implements a message endpoint builder.

API > API/Runtime > API/Runtime/MessagingCommon

Implements a message endpoint builder.

   
Name FMessageEndpointBuilder
Type struct
Header File /Engine/Source/Runtime/MessagingCommon/Public/MessageEndpointBuilder.h
Include Path #include "MessageEndpointBuilder.h"

Syntax

struct FMessageEndpointBuilder

Constructors

Name Remarks Include Path Unreal Specifiers

FMessageEndpointBuilder ( const FName& InName
)

 Creates and initializes a new builder using the default message bus. MessageEndpointBuilder.h  

FMessageEndpointBuilder ( const FName& InName,
const TSharedRef< IMessageBus, ESPMode::ThreadSafe >& InBus
)

 Creates and initializes a new builder using the specified message bus. MessageEndpointBuilder.h  

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
BusPtr TWeakPtr< IMessageBus, ESPMode::ThreadSafe > Holds a reference to the message bus to attach to. MessageEndpointBuilder.h  
Disabled bool Holds a flag indicating whether the endpoint should be disabled. MessageEndpointBuilder.h  
Handlers TArray< TSharedPtr< IMessageHandler, ESPMode::ThreadSafe > > Holds the collection of message handlers to register. MessageEndpointBuilder.h  
InboxEnabled bool Holds a flag indicating whether the inbox should be enabled. MessageEndpointBuilder.h  
Name FName Holds the endpoint's name (for debugging purposes). MessageEndpointBuilder.h  
OnNotification FOnBusNotification Holds a delegate to invoke on disconnection event. MessageEndpointBuilder.h  
RecipientThread ENamedThreads::Type Holds the name of the thread on which to receive messages. MessageEndpointBuilder.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers
Builds the message endpoint as configured. MessageEndpointBuilder.h  

FMessageEndpointBuilder & Handling ( typename TFunctionMessageHandler< MessageType >::FuncType HandlerFunc
)

 Adds a message handler for the given type of messages (via TFunction object). MessageEndpointBuilder.h  

FMessageEndpointBuilder & Handling ( HandlerType* Handler,
typename TRawMessageHandler< MessageType, HandlerType >::FuncType HandlerFunc
)

 Adds a message handler for the given type of messages (via raw function pointers). MessageEndpointBuilder.h  

FMessageEndpointBuilder & NotificationHandling ( FOnBusNotification&& InHandler
)

   MessageEndpointBuilder.h  
Configures the endpoint to receive messages on any thread. MessageEndpointBuilder.h  
Configured the endpoint to receive messages on a specific thread. MessageEndpointBuilder.h  

FMessageEndpointBuilder & ThatIsDisabled()

 Disables the endpoint. MessageEndpointBuilder.h  

FMessageEndpointBuilder & WithCatchall ( FFunctionMessageCatchall::FuncType HandlerFunc
)

 Adds a message handler for the given type of messages (via TFunction object). MessageEndpointBuilder.h  

FMessageEndpointBuilder & WithCatchall ( HandlerType* Handler,
typename TRawMessageCatchall< HandlerType >::FuncType HandlerFunc
)

 Adds a message handler for the given type of messages (via raw function pointers). MessageEndpointBuilder.h  

FMessageEndpointBuilder & WithHandler ( const TSharedRef< IMessageHandler, ESPMode::ThreadSafe >& Handler
)

 Registers a message handler with the endpoint. MessageEndpointBuilder.h  

FMessageEndpointBuilder & WithInbox()

 Enables the endpoint's message inbox.The inbox is disabled by default. MessageEndpointBuilder.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page