GridMate::ReplicaDestroyPeerTask Class Reference

#include <ReplicaUpdateTasks.h>

Inherits GridMate::ReplicaTask.

Public Member Functions
	ReplicaDestroyPeerTask (ReplicaPeer *peer)
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 Attributes inherited from GridMate::ReplicaTask
ReplicaPtr	m_replica

Detailed Description

Task to destroy peer. Deletes peer object. Calling DiscardOrphans on other peers. Should only be performed after migration and pending reports has processed to guarantee that peer's replicas are in a latest state and have transefered ownership.

Member Function Documentation

Run()

TaskStatus GridMate::ReplicaDestroyPeerTask::Run ( const RunContext &  context )

overridevirtual

Called when task is executed

Parameters

context

execution 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:

• Code/Framework/GridMate/GridMate/Replica/Tasks/ReplicaUpdateTasks.h