Navigation
API > API/Runtime > API/Runtime/MessagingCommon
Implements a message bridge builder.
| Name | FMessageBridgeBuilder |
| Type | class |
| Header File | /Engine/Source/Runtime/MessagingCommon/Public/MessageBridgeBuilder.h |
| Include Path | #include "MessageBridgeBuilder.h" |
Syntax
class FMessageBridgeBuilder
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
| Default constructor. | MessageBridgeBuilder.h | ||
FMessageBridgeBuilder
(
const TSharedRef< IMessageBus, ESPMode::ThreadSafe >& Bus |
Creates and initializes a new instance. | MessageBridgeBuilder.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| Address | FMessageAddress | Holds the bridge's address. | MessageBridgeBuilder.h | |
| BusPtr | TWeakPtr< IMessageBus, ESPMode::ThreadSafe > | Holds a weak pointer to the message bus to attach to. | MessageBridgeBuilder.h | |
| Disabled | bool | Holds a flag indicating whether the bridge should be disabled. | MessageBridgeBuilder.h | |
| Transport | TSharedPtr< IMessageTransport, ESPMode::ThreadSafe > | Holds a reference to the message transport technology. | MessageBridgeBuilder.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
TSharedPtr< IMessageBridge, ESPMode::ThreadSafe > Build() |
Builds the message bridge as configured. | MessageBridgeBuilder.h | |
FMessageBridgeBuilder & ThatIsDisabled() |
Disables the bridge. | MessageBridgeBuilder.h | |
FMessageBridgeBuilder & UsingTransport
(
const TSharedRef< IMessageTransport, ESPMode::ThreadSafe >& InTransport |
Configures the bridge to use a specific message transport technology. | MessageBridgeBuilder.h | |
FMessageBridgeBuilder & WithAddress
(
const FMessageAddress& InAddress |
Sets the bridge's address.If no address is specified, one will be generated automatically. | MessageBridgeBuilder.h |