ChannelTimeoutPolicy Class Reference

#include <policies.h>

List of all members.

Public Member Functions
bool	getSelfGoverningTimeout () const
void	setSelfGoverningTimeout (bool sgt)
double	getTimeout () const
double	getDefaultTimeout () const
double	getDeltaTimeout () const
unsigned short	getNtries () const
double	setTimeout (double t)
double	setDeltaTimeout (double dt)
unsigned short	setNtries (unsigned short nt)
double	setDefaultTimeout (double t)
double	setTimeoutToDefault ()
	ChannelTimeoutPolicy ()
Private Attributes
bool	selfGoverningTimeout
double	timeout
double	deltaTimeout
unsigned short	ntries
double	defaultTimeout

---

Detailed Description

Defines Timeout policy for channel access transactions and configures the number of transaction attempts in the event of an ECA_TIMEOUT error; deltaTimeout gives the increment in timeout for each additional attempt.

---

Constructor & Destructor Documentation

ChannelTimeoutPolicy::ChannelTimeoutPolicy

(

)

[inline]

---

Member Function Documentation

double ChannelTimeoutPolicy::getDefaultTimeout

(

)

const [inline]

References defaultTimeout.

double ChannelTimeoutPolicy::getDeltaTimeout

(

)

const [inline]

References deltaTimeout.

Referenced by Granules::channelExecuteGet(), Granules::channelExecuteGetCtrl(), Granules::channelExecutePut(), Instant< CTYPE >::getCache(), CAFE::getCache(), CAFE::getCtrlCache(), CAFE::groupGet(), CAFE::groupSet(), and Granules::waitForManyGetEvents().

unsigned short ChannelTimeoutPolicy::getNtries

(

)

const [inline]

References ntries.

Referenced by Granules::channelExecuteGet(), Granules::channelExecuteGetCtrl(), Granules::channelExecutePut(), Instant< CTYPE >::getCache(), CAFE::getCache(), CAFE::getCtrlCache(), CAFE::groupGet(), CAFE::groupSet(), and Granules::waitForManyGetEvents().

bool ChannelTimeoutPolicy::getSelfGoverningTimeout

(

)

const [inline]

References selfGoverningTimeout.

Referenced by Granules::channelExecuteGet(), Granules::channelExecuteGetCtrl(), Granules::channelExecutePut(), Instant< CTYPE >::getCache(), CAFE::getCache(), CAFE::getCtrlCache(), PolicyHelper::getSelfGoverningTimeout(), PolicyHelper::getSGSelfGoverningTimeout(), CAFE::groupGet(), and CAFE::groupSet().

double ChannelTimeoutPolicy::getTimeout

(

)

const [inline]

References timeout.

Referenced by Granules::channelExecuteGet(), Granules::channelExecuteGetCtrl(), Granules::channelExecutePut(), ConduitGroup::get(), Instant< CTYPE >::getCache(), CAFE::getCache(), CAFE::getCtrlCache(), PolicyHelper::getSGTimeout(), PolicyHelper::getSGTimeoutMax(), PolicyHelper::getSGTimeoutMin(), PolicyHelper::getTimeout(), PolicyHelper::getTimeoutMax(), PolicyHelper::getTimeoutMin(), CAFE::groupGet(), CAFE::groupSet(), PolicyHelper::printSGTimeout(), PolicyHelper::printTimeout(), ConduitGroup::put(), Granules::waitForManyGetEvents(), and CAFE::waitForPut().

double ChannelTimeoutPolicy::setDefaultTimeout

(

double

t

)

[inline]

References defaultTimeout.

Referenced by ConduitGroup::ConduitGroup(), and change_connectionHandlerArgs::operator()().

double ChannelTimeoutPolicy::setDeltaTimeout

(

double

dt

)

[inline]

References deltaTimeout, PEND_IO_INCREMENT_TIME_MAX, and PEND_IO_INCREMENT_TIME_MIN.

unsigned short ChannelTimeoutPolicy::setNtries

(

unsigned short

nt

)

[inline]

References ntries, and PEND_IO_MAX_TRIES.

void ChannelTimeoutPolicy::setSelfGoverningTimeout

(

bool

sgt

)

[inline]

References selfGoverningTimeout.

Referenced by Granules::channelExecuteGet(), Granules::channelExecuteGetCtrl(), Granules::channelExecutePut(), Instant< CTYPE >::getCache(), CAFE::getCache(), CAFE::groupGet(), CAFE::groupSet(), PolicyHelper::setSelfGoverningTimeout(), PolicyHelper::setSelfGoverningTimeoutGet(), PolicyHelper::setSelfGoverningTimeoutPut(), PolicyHelper::setSGSelfGoverningTimeout(), PolicyHelper::setSGSelfGoverningTimeoutGet(), PolicyHelper::setSGSelfGoverningTimeoutPut(), and Granules::waitForManyGetEvents().

double ChannelTimeoutPolicy::setTimeout

(

double

t

)

[inline]

References timeout, TIMEOUT_PEND_IO_MAX, and TIMEOUT_PEND_IO_MIN.

Referenced by Granules::channelExecuteGet(), Granules::channelExecuteGetCtrl(), Granules::channelExecutePut(), ConduitGroup::ConduitGroup(), Instant< CTYPE >::getCache(), CAFE::getCache(), CAFE::getCtrlCache(), CAFE::groupGet(), CAFE::groupSet(), change_connectionHandlerArgs::operator()(), PolicyHelper::setSGTimeout(), and PolicyHelper::setTimeout().

double ChannelTimeoutPolicy::setTimeoutToDefault

(

)

[inline]

References defaultTimeout, and timeout.

Referenced by PolicyHelper::setSGTimeoutToDefault(), and PolicyHelper::setTimeoutToDefault().

---

Member Data Documentation

double ChannelTimeoutPolicy::defaultTimeout [private]

Referenced by getDefaultTimeout(), setDefaultTimeout(), and setTimeoutToDefault().

double ChannelTimeoutPolicy::deltaTimeout [private]

Referenced by getDeltaTimeout(), and setDeltaTimeout().

unsigned short ChannelTimeoutPolicy::ntries [private]

Referenced by getNtries(), and setNtries().

bool ChannelTimeoutPolicy::selfGoverningTimeout [private]

Referenced by getSelfGoverningTimeout(), and setSelfGoverningTimeout().

double ChannelTimeoutPolicy::timeout [private]

Referenced by getTimeout(), setTimeout(), and setTimeoutToDefault().

---

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

• policies.h