UDocumentation
UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
IMessageBridge.h
Go to the documentation of this file.
1
// Copyright Epic Games, Inc. All Rights Reserved.
2
3
#pragma once
4
5
#include "
IMessageContext.h
"
6
7
/*
8
* Interface for message bridges.
9
*
10
* A message bridge connects a message bus with another messaging system. It is really just a regular
11
* message endpoint connected to a message bus that translates sent and received messages between the bus
12
* and some underlying transport technology. The transport technology is usually implemented in the form of a
13
* Message Transport Plug-in, such as the UdpMessaging plug-in that ships with Unreal Engine.
14
*
15
* The most common use case for message bridges is to connect two Unreal Engine message buses running in
16
* separate processes or en different computers. Another common use case is to connect an Unreal Engine
17
* message bus to an entirely different messaging system that is not based on Unreal Engine.
18
*
19
* Message bridge instances can be created with the IMessagingModule.CreateBridge method.
20
*/
21
class
IMessageBridge
22
{
23
public
:
24
33
virtual
void
Disable
() = 0;
34
43
virtual
void
Enable
() = 0;
44
51
virtual
bool
IsEnabled
()
const
= 0;
52
59
virtual
FGuid
LookupAddress
(
const
FMessageAddress
&
InAddress
) = 0;
60
61
public
:
62
64
virtual
~IMessageBridge
() { }
65
};
StaticCastSharedRef
UE_FORCEINLINE_HINT TSharedRef< CastToType, Mode > StaticCastSharedRef(TSharedRef< CastFromType, Mode > const &InSharedRef)
Definition
SharedPointer.h:127
IMessageContext.h
IMessageBridge
Definition
IMessageBridge.h:22
IMessageBridge::Enable
virtual void Enable()=0
IMessageBridge::IsEnabled
virtual bool IsEnabled() const =0
IMessageBridge::LookupAddress
virtual FGuid LookupAddress(const FMessageAddress &InAddress)=0
IMessageBridge::~IMessageBridge
virtual ~IMessageBridge()
Definition
IMessageBridge.h:64
IMessageBridge::Disable
virtual void Disable()=0
FGuid
Definition
Guid.h:109
FMessageAddress
Definition
IMessageContext.h:26
Engine
Source
Runtime
Messaging
Public
IMessageBridge.h
Generated by
1.9.8