vsf_stream_reader.h File Reference

#include "service/vsf_service_cfg.h"
#include "./pbuf/vsf_pbuf.h"
#include "./pbuf/vsf_pbuf_pool.h"
#include "./interface.h"
#include "../pool/vsf_pool.h"
#include "./pbuf_queue/vsf_pbuf_queue.h"
#include "./vsf_stream_base.h"
#include "utilities/ooc_class.h"

Go to the source code of this file.

Macros
#define	__PLOOC_CLASS_USE_STRICT_TEMPLATE__

Functions
	declare_class (vsf_stream_reader_t)
	def_class (vsf_stream_reader_t, which(vsf_stream_usr_t), private:vsf_pbuf_t *current_ptr;uint16_t hwOffset;uint16_t hwBufferSize;) end_def_class(vsf_stream_reader_t) typedef vsf_stream_usr_cfg_t vsf_stream_reader_cfg_t
	def_interface (i_stream_reader_t) vsf_err_t(*Init)(vsf_stream_reader_t *obj_ptr
	end_def_interface (i_stream_reader_t) extern const i_stream_reader_t VSF_STREAM_READER
vsf_err_t	vsf_stream_reader_init (vsf_stream_reader_t *obj_ptr, const vsf_stream_reader_cfg_t *cfg_ptr)
vsf_pbuf_t *	vsf_stream_reader_fetch_pbuf (vsf_stream_reader_t *obj_ptr)
int_fast32_t	vsf_stream_reader_read (vsf_stream_reader_t *obj_ptr, uint8_t *buffer_ptr, uint_fast16_t u16_size)
bool	vsf_stream_reader_read_byte (vsf_stream_reader_t *obj_ptr, uint8_t *byte_ptr)

Variables
const vsf_stream_reader_cfg_t *	cfg_ptr
void(*	Open )(vsf_stream_reader_t *obj_ptr)
void(*	Close )(vsf_stream_reader_t *obj_ptr)
struct {
vsf_pbuf_t *(*   Fetch )(vsf_stream_reader_t *obj_ptr)
}	Block
bool(*	ReadByte )(vsf_stream_reader_t *obj_ptr, uint8_t *byte_ptr)
int_fast32_t(*	Read )(vsf_stream_reader_t *obj_ptr, uint8_t *buffer_ptr, uint_fast16_t u16_size)

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

Function Documentation

declare_class()

declare_class

(

vsf_stream_reader_t

)

def_class()

def_class	(	vsf_stream_reader_t	,
		which(vsf_stream_usr_t)	,
		private:vsf_pbuf_t *current_ptr;uint16_t hwOffset;uint16_t hwBufferSize;
	)

def_interface()

def_interface

(

i_stream_reader_t

)

end_def_interface()

end_def_interface

(

i_stream_reader_t

)

const

vsf_stream_reader_init()

vsf_err_t vsf_stream_reader_init ( vsf_stream_reader_t *  obj_ptr, const vsf_stream_reader_cfg_t *  cfg_ptr  )

extern

vsf_stream_reader_fetch_pbuf()

vsf_pbuf_t * vsf_stream_reader_fetch_pbuf ( vsf_stream_reader_t *  obj_ptr )

extern

vsf_stream_reader_read()

int_fast32_t vsf_stream_reader_read ( vsf_stream_reader_t *  obj_ptr, uint8_t *  buffer_ptr, uint_fast16_t  u16_size  )

extern

current buffer is full

free

vsf_stream_reader_read_byte()

bool vsf_stream_reader_read_byte ( vsf_stream_reader_t *  obj_ptr, uint8_t *  byte_ptr  )

extern

Variable Documentation

cfg_ptr

const vsf_stream_reader_cfg_t* cfg_ptr

Open

void(* Open) (vsf_stream_reader_t *obj_ptr)

(

vsf_stream_reader_t *

obj_ptr

)

Close

void(* Close) (vsf_stream_reader_t *obj_ptr)

(

vsf_stream_reader_t *

obj_ptr

)

Fetch

vsf_pbuf_t *(* Fetch) (vsf_stream_reader_t *obj_ptr)

(

vsf_stream_reader_t *

obj_ptr

)

[struct]

struct { ... } Block

ReadByte

bool(* ReadByte) (vsf_stream_reader_t *obj_ptr, uint8_t *byte_ptr)	(	vsf_stream_reader_t *	obj_ptr,
		uint8_t *	byte_ptr
	)

Read

int_fast32_t(* Read) (vsf_stream_reader_t *obj_ptr, uint8_t *buffer_ptr, uint_fast16_t u16_size)	(	vsf_stream_reader_t *	obj_ptr,
		uint8_t *	buffer_ptr,
		uint_fast16_t	u16_size
	)