ChannelRequestPolicy Class Reference

#include <policies.h>

List of all members.

Public Member Functions
ChannelWhenToFlushSendBufferPolicyKind	getWhenToFlushSendBuffer () const
ChannelWaitForResponsePolicyKind	getWaitKind () const
ChannelRequestPolicyKind	getMethodKind () const
pCallback	getHandler () const
int	getCallbackStatus () const
void	setHandler (pCallback h)
void	setPyHandlerGet ()
void	setPyHandlerPut ()
void	setMethodKind (ChannelRequestPolicyKind m)
void	setWhenToFlushSendBuffer (ChannelWhenToFlushSendBufferPolicyKind w)
void	setWaitKind (ChannelWaitForResponsePolicyKind r)
void	setCallbackStatus (int cstatus)
void	setPolicy (ChannelWhenToFlushSendBufferPolicyKind w, ChannelWaitForResponsePolicyKind r, ChannelRequestPolicyKind m)
	ChannelRequestPolicy ()
	ChannelRequestPolicy (ChannelRequestPolicyKind b)
	ChannelRequestPolicy (pCallback h)
	~ChannelRequestPolicy ()
Private Attributes
ChannelWhenToFlushSendBufferPolicyKind	whenKind
ChannelWaitForResponsePolicyKind	waitKind
ChannelRequestPolicyKind	methodKind
pCallback	handler
int	callbackStatus

---

Detailed Description

Define Policy to get/set channels whether in blocking/non-blocking mode: Blocking can be achieved with or without callback

---

Constructor & Destructor Documentation

ChannelRequestPolicy::ChannelRequestPolicy

(

)

[inline]

References handler.

ChannelRequestPolicy::ChannelRequestPolicy

(

ChannelRequestPolicyKind

b

)

[inline]

References callbackStatus, CAFENUM::FLUSH_AFTER_EACH_MESSAGE, handler, ICAFE_NORMAL, methodKind, CAFENUM::WAIT, waitKind, whenKind, CAFENUM::WITH_CALLBACK_USER_SUPPLIED, and CAFENUM::WITHOUT_CALLBACK.

ChannelRequestPolicy::ChannelRequestPolicy

(

pCallback

h

)

[inline]

References callbackStatus, CAFENUM::FLUSH_AFTER_EACH_MESSAGE, handler, ICAFE_NORMAL, methodKind, CAFENUM::WAIT, waitKind, whenKind, and CAFENUM::WITH_CALLBACK_DEFAULT.

ChannelRequestPolicy::~ChannelRequestPolicy

(

)

[inline]

---

Member Function Documentation

int ChannelRequestPolicy::getCallbackStatus

(

)

const [inline]

References callbackStatus.

pCallback ChannelRequestPolicy::getHandler

(

)

const [inline]

References handler.

Referenced by Granules::channelExecuteGet(), Granules::channelExecuteGetCtrl(), Granules::channelExecuteGetCtrlNoWait(), Granules::channelExecuteGetNoWait(), Granules::channelExecutePut(), PolicyHelper::setChannelRequestPolicyGet(), and PolicyHelper::setChannelRequestPolicyPut().

ChannelRequestPolicyKind ChannelRequestPolicy::getMethodKind

(

)

const [inline]

References methodKind.

Referenced by Granules::channelExecuteGet(), Granules::channelExecuteGetCtrl(), Granules::channelExecuteGetCtrlNoWait(), Granules::channelExecuteGetNoWait(), Granules::channelExecutePut(), PolicyHelper::setChannelRequestPolicyGet(), and PolicyHelper::setChannelRequestPolicyPut().

ChannelWaitForResponsePolicyKind ChannelRequestPolicy::getWaitKind

(

)

const [inline]

References waitKind.

Referenced by Granules::channelExecutePut().

ChannelWhenToFlushSendBufferPolicyKind ChannelRequestPolicy::getWhenToFlushSendBuffer

(

)

const [inline]

References whenKind.

Referenced by Granules::channelExecutePut().

void ChannelRequestPolicy::setCallbackStatus

(

int

cstatus

)

[inline]

References callbackStatus.

Referenced by Granules::waitForManyGetEvents().

void ChannelRequestPolicy::setHandler

(

pCallback

h

)

[inline]

References handler, methodKind, and CAFENUM::WITH_CALLBACK_USER_SUPPLIED.

void ChannelRequestPolicy::setMethodKind

(

ChannelRequestPolicyKind

m

)

[inline]

References methodKind, CAFENUM::WITH_CALLBACK_USER_SUPPLIED, and CAFENUM::WITHOUT_CALLBACK.

Referenced by Instant< CTYPE >::setAndMatch(), Instant< CTYPE >::setAndMatchMany(), PolicyHelper::setChannelRequestPolicyGet(), and PolicyHelper::setChannelRequestPolicyPut().

void ChannelRequestPolicy::setPolicy	(	ChannelWhenToFlushSendBufferPolicyKind	w,
		ChannelWaitForResponsePolicyKind	r,
		ChannelRequestPolicyKind	m
	)			[inline]

References CAFENUM::FLUSH_AFTER_EACH_MESSAGE, CAFENUM::FLUSH_DESIGNATED_TO_CLIENT, methodKind, CAFENUM::NO_WAIT, CAFENUM::WAIT, waitKind, whenKind, CAFENUM::WITH_CALLBACK_USER_SUPPLIED, and CAFENUM::WITHOUT_CALLBACK.

Referenced by Conduit::Conduit().

void ChannelRequestPolicy::setPyHandlerGet

(

)

[inline]

References handler, methodKind, and CAFENUM::WITH_CALLBACK_USER_SUPPLIED.

void ChannelRequestPolicy::setPyHandlerPut

(

)

[inline]

References handler, methodKind, and CAFENUM::WITH_CALLBACK_USER_SUPPLIED.

void ChannelRequestPolicy::setWaitKind

(

ChannelWaitForResponsePolicyKind

r

)

[inline]

References CAFENUM::NO_WAIT, CAFENUM::WAIT, and waitKind.

Referenced by Instant< CTYPE >::set(), CAFE::set(), Instant< CTYPE >::setAndMatch(), and Instant< CTYPE >::setAndMatchMany().

void ChannelRequestPolicy::setWhenToFlushSendBuffer

(

ChannelWhenToFlushSendBufferPolicyKind

w

)

[inline]

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

Referenced by Instant< CTYPE >::set(), CAFE::set(), Instant< CTYPE >::setAndMatch(), and Instant< CTYPE >::setAndMatchMany().

---

Member Data Documentation

int ChannelRequestPolicy::callbackStatus [private]

Referenced by ChannelRequestPolicy(), getCallbackStatus(), and setCallbackStatus().

pCallback ChannelRequestPolicy::handler [private]

Referenced by ChannelRequestPolicy(), getHandler(), setHandler(), setPyHandlerGet(), and setPyHandlerPut().

ChannelRequestPolicyKind ChannelRequestPolicy::methodKind [private]

Referenced by ChannelRequestPolicy(), getMethodKind(), setHandler(), setMethodKind(), setPolicy(), setPyHandlerGet(), and setPyHandlerPut().

ChannelWaitForResponsePolicyKind ChannelRequestPolicy::waitKind [private]

Referenced by ChannelRequestPolicy(), getWaitKind(), setPolicy(), and setWaitKind().

ChannelWhenToFlushSendBufferPolicyKind ChannelRequestPolicy::whenKind [private]

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

---

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

• policies.h