source/classes/src/mh5link.c File Reference

Implement the MHEG5 Link Class. Description Defines the functionality associated with reacting to events by performing a sequence of elementary actions. Base class: Ingredient Subclasses: None Status: Concrete class. More...

#include "mh5link.h"
#include "mh5memory.h"
#include "mh5object.h"
#include "mh5variable.h"
#include "mh5streamevent.h"
#include "mh5queue.h"
#include "mh5debug.h"

Data Structures
struct	s_LinkString
Defines
#define	MAX_REG_STRINGS   32
Typedefs
typedef struct s_LinkString	S_LinkString
Functions
void	initialiseActiveLinkQs (void)
	<Function description>="">
int	LNK_RegisterString (MHEG5String s)
int	LNK_GetStringIndex (MHEG5String s)
MHEG5String	LNK_GetString (int i)
U8BIT *	MHEG5linkEventName (MHEG5Link *link)
void	MHEG5linkInit (MHEG5Link *link)
	Initialise a link object with default values.
void	MHEG5linkFree (MHEG5Link *link)
	Free off all memory associated with the specified object, including any exchanged attributes and internal data. The data holding the object itself is not freed.
void	MHEG5linkPrepare (MHEG5Link *link)
void	MHEG5linkDestruct (MHEG5Link *link)
void	MHEG5linkActivate (MHEG5Link *link)
void	MHEG5linkDeactivate (MHEG5Link *link)
MHEG5ErrorCode	MHEG5activate (MHEG5Root *target, MHEG5GList *params)
MHEG5ErrorCode	MHEG5deactivate (MHEG5Root *target, MHEG5GList *params)
Variables
MHEG5Link *	activeLinksHead [MHEG5LASTEVENT+1]
unsigned int	existsLinkCount [MHEG5LASTEVENT+1]

---

Detailed Description

Implement the MHEG5 Link Class. Description Defines the functionality associated with reacting to events by performing a sequence of elementary actions. Base class: Ingredient Subclasses: None Status: Concrete class.

Date:

22/04/2002

Author:

iwillis

---

Function Documentation

void initialiseActiveLinkQs

(

void

)

<Function description>="">

Returns:

<Return value>="">

void MHEG5linkFree

(

MHEG5Link *

link

)

Free off all memory associated with the specified object, including any exchanged attributes and internal data. The data holding the object itself is not freed.

Parameters:

link	Pointer to object to free.

Returns:

Void

void MHEG5linkInit

(

MHEG5Link *

link

)

Initialise a link object with default values.

<Function description>="">

Parameters:

link	Pointer to object to initialise.

Returns:

Void