Navigation
API > API/Plugins > API/Plugins/AsyncMessageSystem
The message binding endpoint is what stores the actual map of listeners and what Message Id's they are bound to.
When binding to a message or queueing a message for broadcast, you can specify the endpoint. Listeners will only receive the messages queued for their own endpoints. This makes it easy to filter messages to a specific endpoint.
These endpoints can be utilized within the game frame in a rather customizable way. One example would be to add create an Actor Component which has an endpoint. This way, you could send messages directly to a single specific actor.
| Name | FAsyncMessageBindingEndpoint |
| Type | class |
| Header File | /Engine/Plugins/Experimental/AsyncMessageSystem/Source/AsyncMessageSystem/Public/AsyncMessageBindingEndpoint.h |
| Include Path | #include "AsyncMessageBindingEndpoint.h" |
Syntax
class FAsyncMessageBindingEndpoint : public TSharedFromThis< FAsyncMessageBindingEndpoint >
Inheritance Hierarchy
- FSharedFromThisBase → TSharedFromThis → FAsyncMessageBindingEndpoint
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FAsyncMessageBindingEndpoint() |
AsyncMessageBindingEndpoint.h |
Structs
| Name | Remarks |
|---|---|
| FAsyncMessageBoundData | Data store for everything related to a single message |
| FAsyncMessageIndividualListener | Data stored about a single individual listener of a message |
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| FMessageCallbackFunc | TFunction< void(const FAsyncMessage &)> | AsyncMessageBindingEndpoint.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| BoundMessageListenerMap | TMap< FAsyncMessageId, FAsyncMessageBindingEndpoint::FAsyncMessageBoundData > | Map of message ID's to their associated message data. | AsyncMessageBindingEndpoint.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FAsyncMessageBoundData & FindOrAddMessageData
(
const FAsyncMessageId& MessageId |
Finds or adds a binding to the given message id. | AsyncMessageBindingEndpoint.h | |
FAsyncMessageBoundData * GetBoundDataForMessage
(
const FAsyncMessageId& MessageId |
Returns data about listeners bound to the given async message id. | AsyncMessageBindingEndpoint.h | |
uint32 GetNumberOfBoundListeners() |
AsyncMessageBindingEndpoint.h | ||
bool IsHandleBound
(
const FAsyncMessageHandle& Handle |
AsyncMessageBindingEndpoint.h |