Functions relating to Hybrid file system. More...

#include "mh5base.h"

Classes
struct	MHEG5MappingIter_t

Functions
void	MHEG5InitialiseHybridFileSystem (void)
	Initialise the hybrid file system. The hybrid file system is a set of mappings from a "path" string (not including source, which is implicitly the string "hybrid:") to a list of paths. More...

void	MHEG5ClearHybridFileSystem (void)
	Clear the hybrid file system and restore the default mapping // -> DSM://. More...

void	MHEG5PushHybridFileSystem (void)
	Push a copy of the current hybrid file system into the stack. More...

void	MHEG5PopHybridFileSystem (void)
	Clear the current hybrid file system and pop a stored hybrid file system from the stack. More...

void	MHEG5SetHybridFileSystem (MHEG5String pathName, MHEG5String mappingList)
	Set mapping list in the hybrid file system. This function sets, clears or modifies the list of mappings associated with a path in the hybrid file system. More...

void *	MHEG5GetHybridFileSystemMapping (MHEG5String *reference)
	Return mapping from the hybrid file system given path name. The mapping must be released using MHEG5ReleaseHybridFileSystemMapping. More...

void	MHEG5ReleaseHybridFileSystemMapping (void *mapping)
	Release mapping returned from the hybrid file system. The mapping must be have been returned by a call to the function MHEG5GetHybridFileSystemMapping. More...

void	MHEG5InitMappingIter (MHEG5MappingIter_t iter, void mapping)
	Initialise hybrid filesystem mapping iterator. More...

MHEG5String	MHEG5GetNextReference (MHEG5String reference, MHEG5MappingIter_t iter)
	Return next reference from mapping iterator. More...

MHEG5String	MHEG5GetFirstDsmReference (MHEG5String *reference)
	Return first reference with DSM:// source. This is a convenience function that converts a hybrid:// reference to a DSM:// reference (if any), and saves the trouble of finding a mapping, initialising an iterator and checking each reference. This function also accepts DSM:// references, in which case it simply copies the input. It also handles other (even invalid) references, in which case it returns the empty string as output. More...

Detailed Description

Functions relating to Hybrid file system.

Date: 22/09/2009

Author: Omri Barel

Definition in file mh5hfs.h.

Function Documentation

void MHEG5ClearHybridFileSystem ( void )

Clear the hybrid file system and restore the default mapping // -> DSM://.

Returns: Nothing

Definition at line 117 of file mh5hfs.c.

MHEG5String MHEG5GetFirstDsmReference ( MHEG5String * reference )

Return first reference with DSM:// source. This is a convenience function that converts a hybrid:// reference to a DSM:// reference (if any), and saves the trouble of finding a mapping, initialising an iterator and checking each reference. This function also accepts DSM:// references, in which case it simply copies the input. It also handles other (even invalid) references, in which case it returns the empty string as output.

Parameters

reference Reference to match. The reference should be a full path (including source).

Returns: The first DSM:// reference or an empty string

Definition at line 381 of file mh5hfs.c.

void* MHEG5GetHybridFileSystemMapping ( MHEG5String * reference )

Return mapping from the hybrid file system given path name. The mapping must be released using MHEG5ReleaseHybridFileSystemMapping.

Parameters

reference Reference to match. The reference must start with "//".

Returns: Handle to mapping if successful, NULL otherwise

Definition at line 211 of file mh5hfs.c.

MHEG5String MHEG5GetNextReference	(	MHEG5String *	ref,
		MHEG5MappingIter_t *	iter
	)

Return next reference from mapping iterator.

Parameters

reference	Reference to match. The reference must start with "//".
iter	Pointer to mapping iterator

Returns: Next reference or an empty string if no more references. The string must not be destoyed using MHEG5stringDestruct. The string must not be used after the mapping is released.

Definition at line 301 of file mh5hfs.c.

void MHEG5InitialiseHybridFileSystem ( void )

Initialise the hybrid file system. The hybrid file system is a set of mappings from a "path" string (not including source, which is implicitly the string "hybrid:") to a list of paths.

Returns: Nothing

Definition at line 107 of file mh5hfs.c.

void MHEG5InitMappingIter	(	MHEG5MappingIter_t *	iter,
		void *	mapping
	)

Initialise hybrid filesystem mapping iterator.

Parameters

iter	Pointer to iterator to initialise
mapping	Mapping to be used by iterator

Returns: Nothing

Definition at line 283 of file mh5hfs.c.

void MHEG5PopHybridFileSystem ( void )

Clear the current hybrid file system and pop a stored hybrid file system from the stack.

Returns: Nothing

Definition at line 141 of file mh5hfs.c.

void MHEG5PushHybridFileSystem ( void )

Push a copy of the current hybrid file system into the stack.

Returns: Nothing

Definition at line 131 of file mh5hfs.c.

void MHEG5ReleaseHybridFileSystemMapping ( void * handle )

Release mapping returned from the hybrid file system. The mapping must be have been returned by a call to the function MHEG5GetHybridFileSystemMapping.

Parameters

mapping Handle to mapping to release

Returns: Nothing

Definition at line 270 of file mh5hfs.c.

void MHEG5SetHybridFileSystem	(	MHEG5String *	pathName,
		MHEG5String *	mappingList
	)

Set mapping list in the hybrid file system. This function sets, clears or modifies the list of mappings associated with a path in the hybrid file system.

Returns: Nothing

Definition at line 152 of file mh5hfs.c.

Classes

Functions

Detailed Description

Function Documentation