CAFENUM Namespace Reference

Enumerations
enum	DBR_TYPE {   DBR_PRIMITIVE, DBR_PLAIN = DBR_PRIMITIVE, DBR_STS, DBR_TIME,   DBR_GR, DBR_CTRL, DBR_PUT, DBR_STSACK,   DBR_CLASS, DBR_NONE }
enum	ChannelFlushSendBufferPolicyKind { WITH_FLUSH_IO, WITH_PEND_IO, WITH_PEND_EVENT, WITH_POLL }
enum	ChannelWhenToFlushSendBufferPolicyKind {   FLUSH_AUTOMATIC = 0, FLUSH_NOW = FLUSH_AUTOMATIC, FLUSH_AFTER_EACH_CHANNEL_CREATION = FLUSH_NOW, FLUSH_AFTER_EACH_CHANNEL_SUBSCRIPTION = FLUSH_NOW,   FLUSH_AFTER_EACH_MESSAGE = FLUSH_NOW, FLUSH_AFTER_EACH_GROUP_CREATION = FLUSH_NOW, FLUSH_DESIGNATED_TO_CLIENT }
enum	ChannelServerDispatchPriority {   CA_SERVER_DISPATCH_PRIORITY_MIN = CA_PRIORITY_MIN, CA_SERVER_DISPATCH_PRIORITY_VERYLOW = CA_PRIORITY_MIN+1, CA_SERVER_DISPATCH_PRIORITY_DEFAULT = CA_PRIORITY_MAX, CA_SERVER_DISPATCH_PRIORITY_LOW = CA_PRIORITY_MIN+25,   CA_SERVER_DISPATCH_PRIORITY_MED = CA_PRIORITY_MIN+50, CA_SERVER_DISPATCH_PRIORITY_HIGH = CA_PRIORITY_MIN+75, CA_SERVER_DISPATCH_PRIORITY_VERYHIGH = CA_PRIORITY_MIN+98, CA_SERVER_DISPATCH_PRIORITY_MAX = CA_PRIORITY_MAX }
enum	ChannelGetCacheWaitPolicyKind { GET_CACHE_NO_CHECK = 0, GET_CACHE_NO_WAIT, GET_CACHE_NOW = GET_CACHE_NO_WAIT, GET_CACHE_WAIT }
enum	ChannelGetActionWhenMonitorPolicyKind { GET_FROM_CACHE, GET_FROM_IOC }
enum	ChannelRequestPolicyKind { WITHOUT_CALLBACK, WITH_CALLBACK_DEFAULT, WITH_CALLBACK_USER_SUPPLIED }
enum	ChannelRequestDataTypePolicyKind { NATIVE_DATATYPE, LOWEST_DATATYPE }
enum	ChannelWaitForResponsePolicyKind { BLOCKING = 0, WAIT = BLOCKING, NON_BLOCKING = 1, NO_WAIT = NON_BLOCKING }
enum	StatusMessageKind {   NO_MESSAGE, PRE_REQUEST, FROM_REQUEST, FROM_PEND,   FROM_CALLBACK, FROM_MESSAGE }
enum	CallbackProgressKind { NOT_INITIATED, PENDING, COMPLETE }

---

Enumeration Type Documentation

enum CAFENUM::CallbackProgressKind

Enumerator:

NOT_INITIATED
PENDING
COMPLETE

enum CAFENUM::ChannelFlushSendBufferPolicyKind

Define enum type to flush io after creating channels

Enumerator:

WITH_FLUSH_IO
WITH_PEND_IO
WITH_PEND_EVENT
WITH_POLL

enum CAFENUM::ChannelGetActionWhenMonitorPolicyKind

Enum type defining the modes for get operations when a monitor is in place

Enumerator:

GET_FROM_CACHE
GET_FROM_IOC

enum CAFENUM::ChannelGetCacheWaitPolicyKind

Enum type defining the wait/nowait modes for cache operations. Meant for use within callbacks to ensure that cache operations are never blocked

Enumerator:

GET_CACHE_NO_CHECK
GET_CACHE_NO_WAIT
GET_CACHE_NOW
GET_CACHE_WAIT

enum CAFENUM::ChannelRequestDataTypePolicyKind

Enum type defining level of datatype conversion at the IOC

Enumerator:

NATIVE_DATATYPE
LOWEST_DATATYPE

enum CAFENUM::ChannelRequestPolicyKind

Enum type defining the blocking modes for ca operations. Blocking can be achieved with or without callback. Callback can further be supplied by the user

Enumerator:

WITHOUT_CALLBACK
WITH_CALLBACK_DEFAULT
WITH_CALLBACK_USER_SUPPLIED

enum CAFENUM::ChannelServerDispatchPriority

Enum type defining ca server dispatch priority Note that specifying different priorities within the same program can increase resource consumption in thw client and server because an independent virtual circuit, and associated data structures, is created for each priority that is used on a particular server

Enumerator:

CA_SERVER_DISPATCH_PRIORITY_MIN
CA_SERVER_DISPATCH_PRIORITY_VERYLOW
CA_SERVER_DISPATCH_PRIORITY_DEFAULT
CA_SERVER_DISPATCH_PRIORITY_LOW
CA_SERVER_DISPATCH_PRIORITY_MED
CA_SERVER_DISPATCH_PRIORITY_HIGH
CA_SERVER_DISPATCH_PRIORITY_VERYHIGH
CA_SERVER_DISPATCH_PRIORITY_MAX

enum CAFENUM::ChannelWaitForResponsePolicyKind

Enum type defining whether to wait for a response from a message sent with a callback, whether it be user supplied or the CAFE default.

Enumerator:

BLOCKING
WAIT
NON_BLOCKING
NO_WAIT

enum CAFENUM::ChannelWhenToFlushSendBufferPolicyKind

Define enum type defining when to flush io after creating channels

Enumerator:

FLUSH_AUTOMATIC
FLUSH_NOW
FLUSH_AFTER_EACH_CHANNEL_CREATION
FLUSH_AFTER_EACH_CHANNEL_SUBSCRIPTION
FLUSH_AFTER_EACH_MESSAGE
FLUSH_AFTER_EACH_GROUP_CREATION
FLUSH_DESIGNATED_TO_CLIENT

enum CAFENUM::DBR_TYPE

Data request buffer types
i.e. whether PRIMITIVE, STS, TIME, GR or CTRL

Enumerator:

DBR_PRIMITIVE
DBR_PLAIN
DBR_STS
DBR_TIME
DBR_GR
DBR_CTRL
DBR_PUT
DBR_STSACK
DBR_CLASS
DBR_NONE

enum CAFENUM::StatusMessageKind

Enumerator:

NO_MESSAGE
PRE_REQUEST
FROM_REQUEST
FROM_PEND
FROM_CALLBACK
FROM_MESSAGE