GridMate::ReplicaMarshalTask Class Reference

#include <ReplicaMarshalTasks.h>

Inherits GridMate::ReplicaMarshalTaskBase.

Public Member Functions
	GM_CLASS_ALLOCATOR (ReplicaMarshalTask)
	ReplicaMarshalTask (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::ReplicaMarshalTaskBase
	ReplicaMarshalTaskBase (ReplicaPtr replica)
void	MarshalNewReplica (Replica *replica, ReservedIds cmdId, WriteBuffer &outBuffer)
PrepareDataResult	PrepareData (ReplicaPtr replica, EndianType endianType)
ReplicaPeer *	GetUpstreamHop ()
list< Internal::RpcRequest * > &	GetRPCQueue ()
virtual bool	CanUpstream () const
virtual void	ResetMarshalState ()
virtual void	OnSendReplicaBegin ()
virtual void	OnSendReplicaEnd (ReplicaPeer *to, const void *data, size_t len)
Protected Attributes inherited from GridMate::ReplicaTask
ReplicaPtr	m_replica

Detailed Description

Marshaling task. Initiates marshaling of a given replica to group of peers. Every time it's executed it requests marshaling targets for a replica and marshaling data to every peer. This task might be repeated through several ticks because of dataset updates.

Member Function Documentation

Run()

TaskStatus GridMate::ReplicaMarshalTask::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/ReplicaMarshalTasks.h