source/core/inc/mh5filegroup.h File Reference

File acceleration for Australia and Souh Africa. More...

#include "fs_types.h"
#include "glue_queue.h"

Go to the source code of this file.

Enumerations
enum	E_FG_ORIGIN { FGO_DSM, FGO_CI, FGO_HTTP }
Functions
void	FG_Initialise (U32BIT nvmSize)
	Initialise - retrieve data from NVM storage for any file groups and allocate the file group list.
void	FG_Terminate (void)
	Terminate - free data associated with all file groups.
void	FG_FetchManifests (H_ObjCarousel hOC, U8BIT cachePriority)
	Examines the Obect Carousel's SRG User Info for references to the file group, and requests the manifest file for each group which is not stored stored or where version has changed.
void	FG_ClearManifests (H_ObjCarousel hOC)
	Tell File Group that the Object Carousel has been unloaded, so all file groups on this carousel should be removed.
void	FG_NotifyFileGroupChanged (S_DsmccEvent *param)
	Tell File Group thatFile Groups have changed in Object Carousel's SRG User Info.
E_FsStatus	FG_LoadRequest (E_FG_ORIGIN origin, char *fname, F_FS_CALLBACK cb_func, S_CONTENT *pContent)
	Request file from file group stores.
E_FsStatus	FG_FileExists (E_FG_ORIGIN origin, char *fname)
	Request file from file group stores.
void	FG_FactoryReset (void)
	In the "factory reset", we clear all file groups from cache store. Then re-aquire file groups for the current Object Carousel - if loaded.

---

Detailed Description

File acceleration for Australia and Souh Africa.

Date:

15/07/2010

Author:

Adam Sturtridge

---

Function Documentation

void FG_ClearManifests

(

H_ObjCarousel

hOC

)

Tell File Group that the Object Carousel has been unloaded, so all file groups on this carousel should be removed.

Parameters:

hOC	handle to Object Carousel

Returns:

n/a

void FG_FactoryReset

(

void

)

In the "factory reset", we clear all file groups from cache store. Then re-aquire file groups for the current Object Carousel - if loaded.

Returns:

void

void FG_FetchManifests	(	H_ObjCarousel	hOC,
		U8BIT	cachePriority
	)

Examines the Obect Carousel's SRG User Info for references to the file group, and requests the manifest file for each group which is not stored stored or where version has changed.

Parameters:

hOC	handle to Object Carousel

Returns:

n/a

E_FsStatus FG_FileExists	(	E_FG_ORIGIN	origin,
		char *	fname
	)

Request file from file group stores.

Parameters:

fname

file name

Returns:

n/a

void FG_Initialise

(

U32BIT

nvmSize

)

Initialise - retrieve data from NVM storage for any file groups and allocate the file group list.

Parameters:

nvmSize

Size of NVM available for DSM-CC caching.

Returns:

void

E_FsStatus FG_LoadRequest	(	E_FG_ORIGIN	origin,
		char *	fname,
		F_FS_CALLBACK	cb_func,
		S_CONTENT *	pContent
	)

Request file from file group stores.

Parameters:

fname

file name

Returns:

n/a

void FG_NotifyFileGroupChanged

(

S_DsmccEvent *

param

)

Tell File Group thatFile Groups have changed in Object Carousel's SRG User Info.

Parameters:

param

Dsmcc Event data

Returns:

n/a

void FG_Terminate

(

void

)

Terminate - free data associated with all file groups.

Returns:

void