Navigation
Unreal Engine C++ API Reference > Runtime > Messaging
Inheritance Hierarchy
- IMessageReceiver
- FMessageEndpoint
References
| Module | Messaging |
| Header | /Engine/Source/Runtime/Messaging/Public/IMessageReceiver.h |
| Include | #include "IMessageReceiver.h" |
Syntax
class IMessageReceiver
Remarks
Interface for message recipients.
Classes that implement this interface are able to receive messages from a message bus. A message recipient will receive a call to its IMessageReceiver.ReceiveMessage method for each message that was sent directly to it (via IMessageBus.Send) and for each published message (via IMessageBus.Publish) that it subscribed to (via IMessageBus.Subscribe).
This interface provides a rather low-level mechanism for receiving messages. Instead of implementing it, Most users will want to use an instance of see FMessageEndpoint, which provides a much more convenient way of sending and receiving messages.
Destructors
| Type | Name | Description | |
|---|---|---|---|
  |
Virtual destructor. |
Functions
| Type | Name | Description | |
|---|---|---|---|
  |
FName | GetDebugName () |
Gets the recipient's name (for debugging purposes). |
  |
const FGuid & | Gets the recipient's unique identifier (for debugging purposes). | |
  |
ENamedThreads::Type | Gets the name of the thread on which to receive messages. | |
  |
bool | IsLocal () |
Checks whether this recipient represents a local endpoint. |
  |
bool | IsRemote () |
Checks whether this recipient represents a remote endpoint. |
 |
void | ReceiveMessage
(
const TSharedRef< IMessageContext, ESPMode::ThreadSafe >& Context |
Handles the given message. |