source/dsfm/src/sfm_cache.h File Reference

Section Filter Manasger (SFM): cache definitions. More...

#include "sfm_main.h"

Go to the source code of this file.

Data Structures
struct	s_TableExt
Typedefs
typedef struct s_TableExt	S_TableExt
typedef struct s_CacheTable *	H_CacheTable
typedef struct s_CacheFilter *	H_CacheFilter
Functions
H_SfmCache	SFMCacheCreate (H_SfmInstance sfm)
H_CacheTable	SFMCacheGetTable (H_SfmCache cache)
void	SFMCacheDestroy (H_SfmInstance sfm, void **pBufMtx)
BOOLEAN	SFMCacheValidHandle (H_SfmInstance sfm, void *ptr)
H_CacheFilter	SFMCacheRetrieveFilter (H_SfmInstance sfm, H_CacheTable ctable, U16BIT teid, U8BIT vers)
	Search cache for section data.
void	SFMCacheAddBlock (H_SfmInstance sfm, U8BIT size1, U8BIT bknum, void **phBuffer)
	Allocates space in cache for section data If allocation is made, *phBuffer has holds cache location. If section already allocated, or insufficient space, then *phBuffer is NULL.
void	SFMCacheSearch (H_SfmInstance sfm, H_CacheTable ctable, S_TableExt tex, U16BIT dsmref, E_SFM_STATUS status)
	Search cache for section data.
void	SFMCacheProcessSection (H_SfmInstance sfm, U8BIT *pSection, H_CacheFilter cfilter)
	Tells SFM Cache to update DSM-CC with cached buffer (reported to F_CacheMatch callback funtion. This also allows SFM cache to clean up completed buffers.

---

Detailed Description

Section Filter Manasger (SFM): cache definitions.

Date:

16-10-2013

Author:

Adam Sturtridge

---

Function Documentation

void SFMCacheAddBlock	(	H_SfmInstance	sfm,
		U8BIT	size1,
		U8BIT	bknum,
		void **	phBuffer
	)

Allocates space in cache for section data If allocation is made, *phBuffer has holds cache location. If section already allocated, or insufficient space, then *phBuffer is NULL.

Parameters:

H_SfmCache	cache SFM cache handle.
U8BIT	size1 header[1] byte with top bits for section size
void**	phBuffer Pointer to SFM cache filter handle and return param with pointer to node block

Returns:

void.

Parameters:

H_SfmInstance	sfm SFM instance handle.
H_CacheTable	ctable Cache table handle
void**	phBuffer Pointer to SFM section buffer handle

Returns:

void.

void SFMCacheProcessSection	(	H_SfmInstance	sfm,
		U8BIT *	pSection,
		H_CacheFilter	cfilter
	)

Tells SFM Cache to update DSM-CC with cached buffer (reported to F_CacheMatch callback funtion. This also allows SFM cache to clean up completed buffers.

Parameters:

H_SfmInstance	sfm SFM instance handle.
U8BIT*	pSection Pointer to whole section data buffer
H_CacheFilter	cfilter Hande given to F_CacheMatch

Returns:

void.

H_CacheFilter SFMCacheRetrieveFilter	(	H_SfmInstance	sfm,
		H_CacheTable	ctable,
		U16BIT	teid,
		U8BIT	vers
	)

Search cache for section data.

Parameters:

H_SfmCache	cache SFM cache handle.
H_CacheTable	ctable Cache table handle
U16BIT	teid Table Extension ID

Returns:

H_CacheFilter

void SFMCacheSearch	(	H_SfmInstance	sfm,
		H_CacheTable	ctable,
		S_TableExt	tex,
		U16BIT	dsmref,
		E_SFM_STATUS	status
	)

Search cache for section data.

Parameters:

H_SfmInstance	sfm SFM instance handle.
H_CacheTable	ctable Cache table handle
S_TableExt	tex Table Extension ID and mask

Returns:

void.

BOOLEAN SFMCacheValidHandle	(	H_SfmInstance	sfm,
		void *	ptr
	)

Parameters:

H_SfmInstance	sfm SFM instance handle.
void*	hCache Handle to cache buffer given to the F_CacheMatch callback function

Returns:

BOOLEAN