You've already forked UnrealEngineUWP
mirror of
https://github.com/izzy2lost/UnrealEngineUWP.git
synced 2026-03-26 18:15:20 -07:00
0f0464a30e
#rnx #rb none #ROBOMERGE-OWNER: ryan.durand #ROBOMERGE-AUTHOR: ryan.durand #ROBOMERGE-SOURCE: CL 10869210 via CL 10869511 via CL 10869900 #ROBOMERGE-BOT: (v613-10869866) [CL 10870549 by ryan durand in Main branch]
57 lines
1.7 KiB
C++
57 lines
1.7 KiB
C++
// Copyright Epic Games, Inc. All Rights Reserved.
|
|
|
|
#pragma once
|
|
|
|
|
|
/**
|
|
* Interface for message bridges.
|
|
*
|
|
* A message bridge connects a message bus with another messaging system. It is really just a regular
|
|
* message endpoint connected to a message bus that translates sent and received messages between the bus
|
|
* and some underlying transport technology. The transport technology is usually implemented in the form of a
|
|
* Message Transport Plug-in, such as the UdpMessaging plug-in that ships with Unreal Engine.
|
|
*
|
|
* The most common use case for message bridges is to connect two Unreal Engine message buses running in
|
|
* separate processes or en different computers. Another common use case is to connect an Unreal Engine
|
|
* message bus to an entirely different messaging system that is not based on Unreal Engine.
|
|
*
|
|
* Message bridge instances can be created with the IMessagingModule.CreateBridge method.
|
|
*/
|
|
class IMessageBridge
|
|
{
|
|
public:
|
|
|
|
/**
|
|
* Disables this bridge.
|
|
*
|
|
* A disabled bridge will not receive any subscribed messages until it is enabled again.
|
|
* Bridges should be created in a disabled state by default and explicitly enabled.
|
|
*
|
|
* @see Enable, IsEnabled
|
|
*/
|
|
virtual void Disable() = 0;
|
|
|
|
/**
|
|
* Enables this bridge.
|
|
*
|
|
* An activated bridge will receive subscribed messages.
|
|
* Bridges should be created in a disabled state by default and explicitly enabled.
|
|
*
|
|
* @see Disable, IsEnabled
|
|
*/
|
|
virtual void Enable() = 0;
|
|
|
|
/**
|
|
* Checks whether the bridge is currently enabled.
|
|
*
|
|
* @return true if the bridge is enabled, false otherwise.
|
|
* @see Disable, Enable
|
|
*/
|
|
virtual bool IsEnabled() const = 0;
|
|
|
|
public:
|
|
|
|
/** Virtual destructor. */
|
|
virtual ~IMessageBridge() { }
|
|
};
|