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

#include <MessageBridgeBuilder.h>

Public Member Functions

 FMessageBridgeBuilder ()
 
 FMessageBridgeBuilder (const TSharedRef< IMessageBus, ESPMode::ThreadSafe > &Bus)
 
FMessageBridgeBuilderThatIsDisabled ()
 
FMessageBridgeBuilderUsingTransport (const TSharedRef< IMessageTransport, ESPMode::ThreadSafe > &InTransport)
 
FMessageBridgeBuilderWithAddress (const FMessageAddress &InAddress)
 
TSharedPtr< IMessageBridge, ESPMode::ThreadSafeBuild ()
 
 operator TSharedPtr< IMessageBridge, ESPMode::ThreadSafe > ()
 

Detailed Description

Implements a message bridge builder.

Constructor & Destructor Documentation

◆ FMessageBridgeBuilder() [1/2]

FMessageBridgeBuilder::FMessageBridgeBuilder ( )
inline

Default constructor.

◆ FMessageBridgeBuilder() [2/2]

FMessageBridgeBuilder::FMessageBridgeBuilder ( const TSharedRef< IMessageBus, ESPMode::ThreadSafe > &  Bus)
inline

Creates and initializes a new instance.

Parameters
InBusThe message bus to attach the bridge to.

Member Function Documentation

◆ Build()

TSharedPtr< IMessageBridge, ESPMode::ThreadSafe > FMessageBridgeBuilder::Build ( )
inline

Builds the message bridge as configured.

Returns
A new message bridge, or nullptr if it couldn't be built.

◆ operator TSharedPtr< IMessageBridge, ESPMode::ThreadSafe >()

FMessageBridgeBuilder::operator TSharedPtr< IMessageBridge, ESPMode::ThreadSafe > ( )
inline

Implicit conversion operator to build the message bridge as configured.

Returns
A new message bridge, or nullptr if it couldn't be built.

◆ ThatIsDisabled()

FMessageBridgeBuilder & FMessageBridgeBuilder::ThatIsDisabled ( )
inline

Disables the bridge.

Returns
This instance (for method chaining).

◆ UsingTransport()

FMessageBridgeBuilder & FMessageBridgeBuilder::UsingTransport ( const TSharedRef< IMessageTransport, ESPMode::ThreadSafe > &  InTransport)
inline

Configures the bridge to use a specific message transport technology.

Parameters
InTransportThe transport technology to use.
Returns
This instance (for method chaining).

◆ WithAddress()

FMessageBridgeBuilder & FMessageBridgeBuilder::WithAddress ( const FMessageAddress InAddress)
inline

Sets the bridge's address.

If no address is specified, one will be generated automatically.

Parameters
InAddressThe address to set.
Returns
This instance (for method chaining).

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