ChannelOpenPolicy Class Reference

#include <policies.h>

List of all members.

Public Member Functions
	ChannelOpenPolicy ()
	ChannelOpenPolicy (ChannelFlushSendBufferPolicyKind f, ChannelWhenToFlushSendBufferPolicyKind w, double t)
	~ChannelOpenPolicy ()
void	flushSendBufferNow ()
ChannelFlushSendBufferPolicyKind	getFlushSendBufferKind () const
ChannelWhenToFlushSendBufferPolicyKind	getWhenToFlushSendBuffer () const
double	getTimeout () const
double	getDefaultTimeout () const
void	setFlushSendBufferKind (ChannelFlushSendBufferPolicyKind f)
void	setWhenToFlushSendBuffer (ChannelWhenToFlushSendBufferPolicyKind w)
double	setTimeout (double t)
double	setDefaultTimeout (double t)
double	setTimeoutToDefault ()
void	setPolicy (ChannelWhenToFlushSendBufferPolicyKind w, ChannelFlushSendBufferPolicyKind f, double t)
Private Attributes
ChannelWhenToFlushSendBufferPolicyKind	whenKind
ChannelFlushSendBufferPolicyKind	flushKind
double	timeout
double	defaultTimeout

---

Detailed Description

Define Policy to open/close/monitor channels one-by-one or to accumulate messages for later dispatch

---

Constructor & Destructor Documentation

ChannelOpenPolicy::ChannelOpenPolicy

(

)

[inline]

ChannelOpenPolicy::ChannelOpenPolicy	(	ChannelFlushSendBufferPolicyKind	f,
		ChannelWhenToFlushSendBufferPolicyKind	w,
		double	t
	)			[inline]

References DEFAULT_TIMEOUT_PEND_EVENT, CAFENUM::FLUSH_AFTER_EACH_CHANNEL_CREATION, CAFENUM::FLUSH_DESIGNATED_TO_CLIENT, setDefaultTimeout(), setFlushSendBufferKind(), setTimeout(), setWhenToFlushSendBuffer(), CAFENUM::WITH_PEND_EVENT, and CAFENUM::WITH_POLL.

ChannelOpenPolicy::~ChannelOpenPolicy

(

)

[inline]

---

Member Function Documentation

void ChannelOpenPolicy::flushSendBufferNow

(

)

[inline]

References CAFENUM::FLUSH_AFTER_EACH_CHANNEL_CREATION, flushKind, setWhenToFlushSendBuffer(), timeout, CAFENUM::WITH_FLUSH_IO, CAFENUM::WITH_PEND_EVENT, CAFENUM::WITH_PEND_IO, and CAFENUM::WITH_POLL.

Referenced by Connect::createChannel(), Connect::monitorStart(), Connect::monitorStop(), Connect::openGroupNowAndWait(), Connect::openMonitorNow(), Connect::openMonitorNowAndWait(), Connect::openNow(), and Connect::openNowAndWait().

double ChannelOpenPolicy::getDefaultTimeout

(

)

const [inline]

References defaultTimeout.

Referenced by Connect::getOpenDefaultPendTime().

ChannelFlushSendBufferPolicyKind ChannelOpenPolicy::getFlushSendBufferKind

(

)

const [inline]

References flushKind.

double ChannelOpenPolicy::getTimeout

(

)

const [inline]

References timeout.

Referenced by Connect::close(), Connect::closeChannels(), Connect::closeHandle(), Connect::closeHandles(), and Connect::monitorStop().

ChannelWhenToFlushSendBufferPolicyKind ChannelOpenPolicy::getWhenToFlushSendBuffer

(

)

const [inline]

References whenKind.

Referenced by Connect::createChannel(), Instant< CTYPE >::matchMany(), Connect::monitorStart(), Connect::monitorStop(), Instant< CTYPE >::setAndMatch(), and Instant< CTYPE >::setAndMatchMany().

double ChannelOpenPolicy::setDefaultTimeout

(

double

t

)

[inline]

References defaultTimeout.

Referenced by ChannelOpenPolicy(), and Connect::setOpenDefaultPendTime().

void ChannelOpenPolicy::setFlushSendBufferKind

(

ChannelFlushSendBufferPolicyKind

f

)

[inline]

References flushKind, CAFENUM::WITH_FLUSH_IO, and CAFENUM::WITH_POLL.

Referenced by ChannelOpenPolicy(), Connect::openGroupNowAndWait(), Connect::openGroupPrepare(), Connect::openMonitorNow(), Connect::openMonitorNowAndWait(), Connect::openMonitorPrepare(), Connect::openNow(), Connect::openNoWait(), Connect::openNowAndWait(), and Connect::openPrepare().

void ChannelOpenPolicy::setPolicy	(	ChannelWhenToFlushSendBufferPolicyKind	w,
		ChannelFlushSendBufferPolicyKind	f,
		double	t
	)			[inline]

References defaultTimeout, CAFENUM::FLUSH_AFTER_EACH_CHANNEL_CREATION, CAFENUM::FLUSH_DESIGNATED_TO_CLIENT, flushKind, timeout, whenKind, CAFENUM::WITH_FLUSH_IO, and CAFENUM::WITH_POLL.

Referenced by Connect::Connect().

double ChannelOpenPolicy::setTimeout

(

double

t

)

[inline]

References timeout.

Referenced by ChannelOpenPolicy(), Connect::openGroupNowAndWait(), Connect::openMonitorNowAndWait(), and Connect::openNowAndWait().

double ChannelOpenPolicy::setTimeoutToDefault

(

)

[inline]

References defaultTimeout, and timeout.

Referenced by Connect::openGroupNowAndWait(), and Connect::openNowAndWait().

void ChannelOpenPolicy::setWhenToFlushSendBuffer

(

ChannelWhenToFlushSendBufferPolicyKind

w

)

[inline]

References CAFENUM::FLUSH_AFTER_EACH_CHANNEL_CREATION, CAFENUM::FLUSH_DESIGNATED_TO_CLIENT, and whenKind.

Referenced by ChannelOpenPolicy(), flushSendBufferNow(), Instant< CTYPE >::matchMany(), Connect::monitorStart(), Connect::openGroupNowAndWait(), Connect::openGroupPrepare(), Connect::openMonitorNow(), Connect::openMonitorNowAndWait(), Connect::openMonitorPrepare(), Connect::openNow(), Connect::openNoWait(), Connect::openNowAndWait(), Connect::openPrepare(), Instant< CTYPE >::setAndMatch(), and Instant< CTYPE >::setAndMatchMany().

---

Member Data Documentation

double ChannelOpenPolicy::defaultTimeout [private]

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

ChannelFlushSendBufferPolicyKind ChannelOpenPolicy::flushKind [private]

Referenced by flushSendBufferNow(), getFlushSendBufferKind(), setFlushSendBufferKind(), and setPolicy().

double ChannelOpenPolicy::timeout [private]

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

ChannelWhenToFlushSendBufferPolicyKind ChannelOpenPolicy::whenKind [private]

Referenced by getWhenToFlushSendBuffer(), setPolicy(), and setWhenToFlushSendBuffer().

---

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

• policies.h