ZCom_ReplicatorSetup Class Reference

Inheritance diagram for ZCom_ReplicatorSetup:

[legend]List of all members.

---

Detailed Description

Base class for replicator parameters.

This class provides the base setup information for Zoidcom's data replication features. Replicator implementations can derive from it to add additional info, like e.g. extrapolation error treshold or whatever else is needed.

Only use this class to store sharable setup information. Don't store any data specific to single replication items, which has to be stored inside the ZCom_Replicator itself instead.

Public Member Functions
virtual ZCom_ReplicatorSetup *	Duplicate ()
	Create a duplication of this object.
zU8	getFlags () const
	Get the flags(ZCOM_REPFLAG_*).
zU8	getInterceptID () const
	Get the interceptor id.
zS16	getMaxDelay () const
	Get maximum delay.
zS16	getMinDelay () const
	Get minimum delay.
zU8	getRules () const
	Get the rules(ZCOM_REPRULE_*).
void	operator delete (void *_p)
	Overloaded memory operator ensuring that always Zoidcom's delete gets called.
void *	operator new (size_t _size)
	Overloaded memory operator ensuring that always Zoidcom's new gets called.
void	setInterceptID (zU8 _id)
	Set the intercept id.
void	setMaxDelay (zS16 _dly)
	Set maximum delay.
void	setMinDelay (zS16 _dly)
	Set minimum delay.
	ZCom_ReplicatorSetup (zU8 _flags, zU8 _rules, zU8 _intercept_id, zS16 _min_delay, zS16 _max_delay)
	constructor
	ZCom_ReplicatorSetup (zU8 _flags, zU8 _rules)
	constructor
virtual	~ZCom_ReplicatorSetup ()
	destructor
Protected Attributes
zU8	m_flags
zU8	m_intercept_id
	interceptor id, 0 = default
zS16	m_maxdelay
	Maximum delay between updates.
zS16	m_mindelay
	Minimum delay between updates.
zU8	m_rules

---

Constructor & Destructor Documentation

ZCom_ReplicatorSetup::ZCom_ReplicatorSetup (  zU8  _flags, zU8  _rules )

constructor

ZCom_ReplicatorSetup::ZCom_ReplicatorSetup (  zU8  _flags, zU8  _rules, zU8  _intercept_id, zS16  _min_delay, zS16  _max_delay )

constructor

virtual ZCom_ReplicatorSetup::~ZCom_ReplicatorSetup (   )  [virtual]

destructor

---

Member Function Documentation

virtual ZCom_ReplicatorSetup* ZCom_ReplicatorSetup::Duplicate (   )  [virtual]

Create a duplication of this object. Returns: Pointer to the setup object holding the duplicated parameters. If ZCOM_REPFLAG_SETUPPERSISTS is set in m_flags, Duplicate() has to simply return a pointer to itself instead of allocating a new object.

zU8 ZCom_ReplicatorSetup::getInterceptID (   )  const [inline]

Get the interceptor id. Returns: Interceptor id.

void ZCom_ReplicatorSetup::setInterceptID (  zU8  _id  )  [inline]

Set the intercept id. Parameters: _id  New intercept id. The interceptor id can be used to distinguish different replicators inside an interceptor callback.

zS16 ZCom_ReplicatorSetup::getMinDelay (   )  const [inline]

Get minimum delay. Returns: Minimum delay.

void ZCom_ReplicatorSetup::setMinDelay (  zS16  _dly  )  [inline]

Set minimum delay. Parameters: _dly  New minimum delay. Attention: It is not allowed to change these value from -1 to >= 0 once a replicator is actively using this setup. All other changes are allowed.

zS16 ZCom_ReplicatorSetup::getMaxDelay (   )  const [inline]

Get maximum delay. Returns: Maximum delay.

void ZCom_ReplicatorSetup::setMaxDelay (  zS16  _dly  )  [inline]

Set maximum delay. Parameters: _dly  New maximum delay. Attention: It is not allowed to change these value from -1 to >= 0 once a replicator is actively using this setup. All other changes are allowed.

zU8 ZCom_ReplicatorSetup::getRules (   )  const [inline]

Get the rules(ZCOM_REPRULE_*). Returns: Replication rules.

zU8 ZCom_ReplicatorSetup::getFlags (   )  const [inline]

Get the flags(ZCOM_REPFLAG_*). Returns: Replication flags.

void* ZCom_ReplicatorSetup::operator new (  size_t  _size  )

Overloaded memory operator ensuring that always Zoidcom's new gets called.

void ZCom_ReplicatorSetup::operator delete (  void *  _p  )

Overloaded memory operator ensuring that always Zoidcom's delete gets called.

---

Member Data Documentation

zU8 ZCom_ReplicatorSetup::m_flags [protected]

Holds replication flags (ZCOM_REPFLAG_*). Never ever modify these during operation.

zU8 ZCom_ReplicatorSetup::m_rules [protected]

Holds replication rules (ZCOM_REPRULE_*) Never ever modify these during operation.

zU8 ZCom_ReplicatorSetup::m_intercept_id [protected]

interceptor id, 0 = default

zS16 ZCom_ReplicatorSetup::m_mindelay [protected]

Minimum delay between updates. It is not allowed to change these value from -1 to >= 0 once a replicator is actively using this setup. All other changes are allowed.

zS16 ZCom_ReplicatorSetup::m_maxdelay [protected]

Maximum delay between updates. It is not allowed to change these value from -1 to >= 0 once a replicator is actively using this setup. All other changes are allowed.

---