Navigation
API > API/Runtime > API/Runtime/MessagingCommon > API/Runtime/MessagingCommon/FMessageEndpoint
Description
Receives a single message from the endpoint's inbox.
Note that an incoming message will only be queued up in the endpoint's inbox if the inbox has been enabled and no matching message handler handled it. The inbox is disabled by default and must be enabled using the EnableInbox() method.
| Name | ReceiveFromInbox |
| Type | function |
| Header File | /Engine/Source/Runtime/MessagingCommon/Public/MessageEndpoint.h |
| Include Path | #include "MessageEndpoint.h" |
bool ReceiveFromInbox
(
TSharedPtr < IMessageContext, ESPMode::ThreadSafe > & OutContext
)
true if a message was received, false if the inbox was empty.
Parameters
| Name | Remarks |
|---|---|
| OutContext | Will hold the context of the received message. |