vsf_pbuf.c File Reference

#include "service/vsf_service_cfg.h"
#include <string.h>
#include "vsf_pbuf.h"

Macros
#define	__VSF_PBUF_CLASS_IMPLEMENT
#define	this   (*this_ptr)

Functions
void	vsf_adapter_register (const vsf_pbuf_adapter_t *adaptors_ptr, uint_fast8_t u8_size)
const vsf_pbuf_adapter_t *	vsf_pbuf_adapter_get (uint_fast8_t id)
vsf_pbuf_t *	vsf_pbuf_init (vsf_pbuf_t *pbuf, vsf_pbuf_cfg_t *pcfg)
void	vsf_pbuf_size_reset (vsf_pbuf_t *obj_ptr)
void *	vsf_pbuf_buffer_get (vsf_pbuf_t *obj_ptr)
int_fast32_t	vsf_pbuf_buffer_write (vsf_pbuf_t *obj_ptr, const void *psrc, int_fast32_t s32_size, uint_fast32_t offsite)
int_fast32_t	vsf_pbuf_buffer_read (vsf_pbuf_t *obj_ptr, void *psrc, int_fast32_t s32_size, uint_fast32_t u32_offset)
void	vsf_pbuf_size_set (vsf_pbuf_t *obj_ptr, int_fast32_t s32_size)
int_fast32_t	vsf_pbuf_capacity_get (vsf_pbuf_t *obj_ptr)
int_fast32_t	vsf_pbuf_size_get (vsf_pbuf_t *obj_ptr)
vsf_pbuf_capability_t	vsf_pbuf_capability_get (vsf_pbuf_t *obj_ptr)
void	vsf_pbuf_ref_increase (vsf_pbuf_t *pbuf)
vsf_pbuf_t *	vsf_pbuf_free (vsf_pbuf_t *pbuf)
void	vsf_pbuf_pool_item_init_event_handler (uintptr_t target_ptr, uintptr_t pbuf, uint_fast32_t s32_size)

Variables
const i_pbuf_t	VSF_PBUF

Macro Definition Documentation

__VSF_PBUF_CLASS_IMPLEMENT

#define __VSF_PBUF_CLASS_IMPLEMENT

this

#define this   (*this_ptr)

Function Documentation

vsf_adapter_register()

void vsf_adapter_register	(	const vsf_pbuf_adapter_t *	adaptors_ptr,
		uint_fast8_t	u8_size
	)

< this function could only be called once.

vsf_pbuf_adapter_get()

const vsf_pbuf_adapter_t * vsf_pbuf_adapter_get

(

uint_fast8_t

id

)

vsf_pbuf_init()

vsf_pbuf_t * vsf_pbuf_init	(	vsf_pbuf_t *	pbuf,
		vsf_pbuf_cfg_t *	pcfg
	)

vsf_pbuf_size_reset()

void vsf_pbuf_size_reset

(

vsf_pbuf_t *

obj_ptr

)

< readonly

vsf_pbuf_buffer_get()

void * vsf_pbuf_buffer_get

(

vsf_pbuf_t *

obj_ptr

)

vsf_pbuf_buffer_write()

int_fast32_t vsf_pbuf_buffer_write	(	vsf_pbuf_t *	obj_ptr,
		const void *	psrc,
		int_fast32_t	s32_size,
		uint_fast32_t	offsite
	)

vsf_pbuf_buffer_read()

int_fast32_t vsf_pbuf_buffer_read	(	vsf_pbuf_t *	obj_ptr,
		void *	psrc,
		int_fast32_t	s32_size,
		uint_fast32_t	u32_offset
	)

vsf_pbuf_size_set()

void vsf_pbuf_size_set	(	vsf_pbuf_t *	obj_ptr,
		int_fast32_t	s32_size
	)

readonly

vsf_pbuf_capacity_get()

int_fast32_t vsf_pbuf_capacity_get

(

vsf_pbuf_t *

obj_ptr

)

vsf_pbuf_size_get()

int_fast32_t vsf_pbuf_size_get

(

vsf_pbuf_t *

obj_ptr

)

vsf_pbuf_capability_get()

vsf_pbuf_capability_t vsf_pbuf_capability_get

(

vsf_pbuf_t *

obj_ptr

)

vsf_pbuf_ref_increase()

void vsf_pbuf_ref_increase

(

vsf_pbuf_t *

pbuf

)

vsf_pbuf_free()

vsf_pbuf_t * vsf_pbuf_free

(

vsf_pbuf_t *

pbuf

)

< allow free NULL item.

vsf_pbuf_pool_item_init_event_handler()

void vsf_pbuf_pool_item_init_event_handler	(	uintptr_t	target_ptr,
		uintptr_t	pbuf,
		uint_fast32_t	s32_size
	)

< use the rest memory of the block as buffer

< total block s32_size

< allow write

< allow read

< allow direct access

< use default adapter

Variable Documentation

adapters_ptr

const vsf_pbuf_adapter_t* adapters_ptr

length

uint_fast8_t length

VSF_PBUF

const i_pbuf_t VSF_PBUF