RKH
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
Related to event queue module

Configuration options related to queue facility (RQ) More...

Macros

#define RKH_CFG_RQ_EN   RKH_ENABLED
 If the RKH_CFG_RQ_EN is set to 1 then RKH will include the native queue facility. More...
 
#define RKH_CFG_RQ_SIZEOF_NELEM   8u
 Specify the maximum number of elements that any queue can contain. The valid values [in bits] are 8, 16 or 32. Default is 8. See RKH_RQNE_T type. More...
 
#define RKH_CFG_RQ_GET_LWMARK_EN   RKH_ENABLED
 If the RKH_CFG_RQ_GET_LWMARK_EN is set to 1 then RKH allows to known the minimum number of free elements ever in the queue (low-watermark ). This provides valuable empirical data for proper sizing of the queue. See rkh_rq_get_lwm() function. More...
 
#define RKH_CFG_RQ_GET_INFO_EN   RKH_ENABLED
 If the RKH_CFG_RQ_GET_INFO_EN is set to 1 then RKH allows to collect and retrives performance information for a particular queue. See rkh_rq_get_info() and rkh_rq_clear_info() functions. More...
 
#define RKH_CFG_RQ_READ_EN   RKH_ENABLED
 If the RKH_CFG_RQ_READ_EN is set to 1 then RKH will include the rkh_rq_read() function that allows read an element from a queue without remove it. See rkh_rq_read() function. More...
 
#define RKH_CFG_RQ_DEPLETE_EN   RKH_ENABLED
 If the RKH_CFG_RQ_DEPLETE_EN is set to 1 then RKH will include the rkh_rq_deplete() function that empties the contents of the queue and eliminates all stored elements. See rkh_rq_deplete() function. More...
 
#define RKH_CFG_RQ_IS_FULL_EN   RKH_ENABLED
 If the RKH_CFG_RQ_IS_FULL_EN is set to 1 then RKH will include the rkh_rq_is_full() function that allows to known if a queue is full. See rkh_rq_is_full() function. More...
 
#define RKH_CFG_RQ_GET_NELEMS_EN   RKH_ENABLED
 If the RKH_CFG_RQ_GET_NELEMS_EN is set to 1 then RKH will include the rkh_rq_get_num() function that returns the number of elements currently in the queue. See rkh_rq_get_num() function. More...
 
#define RKH_CFG_RQ_PUT_LIFO_EN   RKH_ENABLED
 If the RKH_CFG_RQ_PUT_LIFO_EN is set to 1 then RKH will include the rkh_rq_put_lifo() function that puts an element on a queue in a LIFO manner. See rkh_rq_put_lifo() function. More...
 

Detailed Description

Configuration options related to queue facility (RQ)

Macro Definition Documentation

#define RKH_CFG_RQ_EN   RKH_ENABLED

If the RKH_CFG_RQ_EN is set to 1 then RKH will include the native queue facility.

Type value
Boolean
Range value
Default configuration:
RKH_ENABLED

Definition at line 993 of file rkhcfg.h.

#define RKH_CFG_RQ_SIZEOF_NELEM   8u

Specify the maximum number of elements that any queue can contain. The valid values [in bits] are 8, 16 or 32. Default is 8. See RKH_RQNE_T type.

Type value
Integer
Range value
[8, 16, 32]
Default configuration:
8

Definition at line 1005 of file rkhcfg.h.

#define RKH_CFG_RQ_GET_LWMARK_EN   RKH_ENABLED

If the RKH_CFG_RQ_GET_LWMARK_EN is set to 1 then RKH allows to known the minimum number of free elements ever in the queue (low-watermark ). This provides valuable empirical data for proper sizing of the queue. See rkh_rq_get_lwm() function.

Type value
Boolean
Range value
Default configuration:
RKH_ENABLED

Definition at line 1018 of file rkhcfg.h.

#define RKH_CFG_RQ_GET_INFO_EN   RKH_ENABLED

If the RKH_CFG_RQ_GET_INFO_EN is set to 1 then RKH allows to collect and retrives performance information for a particular queue. See rkh_rq_get_info() and rkh_rq_clear_info() functions.

Type value
Boolean
Range value
Default configuration:
RKH_ENABLED

Definition at line 1030 of file rkhcfg.h.

#define RKH_CFG_RQ_READ_EN   RKH_ENABLED

If the RKH_CFG_RQ_READ_EN is set to 1 then RKH will include the rkh_rq_read() function that allows read an element from a queue without remove it. See rkh_rq_read() function.

Type value
Boolean
Range value
Default configuration:
RKH_ENABLED

Definition at line 1042 of file rkhcfg.h.

#define RKH_CFG_RQ_DEPLETE_EN   RKH_ENABLED

If the RKH_CFG_RQ_DEPLETE_EN is set to 1 then RKH will include the rkh_rq_deplete() function that empties the contents of the queue and eliminates all stored elements. See rkh_rq_deplete() function.

Type value
Boolean
Range value
Default configuration:
RKH_ENABLED

Definition at line 1055 of file rkhcfg.h.

#define RKH_CFG_RQ_IS_FULL_EN   RKH_ENABLED

If the RKH_CFG_RQ_IS_FULL_EN is set to 1 then RKH will include the rkh_rq_is_full() function that allows to known if a queue is full. See rkh_rq_is_full() function.

Type value
Boolean
Range value
Default configuration:
RKH_ENABLED

Definition at line 1067 of file rkhcfg.h.

#define RKH_CFG_RQ_GET_NELEMS_EN   RKH_ENABLED

If the RKH_CFG_RQ_GET_NELEMS_EN is set to 1 then RKH will include the rkh_rq_get_num() function that returns the number of elements currently in the queue. See rkh_rq_get_num() function.

Type value
Boolean
Range value
Default configuration:
RKH_ENABLED

Definition at line 1080 of file rkhcfg.h.

#define RKH_CFG_RQ_PUT_LIFO_EN   RKH_ENABLED

If the RKH_CFG_RQ_PUT_LIFO_EN is set to 1 then RKH will include the rkh_rq_put_lifo() function that puts an element on a queue in a LIFO manner. See rkh_rq_put_lifo() function.

Type value
Boolean
Range value
Default configuration:
RKH_ENABLED

Definition at line 1093 of file rkhcfg.h.