source/classes/inc/mh5program.h

Go to the documentation of this file.

/*******************************************************************************
 * Copyright © 2014 The DTVKit Open Software Foundation Ltd (www.dtvkit.org)
 * Copyright © 2004 Ocean Blue Software Ltd
 * Copyright © 2000 Koninklijke Philips Electronics N.V
 *
 * This file is part of a DTVKit Software Component
 * You are permitted to copy, modify or distribute this file subject to the terms
 * of the DTVKit 1.0 Licence which can be found in licence.txt or at www.dtvkit.org
 * 
 * THIS CODE AND INFORMATION ARE PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND,
 * EITHER EXPRESSED OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND/OR FITNESS FOR A PARTICULAR PURPOSE.
 * 
 * If you or your organisation is not a member of DTVKit then you have access
 * to this source code outside of the terms of the licence agreement
 * and you are expected to delete this and any associated files immediately.
 * Further information on DTVKit, membership and terms can be found at www.dtvkit.org
 *******************************************************************************/
#ifndef _MH5PROGRAM_H
#define _MH5PROGRAM_H

/*---includes for this file--------------------------------------------------*/

#include "mh5ingredient.h"

/*---Constant and macro definitions for public use---------------------------*/

/*---Enumerations for public use---------------------------------------------*/

/*---Global type defs for public use-----------------------------------------*/

/*  struct Resident Program
    struct Remote Program
    struct MHEG5InterchangedProgram
 */
typedef struct MHEG5Program_struct
{
   /* Base class */
   MHEG5Ingredient ingredient;

   /* Exchanged attributes */
   MHEG5String name;
   MHEG5Bool initiallyAvailable;
   MHEG5Int programConnectionTag;       /* RemoteProgram only */

   /* No internal attributes for this class */

   /* Engine data */
   MHEG5GList *parameter;
   MHEG5Bool forked;
   MHEG5Bool *forkSucceededValue;
   void *resultValue;
   void *resultCode;
   MHEG5ErrorCode (*startFunc)(struct MHEG5Program_struct *);
   void (*stopFunc)(struct MHEG5Program_struct *);
} MHEG5Program;


/*---Global variable declarations for public use-----------------------------*/

/*---Global Function prototypes for public use-------------------------------*/

void MHEG5residentProgramInit(MHEG5Program *program);


void MHEG5residentProgramFree(MHEG5Program *program);


void MHEG5remoteProgramInit(MHEG5Program *program);


void MHEG5remoteProgramFree(MHEG5Program *program);


void MHEG5interchangedProgramInit(MHEG5Program *program);


void MHEG5interchangedProgramFree(MHEG5Program *program);

/*
    Internal behaviours
 */
void MHEG5programPrepare(MHEG5Program *program);
MHEG5ErrorCode MHEG5programActivate(MHEG5Program *program);
void MHEG5programDeactivate(MHEG5Program *program);
void MHEG5programDestruct(MHEG5Program *program);
void MHEG5programFree(MHEG5Program *program);

/*
    Actions
 */
MHEG5ErrorCode MHEG5call(MHEG5Root *target, MHEG5GList *params);
MHEG5ErrorCode MHEG5fork(MHEG5Root *target, MHEG5GList *params);

/*
   Implemented in Presentable Class
   void MHEG5stop(MHEG5Root *target, MHEG5GList *params);
 */

/*
   Debug
 */
#ifdef MH5PRINTOUT

void MHEG5programPrint(MHEG5Program *program, char *out);
#endif

#endif /*_MH5PROGRAM_H*/