vsf_pbuf_queue.h File Reference

#include "service/vsf_service_cfg.h"
#include "../interface.h"
#include "../pbuf/vsf_pbuf.h"
#include "utilities/ooc_class.h"

Go to the source code of this file.

Macros
#define	__PLOOC_CLASS_USE_STRICT_TEMPLATE__
#define	__PLOOC_CLASS_IMPLEMENT__

Functions
	declare_class (vsf_stream_fifo_t) typedef struct vsf_stream_fifo_cfg_t
	def_class (vsf_stream_fifo_t, which(vsf_stream_tx_t TX;vsf_stream_rx_t RX;), private:vsf_slist_queue_t union { vsf_stream_fifo_cfg_t cfg;struct { vsf_stream_dat_rdy_evt_t tDataReadyEventHandling;vsf_stream_dat_drn_evt_t tDataDrainEventHandling;vsf_stream_status_t Status;#if !defined(VSF_PBUF_QUEUE_CFG_ATOM_ACCESS) vsf_protect_region_t *pregion;#endif };};) end_def_class(vsf_stream_fifo_t) extern vsf_err_t vsf_stream_fifo_init(vsf_stream_fifo_t *obj_ptr
vsf_err_t	vsf_pbuf_queue_enqueue (vsf_stream_fifo_t *obj_ptr, vsf_pbuf_t *pblock)
vsf_pbuf_t *	vsf_pbuf_queue_dequeue (vsf_stream_fifo_t *obj_ptr)
vsf_pbuf_t *	vsf_pbuf_queue_peek (vsf_stream_fifo_t *obj_ptr)
vsf_err_t	vsf_pbuf_queue_data_available_event_register (vsf_stream_fifo_t *obj_ptr, vsf_stream_dat_rdy_evt_t tEventHandling)
vsf_err_t	vsf_pbuf_queue_data_drain_event_register (vsf_stream_fifo_t *obj_ptr, vsf_stream_dat_drn_evt_t tEventHandling)

Variables
	vsf_stream_fifo_cfg_t
vsf_stream_fifo_cfg_t *	cfg_ptr

Macro Definition Documentation

__PLOOC_CLASS_USE_STRICT_TEMPLATE__

#define __PLOOC_CLASS_USE_STRICT_TEMPLATE__

\NOTE: Make sure #include "utilities/ooc_class.h" is close to the class ! definition and there is NO ANY OTHER module-interface-header file ! included in this file

__PLOOC_CLASS_IMPLEMENT__

#define __PLOOC_CLASS_IMPLEMENT__

Function Documentation

declare_class()

declare_class

(

vsf_stream_fifo_t

)

< protection region defined by user

def_class()

def_class	(	vsf_stream_fifo_t	,
		which( vsf_stream_tx_t TX; vsf_stream_rx_t RX;)	,
		private:vsf_slist_queue_t union { vsf_stream_fifo_cfg_t cfg;struct { vsf_stream_dat_rdy_evt_t tDataReadyEventHandling;vsf_stream_dat_drn_evt_t tDataDrainEventHandling;vsf_stream_status_t Status;#if !defined(VSF_PBUF_QUEUE_CFG_ATOM_ACCESS) vsf_protect_region_t *pregion;#endif };};
	)

vsf_pbuf_queue_enqueue()

vsf_err_t vsf_pbuf_queue_enqueue ( vsf_stream_fifo_t *  obj_ptr, vsf_pbuf_t *  pblock  )

extern

raise data ready event

vsf_pbuf_queue_dequeue()

vsf_pbuf_t * vsf_pbuf_queue_dequeue ( vsf_stream_fifo_t *  obj_ptr )

extern

raise data drain event

vsf_pbuf_queue_peek()

vsf_pbuf_t * vsf_pbuf_queue_peek ( vsf_stream_fifo_t *  obj_ptr )

extern

vsf_pbuf_queue_data_available_event_register()

vsf_err_t vsf_pbuf_queue_data_available_event_register ( vsf_stream_fifo_t *  obj_ptr, vsf_stream_dat_rdy_evt_t  tEventHandling  )

extern

vsf_pbuf_queue_data_drain_event_register()

vsf_err_t vsf_pbuf_queue_data_drain_event_register ( vsf_stream_fifo_t *  obj_ptr, vsf_stream_dat_drn_evt_t  tEventHandling  )

extern

Variable Documentation

vsf_stream_fifo_cfg_t

vsf_stream_fifo_cfg_t

cfg_ptr

vsf_stream_fifo_cfg_t* cfg_ptr