File interface functions to DSMCC component.
More...
#include "mh5base.h"
#include "mh5root.h"
#include "fs_types.h"
#include "mh5gate.h"
Go to the source code of this file.
|
#define | FRP_CACHE_DEFAULT 0x007F |
|
#define | FRP_CACHE_MASK 0x00FF |
|
#define | FRP_APPLICATION 0x0100 |
|
#define | FRP_SCENE 0x0200 |
|
#define | FRP_GROUP 0x0300 |
|
#define | FRP_EXISTS 0x0400 |
|
#define | FRP_VERIFY 0x0800 |
|
#define | FRP_HASH 0x1000 |
|
#define | FRP_CERT 0x2000 |
|
#define | FRP_SERVER 0x3000 |
|
#define | FRP_DEFER_SERV 0x4000 |
|
#define | FRP_IN_APP 0x8000 |
|
|
typedef void(* | F_CB_Good) (void *userData, S_CONTENT *content) |
|
typedef void(* | F_CB_Fail) (void *userData) |
|
typedef void(* | F_CB_Post) (void *userData, MHEG5String responseData, MHEG5Int responseCode) |
|
typedef void(* | F_CB_CiMsg) (void *userData, MHEG5String output, MHEG5Bool success) |
|
|
enum | MHEG5FileOrmResetMode { MHEG5_FILE_ORM_RESET_SCENE_OBJECTS,
MHEG5_FILE_ORM_RESET_ALL_OBJECTS,
MHEG5_FILE_ORM_RESET_ALL
} |
|
|
void | MHEG5FileOrmInit (void) |
| Initialise the file ORM module. More...
|
|
void | MHEG5FileOrmReset (MHEG5FileOrmResetMode resetMode) |
| Reset the ORM module. This function supports two modes: More...
|
|
BOOLEAN | MHEG5FileOrmIsReset (MHEG5FileOrmResetMode *resetMode) |
| Tell whether the ORM module is currently being reset. If it is, the function also returns the current reset mode. This information is required in order to decide whether to generate an EngineEvent when a file load fails. If a file cannot be loaded (doesn't exist, timeout) then an event is required, but if a file load "fails" because the ORM module is being reset, then no event should be generated. resetMode is an optional parameter, and it can also be NULL. More...
|
|
BOOLEAN | MHEG5FileOrmProcess (void) |
| Check for any file requests that have arrived since this function was last called. For each arrived file the callback will be called. The function may have to be called more than once in case a file the arrived affects other files as well. More...
|
|
void | MHEG5FileOrmClear (void *orm_ref) |
| Aborts a request for file. More...
|
|
void * | MHEG5FileOrmGet (MHEG5String name, U16BIT priority, void *userData, F_CB_Good cbGood, F_CB_Fail cbFail) |
| Get a file. The file will be loaded and one of the callback functions called when request is resolved. When file system acceleration is available, this may retrieve the file from NVM cache. More...
|
|
void * | MHEG5FileOrmRetrieve (E_FS_ORIGIN origin, S_STRING location, S_STRING name, U16BIT priority, void *userData, F_CB_Good cbGood, F_CB_Fail cbFail) |
| Retrieve of a file. The file will be loaded and one of the callback functions called when request is resolved. This is intended to be used by the File System Acceleration code. More...
|
|
void | MHEG5FileOrmPreloadHint (MHEG5String name) |
| Provide a preload hint to DSM-CC that the specified file may be required in the future. DSM-CC could (but is not required to) acquire the file into cache. More...
|
|
void | MHEG5ciFileAcknowledge (BOOLEAN fileOK, U8BIT *pFileData, U32BIT length) |
| Process the FileAcknowledge message sent from the CI module. More...
|
|
File interface functions to DSMCC component.
- Date
- 17/01/2002
- Author
- R.Freeman
void MHEG5ciFileAcknowledge |
( |
BOOLEAN |
fileOK, |
|
|
U8BIT * |
pFileData, |
|
|
U32BIT |
length |
|
) |
| |
Process the FileAcknowledge message sent from the CI module.
- Parameters
-
fileOK | FileOK field of the FileAcknowledge message |
pFileData | Pointer to file data in the FileAcknowledge message |
length | Number of bytes in the file data |
- Returns
- void
void MHEG5FileOrmClear |
( |
void * |
orm_ref | ) |
|
Aborts a request for file.
- Parameters
-
- Returns
- None.
Aborts a request for file.
- Parameters
-
orm_ref | Handle given back by MHEG5FileOrmGet |
- Returns
- None.
void* MHEG5FileOrmGet |
( |
MHEG5String |
name, |
|
|
U16BIT |
priority, |
|
|
void * |
userData, |
|
|
F_CB_Good |
cbGood, |
|
|
F_CB_Fail |
cbFail |
|
) |
| |
Get a file. The file will be loaded and one of the callback functions called when request is resolved. When file system acceleration is available, this may retrieve the file from NVM cache.
- Parameters
-
name | Name of file to retrieve. This will be expanded using the rules specified by the UK1 profile. |
priority | Cache priority with which to fetch the object. |
userData | User data to be returned in callback functions. |
cbGood | Pointer to callback function that will be called when the file is retreived. |
cbFail | Pointer to callback function that will be called when the file cannot be retrieved. |
- Returns
- void* - the FileOrm request handle
void MHEG5FileOrmInit |
( |
void |
| ) |
|
Initialise the file ORM module.
- Returns
- void
-
always returns 1
BOOLEAN MHEG5FileOrmIsReset |
( |
MHEG5FileOrmResetMode * |
resetMode | ) |
|
Tell whether the ORM module is currently being reset. If it is, the function also returns the current reset mode. This information is required in order to decide whether to generate an EngineEvent when a file load fails. If a file cannot be loaded (doesn't exist, timeout) then an event is required, but if a file load "fails" because the ORM module is being reset, then no event should be generated. resetMode is an optional parameter, and it can also be NULL.
- Parameters
-
resetMode | Reset mode (if return value is TRUE) |
- Returns
- TRUE if the ORM module is being reset, FALSE otherwise
Provide a preload hint to DSM-CC that the specified file may be required in the future. DSM-CC could (but is not required to) acquire the file into cache.
- Parameters
-
name | Name of file to preload |
- Returns
- void
BOOLEAN MHEG5FileOrmProcess |
( |
void |
| ) |
|
Check for any file requests that have arrived since this function was last called. For each arrived file the callback will be called. The function may have to be called more than once in case a file the arrived affects other files as well.
- Returns
- void
-
TRUE if the function should be called again, FALSE otherwise
void MHEG5FileOrmReset |
( |
MHEG5FileOrmResetMode |
resetMode | ) |
|
Reset the ORM module. This function supports two modes:
- In "objects" mode, only outstanding file requests that are related to MHEG-5 objects are cancelled.
- In "all" mode, every outstanding file request is cleared. This includes file requests to certificates and access files.
- Parameters
-
- Returns
- None.
void* MHEG5FileOrmRetrieve |
( |
E_FS_ORIGIN |
origin, |
|
|
S_STRING |
location, |
|
|
S_STRING |
name, |
|
|
U16BIT |
priority, |
|
|
void * |
userData, |
|
|
F_CB_Good |
cbGood, |
|
|
F_CB_Fail |
cbFail |
|
) |
| |
Retrieve of a file. The file will be loaded and one of the callback functions called when request is resolved. This is intended to be used by the File System Acceleration code.
- Parameters
-
origin | Origin of file to retrieve. |
location | Path location of file to retrieve. |
name | Name of file to retrieve. |
priority | Cache priority with which to fetch the object. |
userData | User data to be returned in callback functions. |
cbGood | Pointer to callback function that will be called when the file is retreived. |
cbFail | Pointer to callback function that will be called when the file cannot be retrieved. |
- Returns
- void* - the FileOrm request handle