Each remote system is represented by Connection_RM3. Used to allocate Replica3 and track which instances have been allocated. More...

#include <ReplicaManager3.h>

Collaboration diagram for RakNet::Connection_RM3:

[legend]

List of all members.

Public Types
enum	ConstructionMode { QUERY_REPLICA_FOR_CONSTRUCTION, QUERY_REPLICA_FOR_CONSTRUCTION_AND_DESTRUCTION, QUERY_CONNECTION_FOR_REPLICA_LIST }
	List of enumerations for how to get the list of valid objects for other systems. More...
Public Member Functions
	Connection_RM3 (SystemAddress _systemAddress, RakNetGUID _guid)
virtual	~Connection_RM3 ()
virtual Replica3 *	AllocReplica (RakNet::BitStream allocationIdBitstream, ReplicaManager3 replicaManager3)=0
	Class factory to create a Replica3 instance, given a user-defined identifier.
virtual void	GetConstructedReplicas (DataStructures::Multilist< ML_STACK, Replica3 * > &objectsTheyDoHave)
	Get list of all replicas that are constructed for this connection.
bool	HasReplicaConstructed (RakNet::Replica3 *replica)
virtual void	SerializeOnDownloadStarted (RakNet::BitStream *bitStream)
virtual void	DeserializeOnDownloadStarted (RakNet::BitStream *bitStream)
virtual void	SerializeOnDownloadComplete (RakNet::BitStream *bitStream)
virtual void	DeserializeOnDownloadComplete (RakNet::BitStream *bitStream)
SystemAddress	GetSystemAddress (void) const
RakNetGUID	GetRakNetGUID (void) const
virtual ConstructionMode	QueryConstructionMode (void) const
	Queries how to get the list of objects that exist on remote systems.
virtual void	QueryReplicaList (DataStructures::Multilist< ML_STACK, Replica3 , Replica3 > newReplicasToCreate, DataStructures::Multilist< ML_STACK, Replica3 , Replica3 > existingReplicasToDestroy)
	Callback used when QueryConstructionMode() returns QUERY_CONNECTION_FOR_REPLICA_LIST.
virtual SendSerializeIfChangedResult	SendSerialize (RakNet::Replica3 replica, bool indicesToSend[RM3_NUM_OUTPUT_BITSTREAM_CHANNELS], RakNet::BitStream serializationData[RM3_NUM_OUTPUT_BITSTREAM_CHANNELS], RakNetTime timestamp, PRO sendParameters[RM3_NUM_OUTPUT_BITSTREAM_CHANNELS], RakPeerInterface rakPeer, unsigned char worldId)
virtual SendSerializeIfChangedResult	SendSerializeIfChanged (DataStructures::DefaultIndexType queryToSerializeIndex, SerializeParameters sp, RakPeerInterface rakPeer, unsigned char worldId, ReplicaManager3 *replicaManager)
virtual void	SendConstruction (DataStructures::Multilist< ML_STACK, Replica3 , Replica3 > &newObjects, DataStructures::Multilist< ML_STACK, Replica3 , Replica3 > &deletedObjects, PRO sendParameters, RakPeerInterface *rakPeer, unsigned char worldId)
void	CullUniqueNewAndDeletedObjects (DataStructures::Multilist< ML_STACK, Replica3 * > &newObjectsIn, DataStructures::Multilist< ML_STACK, Replica3 * > &deletedObjectsIn, DataStructures::Multilist< ML_STACK, Replica3 * > &newObjectsOut, DataStructures::Multilist< ML_STACK, Replica3 * > &deletedObjectsOut)
void	SendValidation (RakPeerInterface *rakPeer, unsigned char worldId)
void	AutoConstructByQuery (ReplicaManager3 *replicaManager3)
Public Attributes
bool	isValidated
bool	isFirstConstruction
Protected Member Functions
void	OnLocalReference (Replica3 replica3, ReplicaManager3 replicaManager)
void	OnDereference (Replica3 replica3, ReplicaManager3 replicaManager)
void	OnDownloadFromThisSystem (Replica3 replica3, ReplicaManager3 replicaManager)
void	OnDownloadFromOtherSystem (Replica3 replica3, ReplicaManager3 replicaManager)
void	OnNeverConstruct (DataStructures::DefaultIndexType queryToConstructIdx, ReplicaManager3 *replicaManager)
void	OnConstructToThisConnection (DataStructures::DefaultIndexType queryToConstructIdx, ReplicaManager3 *replicaManager)
void	OnConstructToThisConnection (Replica3 replica, ReplicaManager3 replicaManager)
void	OnNeverSerialize (DataStructures::DefaultIndexType queryToSerializeIndex, ReplicaManager3 *replicaManager)
void	OnReplicaAlreadyExists (DataStructures::DefaultIndexType queryToConstructIdx, ReplicaManager3 *replicaManager)
void	OnDownloadExisting (Replica3 replica3, ReplicaManager3 replicaManager)
void	OnSendDestructionFromQuery (DataStructures::DefaultIndexType queryToDestructIdx, ReplicaManager3 *replicaManager)
void	OnDoNotQueryDestruction (DataStructures::DefaultIndexType queryToDestructIdx, ReplicaManager3 *replicaManager)
void	ValidateLists (ReplicaManager3 *replicaManager) const
void	SendSerializeHeader (RakNet::Replica3 replica, RakNetTime timestamp, RakNet::BitStream bs, unsigned char worldId)
Protected Attributes
SystemAddress	systemAddress
RakNetGUID	guid
DataStructures::Multilist < ML_ORDERED_LIST, LastSerializationResult , Replica3 >	constructedReplicaList
DataStructures::Multilist < ML_STACK, LastSerializationResult , Replica3 >	queryToConstructReplicaList
DataStructures::Multilist < ML_STACK, LastSerializationResult , Replica3 >	queryToSerializeReplicaList
DataStructures::Multilist < ML_STACK, LastSerializationResult , Replica3 >	queryToDestructReplicaList
DataStructures::Multilist < ML_STACK, Replica3 , Replica3 >	constructedReplicasCulled
DataStructures::Multilist < ML_STACK, Replica3 , Replica3 >	destroyedReplicasCulled
Friends
class	ReplicaManager3

Detailed Description

Each remote system is represented by Connection_RM3. Used to allocate Replica3 and track which instances have been allocated.

Important function: AllocReplica() - must be overridden to create an object given an identifier for that object, which you define for all objects in your game

Definition at line 356 of file ReplicaManager3.h.

Member Enumeration Documentation

enum RakNet::Connection_RM3::ConstructionMode

List of enumerations for how to get the list of valid objects for other systems.

Enumerator:

QUERY_REPLICA_FOR_CONSTRUCTION	For every object that does not exist on the remote system, call Replica3::QueryConstruction() every tick. Do not call Replica3::QueryDestruction() Do not call Connection_RM3::QueryReplicaList()
QUERY_REPLICA_FOR_CONSTRUCTION_AND_DESTRUCTION	For every object that does not exist on the remote system, call Replica3::QueryConstruction() every tick. Based on the call, the object may be sent to the other system. For every object that does exist on the remote system, call Replica3::QueryDestruction() every tick. Based on the call, the object may be deleted on the other system. Do not call Connection_RM3::QueryReplicaList()
QUERY_CONNECTION_FOR_REPLICA_LIST	Do not call Replica3::QueryConstruction() or Replica3::QueryDestruction() Call Connection_RM3::QueryReplicaList() to determine which objects exist on remote systems This can be faster than QUERY_REPLICA_FOR_CONSTRUCTION and QUERY_REPLICA_FOR_CONSTRUCTION_AND_DESTRUCTION for large worlds See GridSectorizer.h under /Source for code that can help with this

Definition at line 407 of file ReplicaManager3.h.

Constructor & Destructor Documentation

Connection_RM3::Connection_RM3	(	SystemAddress	_systemAddress,
		RakNetGUID	_guid
	)

Definition at line 1172 of file ReplicaManager3.cpp.

Connection_RM3::~Connection_RM3 ( ) [virtual]

Definition at line 1181 of file ReplicaManager3.cpp.

Here is the call graph for this function:

Member Function Documentation

virtual Replica3* RakNet::Connection_RM3::AllocReplica	(	RakNet::BitStream *	allocationIdBitstream,
		ReplicaManager3 *	replicaManager3
	)			`[pure virtual]`

Class factory to create a Replica3 instance, given a user-defined identifier.

Identifier is returned by Replica3::WriteAllocationID() for what type of class to create.
This is called when you download a replica from another system.
See Replica3::Dealloc for the corresponding destruction message.
Return 0 if unable to create the intended object. Note, in that case the other system will still think we have the object and will try to serialize object updates to us. Generally, you should not send objects the other system cannot create.

See also:: Replica3::WriteAllocationID(). Sample implementation:
{RakNet::RakString typeName; allocationIdBitstream->Read(typeName); if (typeName=="Soldier") return new Soldier; return 0;}

Parameters:

`[in]`	allocationIdBitstream	user-defined bitstream uniquely identifying a game object type
`[in]`	replicaManager3	Instance of ReplicaManager3 that controls this connection

Returns:: The new replica instance

Here is the caller graph for this function:

void Connection_RM3::AutoConstructByQuery ( ReplicaManager3 * replicaManager3 )

Definition at line 502 of file ReplicaManager3.cpp.

Here is the call graph for this function:

void RakNet::Connection_RM3::CullUniqueNewAndDeletedObjects	(	DataStructures::Multilist< ML_STACK, Replica3 * > &	newObjectsIn,
		DataStructures::Multilist< ML_STACK, Replica3 * > &	deletedObjectsIn,
		DataStructures::Multilist< ML_STACK, Replica3 * > &	newObjectsOut,
		DataStructures::Multilist< ML_STACK, Replica3 * > &	deletedObjectsOut
	)

virtual void RakNet::Connection_RM3::DeserializeOnDownloadComplete ( RakNet::BitStream * bitStream ) [inline, virtual]

Receives whatever was written in DeserializeOnDownloadComplete()

Parameters:

[in] bitStream Written in SerializeOnDownloadComplete()

Definition at line 398 of file ReplicaManager3.h.

Here is the caller graph for this function:

virtual void RakNet::Connection_RM3::DeserializeOnDownloadStarted ( RakNet::BitStream * bitStream ) [inline, virtual]

Receives whatever was written in SerializeOnDownloadStarted()

Parameters:

[in] bitStream Written in SerializeOnDownloadStarted()

Definition at line 390 of file ReplicaManager3.h.

Here is the caller graph for this function:

void Connection_RM3::GetConstructedReplicas ( DataStructures::Multilist< ML_STACK, Replica3 * > & objectsTheyDoHave ) [virtual]

Get list of all replicas that are constructed for this connection.

Parameters:

[out] objectsTheyDoHave Destination list. Returned in sorted ascending order, sorted on the value of the Replica3 pointer.

Definition at line 1189 of file ReplicaManager3.cpp.

Here is the call graph for this function:

RakNetGUID RakNet::Connection_RM3::GetRakNetGUID ( void ) const [inline]

Returns:: Returns the RakNetGUID passed to the constructor of this object

Definition at line 404 of file ReplicaManager3.h.

Here is the caller graph for this function:

SystemAddress RakNet::Connection_RM3::GetSystemAddress ( void ) const [inline]

Returns:: The system address passed to the constructor of this object

Definition at line 401 of file ReplicaManager3.h.

Here is the caller graph for this function:

bool Connection_RM3::HasReplicaConstructed ( RakNet::Replica3 * replica )

Returns true if we think this remote connection has this replica constructed

Parameters:

[in] replica3 Which replica we are querying

Returns:: True if constructed, false othewise

Definition at line 1201 of file ReplicaManager3.cpp.

Here is the call graph for this function:

void Connection_RM3::OnConstructToThisConnection	(	DataStructures::DefaultIndexType	queryToConstructIdx,
		ReplicaManager3 *	replicaManager
	)			`[protected]`

Definition at line 1554 of file ReplicaManager3.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

void Connection_RM3::OnConstructToThisConnection	(	Replica3 *	replica,
		ReplicaManager3 *	replicaManager
	)			`[protected]`

Definition at line 1574 of file ReplicaManager3.cpp.

Here is the call graph for this function:

void Connection_RM3::OnDereference	(	Replica3 *	replica3,
		ReplicaManager3 *	replicaManager
	)			`[protected]`

Definition at line 1453 of file ReplicaManager3.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

void Connection_RM3::OnDoNotQueryDestruction	(	DataStructures::DefaultIndexType	queryToDestructIdx,
		ReplicaManager3 *	replicaManager
	)			`[protected]`

Definition at line 1657 of file ReplicaManager3.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

void Connection_RM3::OnDownloadExisting	(	Replica3 *	replica3,
		ReplicaManager3 *	replicaManager
	)			`[protected]`

Definition at line 1616 of file ReplicaManager3.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

void Connection_RM3::OnDownloadFromOtherSystem	(	Replica3 *	replica3,
		ReplicaManager3 *	replicaManager
	)			`[protected]`

Definition at line 1528 of file ReplicaManager3.cpp.

Here is the call graph for this function:

void Connection_RM3::OnDownloadFromThisSystem	(	Replica3 *	replica3,
		ReplicaManager3 *	replicaManager
	)			`[protected]`

Definition at line 1506 of file ReplicaManager3.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

void Connection_RM3::OnLocalReference	(	Replica3 *	replica3,
		ReplicaManager3 *	replicaManager
	)			`[protected]`

Definition at line 1440 of file ReplicaManager3.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

void Connection_RM3::OnNeverConstruct	(	DataStructures::DefaultIndexType	queryToConstructIdx,
		ReplicaManager3 *	replicaManager
	)			`[protected]`

Definition at line 1540 of file ReplicaManager3.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

void Connection_RM3::OnNeverSerialize	(	DataStructures::DefaultIndexType	queryToSerializeIndex,
		ReplicaManager3 *	replicaManager
	)			`[protected]`

Definition at line 1588 of file ReplicaManager3.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

void Connection_RM3::OnReplicaAlreadyExists	(	DataStructures::DefaultIndexType	queryToConstructIdx,
		ReplicaManager3 *	replicaManager
	)			`[protected]`

Definition at line 1597 of file ReplicaManager3.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

void Connection_RM3::OnSendDestructionFromQuery	(	DataStructures::DefaultIndexType	queryToDestructIdx,
		ReplicaManager3 *	replicaManager
	)			`[protected]`

Definition at line 1640 of file ReplicaManager3.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

virtual ConstructionMode RakNet::Connection_RM3::QueryConstructionMode ( void ) const [inline, virtual]

Queries how to get the list of objects that exist on remote systems.

The default of calling QueryConstruction for every known object is easy to use, but not efficient, especially for large worlds where many objects are outside of the player's circle of influence.
QueryDestruction is also not necessarily useful or efficient, as object destruction tends to happen in known cases, and can be accomplished by calling Replica3::BroadcastDestruction() QueryConstructionMode() allows you to specify more efficient algorithms than the default when overriden.

Returns:: How to get the list of objects that exist on the remote system. You should always return the same value for a given connection

Definition at line 431 of file ReplicaManager3.h.

Here is the caller graph for this function:

virtual void RakNet::Connection_RM3::QueryReplicaList	(	DataStructures::Multilist< ML_STACK, Replica3 , Replica3 >	newReplicasToCreate,
		DataStructures::Multilist< ML_STACK, Replica3 , Replica3 >	existingReplicasToDestroy
	)			`[inline, virtual]`

Callback used when QueryConstructionMode() returns QUERY_CONNECTION_FOR_REPLICA_LIST.

This advantage of this callback is if that there are many objects that a particular connection does not have, then we do not have to iterate through those objects calling QueryConstruction() for each of them.
BR> The following code uses a sorted merge sort to quickly find new and deleted objects, given a list of objects we know should exist.
BR> DataStructures::Multilist<ML_STACK, Replica3*, Replica3*> objectsTheyShouldHave; // You have to fill in this list
DataStructures::Multilist<ML_STACK, Replica3*, Replica3*> objectsTheyCurrentlyHave,objectsTheyStillHave,existingReplicasToDestro,newReplicasToCreatey;
GetConstructedReplicas(objectsTheyCurrentlyHave);
DataStructures::Multilist::FindIntersection(objectsTheyCurrentlyHave, objectsTheyShouldHave, objectsTheyStillHave, existingReplicasToDestroy, newReplicasToCreate);
BR> See GridSectorizer in the Source directory as a method to find all objects within a certain radius in a fast way.
BR>

Parameters:

`[out]`	newReplicasToCreate	Anything in this list will be created on the remote system
`[out]`	existingReplicasToDestroy	Anything in this list will be destroyed on the remote system

Definition at line 448 of file ReplicaManager3.h.

Here is the caller graph for this function:

void Connection_RM3::SendConstruction	(	DataStructures::Multilist< ML_STACK, Replica3 , Replica3 > &	newObjects,
		DataStructures::Multilist< ML_STACK, Replica3 , Replica3 > &	deletedObjects,
		PRO	sendParameters,
		RakPeerInterface *	rakPeer,
		unsigned char	worldId
	)			`[virtual]`

Definition at line 1788 of file ReplicaManager3.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

SendSerializeIfChangedResult Connection_RM3::SendSerialize	(	RakNet::Replica3 *	replica,
		bool	indicesToSend[RM3_NUM_OUTPUT_BITSTREAM_CHANNELS],
		RakNet::BitStream	serializationData[RM3_NUM_OUTPUT_BITSTREAM_CHANNELS],
		RakNetTime	timestamp,
		PRO	sendParameters[RM3_NUM_OUTPUT_BITSTREAM_CHANNELS],
		RakPeerInterface *	rakPeer,
		unsigned char	worldId
	)			`[virtual]`

Definition at line 1221 of file ReplicaManager3.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

void Connection_RM3::SendSerializeHeader	(	RakNet::Replica3 *	replica,
		RakNetTime	timestamp,
		RakNet::BitStream *	bs,
		unsigned char	worldId
	)			`[protected]`

Definition at line 1207 of file ReplicaManager3.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

SendSerializeIfChangedResult Connection_RM3::SendSerializeIfChanged	(	DataStructures::DefaultIndexType	queryToSerializeIndex,
		SerializeParameters *	sp,
		RakPeerInterface *	rakPeer,
		unsigned char	worldId,
		ReplicaManager3 *	replicaManager
	)			`[virtual]`