UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
UE::RemoteExecutor Namespace Reference

Functions

void RegisterRemoteSubsystem (FRemoteSubsystemBase *Subsystem)
 
void AbortTransactionRequiresDependencies (FStringView Description)
 
void RollbackTransactionRequiresDependencies (FStringView Description)
 
void AbortTransactionAndAbandonWork (FStringView Description)
 
void TransactionRequiresMultiServerCommit (FStringView Description)
 
void BeginRemoteMultiServerCommit (FRemoteServerId ServerId, FRemoteTransactionId RequestId, FRemoteWorkPriority RequestPriority)
 
void EndRemoteMultiServerCommit (FRemoteServerId ServerId, FRemoteTransactionId RequestId)
 
void AbandonRemoteMultiServerCommit (FRemoteServerId ServerId, FRemoteTransactionId RequestId)
 
void EnqueueRemoteMultiServerCommitAction (FRemoteServerId ServerId, FRemoteTransactionId RequestId, const TFunction< void()> &Action)
 
void ReadyMultiServerCommitResponse (FRemoteServerId ServerId, FRemoteTransactionId RequestId)
 
void AbortMultiServerCommit (FRemoteServerId ServerId, FRemoteTransactionId RequestId)
 
void ReadyRemoteMultiServerCommit (FRemoteServerId ServerId, FRemoteTransactionId RequestId)
 
FRemoteWorkPriority CreateRootWorkPriority ()
 
void ExecutePendingWork ()
 
void ExecuteTransactionalWithExplicitPriority (FName WorkName, FRemoteWorkPriority WorkPriority, const TFunctionRef< void(void)> &Work)
 
void ExecuteTransactional (FName WorkName, const TFunctionRef< void(void)> &Work)
 
void EnqueueWorkWithExplicitPriority (FName WorkName, FRemoteWorkPriority WorkPriority, bool bIsTransactional, const TFunction< void(void)> &InWork)
 
void EnqueueWork (FName WorkName, bool bIsTransactional, const TFunction< void(void)> &InWork)
 
COREUOBJECT_API void GlobalServerSync (FName SyncName)
 
COREUOBJECT_API void GlobalServerSyncAndReturnBorrowedObjects (FName SyncName)
 
COREUOBJECT_API void GlobalServerSyncAndRecomputeObjectOwners (FName SyncName)
 

Variables

TDelegate< void()> TickNetworkDelegate
 
TDelegate< void(FRemoteTransactionId, FRemoteWorkPriority, const TArray< FRemoteServerId > &)> BeginMultiServerCommitDelegate
 
TDelegate< void(FRemoteTransactionId, const TArray< FRemoteServerId > &)> ReadyMultiServerCommitDelegate
 
TDelegate< void(FRemoteTransactionId, const TArray< FRemoteServerId > &)> AbandonMultiServerCommitDelegate
 
TDelegate< void(FRemoteTransactionId, const TArray< FRemoteServerId > &)> EndMultiServerCommitDelegate
 
TDelegate< void(FRemoteTransactionId, FRemoteServerId)> ReadyRemoteMultiServerCommitDelegate
 
TDelegate< void(FRemoteTransactionId, FRemoteServerId)> AbortRemoteMultiServerCommitDelegate
 
TDelegate< TOptional< TTuple< FName, FRemoteWorkPriority, bool, TFunction< void(void)> > >(void)> FetchNextDeferredRPCDelegate
 
TMulticastDelegate< void(FRemoteTransactionId, FName)> OnTransactionQueuedDelegate
 
TMulticastDelegate< void(FRemoteTransactionId, FName)> OnTransactionStartingDelegate
 
TMulticastDelegate< void(FRemoteTransactionId, uint32)> OnTransactionCompletedDelegate
 
TMulticastDelegate< void(FRemoteTransactionId, uint32, const FString &)> OnTransactionAbortedDelegate
 
TMulticastDelegate< void(FRemoteTransactionId)> OnTransactionReleasedDelegate
 
TDelegate< void(FName)> OnRegionBeginDelegate
 
TDelegate< void(const FString &)> OnRegionEndDelegate
 

Function Documentation

◆ AbandonRemoteMultiServerCommit()

COREUOBJECT_API void UE::RemoteExecutor::AbandonRemoteMultiServerCommit ( FRemoteServerId  ServerId,
FRemoteTransactionId  RequestId 
)

◆ AbortMultiServerCommit()

COREUOBJECT_API void UE::RemoteExecutor::AbortMultiServerCommit ( FRemoteServerId  ServerId,
FRemoteTransactionId  RequestId 
)

◆ AbortTransactionAndAbandonWork()

COREUOBJECT_API void UE::RemoteExecutor::AbortTransactionAndAbandonWork ( FStringView  Description)

◆ AbortTransactionRequiresDependencies()

COREUOBJECT_API void UE::RemoteExecutor::AbortTransactionRequiresDependencies ( FStringView  Description)

◆ BeginRemoteMultiServerCommit()

COREUOBJECT_API void UE::RemoteExecutor::BeginRemoteMultiServerCommit ( FRemoteServerId  ServerId,
FRemoteTransactionId  RequestId,
FRemoteWorkPriority  RequestPriority 
)

◆ CreateRootWorkPriority()

COREUOBJECT_API FRemoteWorkPriority UE::RemoteExecutor::CreateRootWorkPriority ( )

◆ EndRemoteMultiServerCommit()

COREUOBJECT_API void UE::RemoteExecutor::EndRemoteMultiServerCommit ( FRemoteServerId  ServerId,
FRemoteTransactionId  RequestId 
)

◆ EnqueueRemoteMultiServerCommitAction()

COREUOBJECT_API void UE::RemoteExecutor::EnqueueRemoteMultiServerCommitAction ( FRemoteServerId  ServerId,
FRemoteTransactionId  RequestId,
const TFunction< void()> &  Action 
)

◆ EnqueueWork()

COREUOBJECT_API void UE::RemoteExecutor::EnqueueWork ( FName  WorkName,
bool  bIsTransactional,
const TFunction< void(void)> &  InWork 
)

◆ EnqueueWorkWithExplicitPriority()

COREUOBJECT_API void UE::RemoteExecutor::EnqueueWorkWithExplicitPriority ( FName  WorkName,
FRemoteWorkPriority  WorkPriority,
bool  bIsTransactional,
const TFunction< void(void)> &  InWork 
)

◆ ExecutePendingWork()

COREUOBJECT_API void UE::RemoteExecutor::ExecutePendingWork ( )

◆ ExecuteTransactional()

COREUOBJECT_API void UE::RemoteExecutor::ExecuteTransactional ( FName  WorkName,
const TFunctionRef< void(void)> &  Work 
)

◆ ExecuteTransactionalWithExplicitPriority()

COREUOBJECT_API void UE::RemoteExecutor::ExecuteTransactionalWithExplicitPriority ( FName  WorkName,
FRemoteWorkPriority  WorkPriority,
const TFunctionRef< void(void)> &  Work 
)

◆ GlobalServerSync()

COREUOBJECT_API void UE::RemoteExecutor::GlobalServerSync ( FName  SyncName)

Establishes a synchronization barrier across all servers

◆ GlobalServerSyncAndRecomputeObjectOwners()

COREUOBJECT_API void UE::RemoteExecutor::GlobalServerSyncAndRecomputeObjectOwners ( FName  SyncName)

◆ GlobalServerSyncAndReturnBorrowedObjects()

COREUOBJECT_API void UE::RemoteExecutor::GlobalServerSyncAndReturnBorrowedObjects ( FName  SyncName)

◆ ReadyMultiServerCommitResponse()

COREUOBJECT_API void UE::RemoteExecutor::ReadyMultiServerCommitResponse ( FRemoteServerId  ServerId,
FRemoteTransactionId  RequestId 
)

◆ ReadyRemoteMultiServerCommit()

COREUOBJECT_API void UE::RemoteExecutor::ReadyRemoteMultiServerCommit ( FRemoteServerId  ServerId,
FRemoteTransactionId  RequestId 
)

◆ RegisterRemoteSubsystem()

COREUOBJECT_API void UE::RemoteExecutor::RegisterRemoteSubsystem ( FRemoteSubsystemBase Subsystem)

◆ RollbackTransactionRequiresDependencies()

COREUOBJECT_API void UE::RemoteExecutor::RollbackTransactionRequiresDependencies ( FStringView  Description)

◆ TransactionRequiresMultiServerCommit()

COREUOBJECT_API void UE::RemoteExecutor::TransactionRequiresMultiServerCommit ( FStringView  Description)

Variable Documentation

◆ AbandonMultiServerCommitDelegate

COREUOBJECT_API TDelegate< void(FRemoteTransactionId, const TArray< FRemoteServerId > &)> UE::RemoteExecutor::AbandonMultiServerCommitDelegate

◆ AbortRemoteMultiServerCommitDelegate

COREUOBJECT_API TDelegate< void(FRemoteTransactionId, FRemoteServerId)> UE::RemoteExecutor::AbortRemoteMultiServerCommitDelegate

◆ BeginMultiServerCommitDelegate

COREUOBJECT_API TDelegate< void(FRemoteTransactionId, FRemoteWorkPriority, const TArray< FRemoteServerId > &)> UE::RemoteExecutor::BeginMultiServerCommitDelegate

◆ EndMultiServerCommitDelegate

COREUOBJECT_API TDelegate< void(FRemoteTransactionId, const TArray< FRemoteServerId > &)> UE::RemoteExecutor::EndMultiServerCommitDelegate

◆ FetchNextDeferredRPCDelegate

COREUOBJECT_API TDelegate< TOptional< TTuple< FName, FRemoteWorkPriority, bool, TFunction< void(void)> > >(void)> UE::RemoteExecutor::FetchNextDeferredRPCDelegate

Fetch the next deferred RPC request

◆ OnRegionBeginDelegate

COREUOBJECT_API TDelegate< void(FName)> UE::RemoteExecutor::OnRegionBeginDelegate

◆ OnRegionEndDelegate

COREUOBJECT_API TDelegate< void(const FString &)> UE::RemoteExecutor::OnRegionEndDelegate

◆ OnTransactionAbortedDelegate

COREUOBJECT_API TMulticastDelegate< void(FRemoteTransactionId, uint32, const FString &)> UE::RemoteExecutor::OnTransactionAbortedDelegate

Delegate executed when a ExecuteTransactional observes an aborted AutoRTFM transaction

◆ OnTransactionCompletedDelegate

COREUOBJECT_API TMulticastDelegate< void(FRemoteTransactionId, uint32)> UE::RemoteExecutor::OnTransactionCompletedDelegate

Delegate executed when a ExecuteTransactional observes a completed AutoRTFM transaction

◆ OnTransactionQueuedDelegate

COREUOBJECT_API TMulticastDelegate< void(FRemoteTransactionId, FName)> UE::RemoteExecutor::OnTransactionQueuedDelegate

Delegate executed when a transaction is queued in the executor for execution

◆ OnTransactionReleasedDelegate

COREUOBJECT_API TMulticastDelegate< void(FRemoteTransactionId)> UE::RemoteExecutor::OnTransactionReleasedDelegate

Delegate executed when a transaction is released (execution is finished and the work is removed from the executor)

◆ OnTransactionStartingDelegate

COREUOBJECT_API TMulticastDelegate< void(FRemoteTransactionId, FName)> UE::RemoteExecutor::OnTransactionStartingDelegate

Delegate executed when a ExecuteTransactional starts an AutoRTFM transaction

◆ ReadyMultiServerCommitDelegate

COREUOBJECT_API TDelegate< void(FRemoteTransactionId, const TArray< FRemoteServerId > &)> UE::RemoteExecutor::ReadyMultiServerCommitDelegate

◆ ReadyRemoteMultiServerCommitDelegate

COREUOBJECT_API TDelegate< void(FRemoteTransactionId, FRemoteServerId)> UE::RemoteExecutor::ReadyRemoteMultiServerCommitDelegate

◆ TickNetworkDelegate

COREUOBJECT_API TDelegate< void()> UE::RemoteExecutor::TickNetworkDelegate

Delegate that pumps the network and executes RPC handlers