Open 3D Engine GridMate API Reference  2205.0
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
Public Member Functions | List of all members
GridMate::ReplicaUpdateTask Class Reference

#include <ReplicaUpdateTasks.h>

Inherits GridMate::ReplicaUpdateTaskBase.

Public Member Functions

 ReplicaUpdateTask (ReplicaPtr replica)
 
TaskStatus Run (const RunContext &context) override
 
- Public Member Functions inherited from GridMate::ReplicaTask
void Cancel ()
 
bool IsCancelled () const
 
unsigned int GetAge () const
 
void SetAge (unsigned int age)
 
ReplicaPtr GetReplica () const
 
void SetPriority (PriorityType priority)
 
PriorityType GetPriority () const
 

Additional Inherited Members

- Public Types inherited from GridMate::ReplicaTask
enum  TaskStatus { Done, Repeat }
 
typedef AZ::u64 PriorityType
 
- Static Public Attributes inherited from GridMate::ReplicaTask
static const unsigned int k_ageScale = 10
 
- Protected Member Functions inherited from GridMate::ReplicaUpdateTaskBase
 ReplicaUpdateTaskBase (ReplicaPtr replica)
 
bool ProcessRPCs (const ReplicaContext &rc)
 
bool TryMigrate (ReplicaManager *rm, const ReplicaContext &rc)
 
void DestroyReplica (ReplicaManager *rm, const ReplicaContext &rc)
 
- Protected Attributes inherited from GridMate::ReplicaTask
ReplicaPtr m_replica
 

Detailed Description

Task to update primary & proxy replicas. Processes RPCs and calls replicas UpdateFromReplica. Will complete immediately if no RPCs left queued after processing, otherweise will be repeated next update tick. Initiates replica migration if proxy owner has died.

Member Function Documentation

◆ Run()

TaskStatus GridMate::ReplicaUpdateTask::Run ( const RunContext context)
overridevirtual

Called when task is executed

Parameters
contextexecution context, provides access to ReplicaManager and TaskManager
Returns
TaskStatus::Done if task is completed, TaskStatus::Repeat if task needs to be repeated next tick.

Implements GridMate::ReplicaTask.


The documentation for this class was generated from the following file: