1. Epic GamesDeveloper
  3. FAsyncMessageBindingOptions

FAsyncMessageBindingOptions

Options used to specify when a binder would like to receive a message when it is broadcast.

API > API/Plugins > API/Plugins/AsyncMessageSystem

Options used to specify when a binder would like to receive a message when it is broadcast.

If you would like your listener to receive its messages within a specific tick group on the game thread, create the options with a TickGroup and it will set UseTickGroup.

If you would like your listener to receive its messages within a specific named thread and/or pool of named threads create the options with a named thread (including advanced variants) and it will set UseNamedThreads.

If you would like your listener to receive its messages from within a specifc set of UE::Tasks priority thread pools create the options with a task priority and extended priority and it will set UseTaskPriorities.

   
Name FAsyncMessageBindingOptions
Type struct
Header File /Engine/Plugins/Experimental/AsyncMessageSystem/Source/AsyncMessageSystem/Public/AsyncMessageBindingOptions.h
Include Path #include "AsyncMessageBindingOptions.h"

Syntax

struct FAsyncMessageBindingOptions

Constructors

Name Remarks Include Path Unreal Specifiers
  AsyncMessageBindingOptions.h  

FAsyncMessageBindingOptions ( const ETickingGroup DesiredTickGroup
)

   AsyncMessageBindingOptions.h  
  AsyncMessageBindingOptions.h  

FAsyncMessageBindingOptions ( const UE::Tasks::ETaskPriority InTaskPriority,
const UE::Tasks::EExtendedTaskPriority InExtendedTaskPriority
)

   AsyncMessageBindingOptions.h  

Enums

Public

Name Remarks
EBindingType Determines which type of configuration this listener follows

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
ExtendedTaskPriority UE::Tasks::EExtendedTaskPriority Identifies the UE::Tasks extended priority which this binding would like to receive a callback on AsyncMessageBindingOptions.h  
TaskPriority UE::Tasks::ETaskPriority Identifies the UE::Tasks task priority which this binding would like to receive a callback on AsyncMessageBindingOptions.h  
ThreadOrGroup int32 Based on type, this identifies the thread identifier in which the binding object would like to receive a callback, or the tick group on game thread AsyncMessageBindingOptions.h  

Protected

Name Type Remarks Include Path Unreal Specifiers
FAsyncMessageBindingOptions union FAsyncMessageBindingOptions   AsyncMessageBindingOptions.h  
Type EBindingType The type of binding options which should be used to determine where a listener would like to receive its messages. AsyncMessageBindingOptions.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

UE::Tasks::EExtendedTaskPriority GetExtendedTaskPriority()

 If type is UseTaskPriorities, this will be used to determine the extended task priority you would like to use AsyncMessageBindingOptions.h  

ENamedThreads::Type GetNamedThreads()

 If type is UseNamedThreads, this will be used to determine which set of named threads you would like to use AsyncMessageBindingOptions.h  

UE::Tasks::ETaskPriority GetTaskPriority()

 If type is UseTaskPriorities, this will be used to determine the task priority you would like to use AsyncMessageBindingOptions.h  

ETickingGroup GetTickGroup()

 If type is UseTickGroup, this binding will receive a message on the main game thread during the specific tick group AsyncMessageBindingOptions.h  

EBindingType GetType()

 Determines which type of configuration this listener follows AsyncMessageBindingOptions.h  

void SetNamedThreads ( const ENamedThreads::Type NamedThreads
)

 Set this binding to receive a message on a set of named threads AsyncMessageBindingOptions.h  

void SetTaskPriorities ( const UE::Tasks::ETaskPriority InTaskPriority,
const UE::Tasks::EExtendedTaskPriority InExtendedTaskPriority
)

 Set this binding to receive a message on a thread with the matching task priority and extended priority AsyncMessageBindingOptions.h  

void SetTickGroup ( const ETickingGroup DesiredTickGroup
)

 Set this binding to receive a message on the main game thread during the specific tick group AsyncMessageBindingOptions.h  

Operators

Name Remarks Include Path Unreal Specifiers

bool operator!= ( const FAsyncMessageBindingOptions& Other
) const

   AsyncMessageBindingOptions.h  

bool operator== ( const FAsyncMessageBindingOptions& Other
) const

   AsyncMessageBindingOptions.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page