Navigation
API > API/Plugins > API/Plugins/AsyncMessageSystem
Handle used to identify a bound listener to an Async Message. These handles are unique to each bound listener and created by the owning FAsyncMessageSystemBase that the Message was bound to.
| Name | FAsyncMessageHandle |
| Type | struct |
| Header File | /Engine/Plugins/Experimental/AsyncMessageSystem/Source/AsyncMessageSystem/Public/AsyncMessageHandle.h |
| Include Path | #include "AsyncMessageHandle.h" |
Syntax
USTRUCT (BlueprintType )
struct FAsyncMessageHandle
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
| Default constructor of a Message handle. | AsyncMessageHandle.h | ||
FAsyncMessageHandle
(
const uint32 InHandleValue, |
Private constructor for use by the message system | AsyncMessageHandle.h |
Constants
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| Invalid | const FAsyncMessageHandle | Represents an invalid handle which cannot have any Message listeners bound to it and means that no more Messages will be received. | AsyncMessageHandle.h |
| InvalidHandleIndex | uint32 | Internal index for message handles which we consider to be invalid. | AsyncMessageHandle.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| BindingEndpoint | TWeakPtr< FAsyncMessageBindingEndpoint > | The endpoint which this handle is bound to. | AsyncMessageHandle.h | |
| BoundMessage | FAsyncMessageId | The async message that this handle is bound to. | AsyncMessageHandle.h |
|
| InternalHandle | uint32 | The value of this internal handle. | AsyncMessageHandle.h |
|
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
TSharedPtr< FAsyncMessageBindingEndpoint > GetBindingEndpoint() |
AsyncMessageHandle.h | ||
FAsyncMessageId GetBoundMessageId() |
Returns the Message in which this handle is bound to. | AsyncMessageHandle.h | |
uint32 GetId() |
Returns the internal ID of this handle. | AsyncMessageHandle.h | |
bool IsValid() |
Returns true if this Message handle has a valid internal ID. | AsyncMessageHandle.h | |
FString ToString() |
Returns a formatted string which represents this handle's data. | AsyncMessageHandle.h |
Operators
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
bool operator!=
(
const FAsyncMessageHandle& Other |
AsyncMessageHandle.h | ||
bool operator==
(
const FAsyncMessageHandle& Other |
AsyncMessageHandle.h | ||
bool operator>=
(
const FAsyncMessageHandle& Other |
AsyncMessageHandle.h |