ZCom_RSetupString Class Reference

Inheritance diagram for ZCom_RSetupString:

[legend]Collaboration diagram for ZCom_RSetupString:

[legend]List of all members.

---

Detailed Description

Parameter class for string replicators.

Public Member Functions
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_RSetupString (zU16 _maxlen, zU8 _flags, zU8 _rules, zU8 _intercept_id=0, zS16 _mindelay=-1, zS16 _maxdelay=-1)
	constructor
Public Attributes
zU16	maxlen
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_RSetupString::ZCom_RSetupString (  zU16  _maxlen, zU8  _flags, zU8  _rules, zU8  _intercept_id = 0, zS16  _mindelay = -1, zS16  _maxdelay = -1 )  [inline]

constructor

---

Member Function Documentation

zU8 ZCom_ReplicatorSetup::getInterceptID (   )  const [inline, inherited]

Get the interceptor id. Returns: Interceptor id.

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

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, inherited]

Get minimum delay. Returns: Minimum delay.

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

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, inherited]

Get maximum delay. Returns: Maximum delay.

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

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, inherited]

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

zU8 ZCom_ReplicatorSetup::getFlags (   )  const [inline, inherited]

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

void* ZCom_ReplicatorSetup::operator new (  size_t  _size  )  [inherited]

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

void ZCom_ReplicatorSetup::operator delete (  void *  _p  )  [inherited]

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

---

Member Data Documentation

zU16 ZCom_RSetupString::maxlen

Maximum length of the string. A compare buffer of that size will be allocated by the replicator.

zU8 ZCom_ReplicatorSetup::m_flags [protected, inherited]

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

zU8 ZCom_ReplicatorSetup::m_rules [protected, inherited]

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

zU8 ZCom_ReplicatorSetup::m_intercept_id [protected, inherited]

interceptor id, 0 = default

zS16 ZCom_ReplicatorSetup::m_mindelay [protected, inherited]

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, inherited]

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.

---