Urho3D::ClientReplicaClock Class Reference

#include <Urho3D/Replica/ClientReplica.h>

Inheritance diagram for Urho3D::ClientReplicaClock:

Public Member Functions
	ClientReplicaClock (Scene *scene, ReplicatedPeerWeakPtr connection, const MsgSceneClock &initialClock, const VariantMap &serverSettings)
NetworkTime	GetServerTime () const
	Return prediced exact server time.
NetworkTime	GetReplicaTime () const
float	GetReplicaTimeStep () const
NetworkTime	GetInputTime () const
float	GetInputTimeStep () const
bool	IsNewInputFrame () const
NetworkTime	GetLatestScaledInputTime () const
Scene *	GetScene () const
ReplicatedPeer *	GetConnection () const
unsigned	GetConnectionId () const
unsigned	GetUpdateFrequency () const
double	SecondsToFrames (double value) const
unsigned	GetInputDelay () const
const Variant &	GetSetting (const NetworkSetting &setting) const
Public Member Functions inherited from Urho3D::Object
	Object (Context *context)
	Construct.
	~Object () override
	Destruct. Clean up self from event sender & receiver structures.
virtual StringHash	GetType () const =0
virtual const ea::string &	GetTypeName () const =0
virtual const TypeInfo *	GetTypeInfo () const =0
	Return type info.
virtual bool	IsInstanceOf (StringHash type) const =0
	Check whether current instance implements specified type.
virtual void	OnEvent (Object *sender, StringHash eventType, VariantMap &eventData)
	Handle event.
virtual void	SerializeInBlock (Archive &archive)
	Serialize content from/to archive. May throw ArchiveException.
template<typename T>
bool	IsInstanceOf () const
	Check current instance is type of specified class.
template<typename T>
T *	Cast ()
	Cast the object to specified most derived class.
template<typename T>
const T *	Cast () const
	Cast the object to specified most derived class.
void	SubscribeToEventManual (StringHash eventType, EventHandler *handler)
	Subscribe to an event that can be sent by any sender.
void	SubscribeToEventManual (Object *sender, StringHash eventType, EventHandler *handler)
	Subscribe to a specific sender's event.
template<class T>
void	SubscribeToEvent (StringHash eventType, T handler)
	Subscribe to an event that can be sent by any sender.
template<class T>
void	SubscribeToEvent (Object *sender, StringHash eventType, T handler)
	Subscribe to a specific sender's event.
void	UnsubscribeFromEvent (StringHash eventType)
	Unsubscribe from an event.
void	UnsubscribeFromEvent (Object *sender, StringHash eventType)
	Unsubscribe from a specific sender's event.
void	UnsubscribeFromEvents (Object *sender)
	Unsubscribe from a specific sender's events.
void	UnsubscribeFromAllEvents ()
	Unsubscribe from all events.
void	UnsubscribeFromAllEventsExcept (const ea::vector< StringHash > &exceptions)
	Unsubscribe from all events except those listed.
void	UnsubscribeFromAllEventsExcept (const ea::vector< Object * > &exceptions)
	Unsubscribe from all events except those with listed senders.
void	SendEvent (StringHash eventType)
	Send event to all subscribers.
void	SendEvent (StringHash eventType, VariantMap &eventData)
	Send event with parameters to all subscribers.
VariantMap &	GetEventDataMap () const
	Return a preallocated map for event data. Used for optimization to avoid constant re-allocation of event data maps.
template<typename... Args>
void	SendEvent (StringHash eventType, const Args &... args)
	Send event with variadic parameter pairs to all subscribers. The parameters are (paramID, paramValue) pairs.
Context *	GetContext () const
	Return execution context.
const Variant &	GetGlobalVar (StringHash key) const
const VariantMap &	GetGlobalVars () const
void	SetGlobalVar (StringHash key, const Variant &value)
Object *	GetSubsystem (StringHash type) const
	Return subsystem by type.
Object *	GetEventSender () const
	Return active event sender. Null outside event handling.
EventHandler *	GetEventHandler () const
	Return active event handler. Null outside event handling.
bool	HasSubscribedToEvent (StringHash eventType) const
	Return whether has subscribed to an event without specific sender.
bool	HasSubscribedToEvent (Object *sender, StringHash eventType) const
	Return whether has subscribed to a specific sender's event.
bool	HasEventHandlers () const
	Return whether has subscribed to any event.
template<class T>
T *	GetSubsystem () const
	Template version of returning a subsystem.
const ea::string &	GetCategory () const
void	SendEvent (StringHash eventType, const VariantMap &eventData)
	Send event with parameters to all subscribers.
void	SetBlockEvents (bool block)
	Block object from sending and receiving events.
bool	GetBlockEvents () const
	Return sending and receiving events blocking status.
Public Member Functions inherited from Urho3D::RefCounted
	RefCounted ()
	Construct. Allocate the reference count structure and set an initial self weak reference.
virtual	~RefCounted ()
	Destruct. Mark as expired and also delete the reference count structure if no outside weak references exist.
	RefCounted (const RefCounted &rhs)=delete
	Prevent copy construction.
RefCounted &	operator= (const RefCounted &rhs)=delete
	Prevent assignment.
int	AddRef () const
int	ReleaseRef () const
int	Refs () const
int	WeakRefs () const
RefCount *	RefCountPtr () const
	Return pointer to the reference count structure.
bool	HasScriptObject () const
	Return true if script runtime object wrapping this native object exists.
bool	IsScriptStrongRef () const
	Return true if script reference is strong.

Protected Member Functions
void	UpdateClientClocks (float timeStep, const ea::vector< MsgSceneClock > &pendingClockUpdates)

Protected Attributes
const WeakPtr< Scene >	scene_
const ReplicatedPeerWeakPtr	peer_
Protected Attributes inherited from Urho3D::Object
WeakPtr< Context >	context_
	Execution context.

Private Member Functions
SoftNetworkTime	InitializeSoftTime () const
void	UpdateServerTime (const MsgSceneClock &msg, bool skipOutdated)
NetworkTime	ToReplicaTime (const NetworkTime &serverTime) const
NetworkTime	ToInputTime (const NetworkTime &serverTime) const

Private Attributes
const VariantMap	serverSettings_
const unsigned	thisConnectionId_ {}
const unsigned	updateFrequency_ {}
unsigned	inputDelay_ {}
NetworkTime	serverTime_
NetworkFrame	latestServerFrame_ {}
NetworkTime	latestScaledInputTime_ {}
bool	isNewInputFrame_ {}
SoftNetworkTime	replicaTime_
float	replicaTimeStep_ {}
SoftNetworkTime	inputTime_
float	inputTimeStep_ {}
SharedPtr< SceneUpdateSynchronizer >	updateSync_

Additional Inherited Members
Static Public Member Functions inherited from Urho3D::Object
static const TypeInfo *	GetTypeInfoStatic ()
	Return type info static.
Static Public Attributes inherited from Urho3D::Object
static constexpr ea::array< StringHash, 0 >	TypeHierarchy {}

Detailed Description

Maintains scene clocks of replica on the Client side. Note: it also keeps physical world synchronized.

Member Function Documentation

GetInputDelay()

unsigned Urho3D::ClientReplicaClock::GetInputDelay ( ) const

inline

Return dynamic properties of replica. Return values may vary over time.

GetInputTime()

NetworkTime Urho3D::ClientReplicaClock::GetInputTime ( ) const

inline

Return time at which ongoing client input will be processed on server. Input time is always ahead of server.

GetReplicaTime()

NetworkTime Urho3D::ClientReplicaClock::GetReplicaTime ( ) const

inline

Return replica interpolation time which is always behind server time. Scene is expected to be exactly replicated at replica time.

GetScene()

Scene * Urho3D::ClientReplicaClock::GetScene ( ) const

inline

Return constant properties of replica.

UpdateClientClocks()

void Urho3D::ClientReplicaClock::UpdateClientClocks ( float timeStep, const ea::vector< MsgSceneClock > & pendingClockUpdates )

protected

Apply elapsed timestep and accumulated clock updates. Returns possibly scaled (dilated or contracted) timestep.

---

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

• Urho3D/Replica/ClientReplica.h
• Urho3D/Replica/ClientReplica.cpp