1. Epic GamesDeveloper
  3. FAsyncMessageStore

FAsyncMessageStore

Implementation for the actual storage of async messages for different binding methods.

API > API/Plugins > API/Plugins/AsyncMessageSystem

Implementation for the actual storage of async messages for different binding methods.

This will store a message queue for each type of supports Binding option for listeners, allowing listeners to be in control over when they receive messages from the queue (what tick group, thread ID, etc).

   
Name FAsyncMessageStore
Type class
Header File /Engine/Plugins/Experimental/AsyncMessageSystem/Source/AsyncMessageSystem/Public/AsyncMessageStore.h
Include Path #include "AsyncMessageStore.h"

Syntax

class FAsyncMessageStore

Constructors

Name Remarks Include Path Unreal Specifiers
  AsyncMessageStore.h  
  AsyncMessageStore.h  
  AsyncMessageStore.h  

Destructors

Name Remarks Include Path Unreal Specifiers

~FAsyncMessageStore()

   AsyncMessageStore.h  

Structs

Name Remarks
FBindingOptionsMessageQueue The message queue for a single set of binding options.

Functions

Public

Name Remarks Include Path Unreal Specifiers

void AddMessageToBinding ( const FAsyncMessageId& MessageId,
const FAsyncMessageBindingOptions& Binding
)

   AsyncMessageStore.h  

void AddReferencedObjects ( FReferenceCollector& Collector
)

 Adds references to objects stored in the message queue to the GC collection This will include the FInstancedStruct payload data on the message queue to prevent objects from being destroyed if they are referenced in a message paylod. AsyncMessageStore.h  

uint32 EnqueueMessage ( FAsyncMessage&& MessageToQueue,
TArray< FAsyncMessageBindingOptions >& BindingTypesAddedTo
)

   AsyncMessageStore.h  

TOptional< FAsyncMessage > GetNextMessageForBindingOption ( const FAsyncMessageBindingOptions& Binding
)

   AsyncMessageStore.h  

bool RemoveMessageFromBinding ( const FAsyncMessageId& MessageId,
const FAsyncMessageBindingOptions& Binding
)

 Removes the given message ID from the specified message binding. AsyncMessageStore.h  

Protected

Name Remarks Include Path Unreal Specifiers
Creates and adds a debug messsage to the MessageDebugCallstacks map. AsyncMessageStore.h  

Operators

Name Remarks Include Path Unreal Specifiers
  AsyncMessageStore.h  
  AsyncMessageStore.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page