glue_timers.h

Go to the documentation of this file.

/*******************************************************************************
 * Copyright © 2014 The DTVKit Open Software Foundation Ltd (www.dtvkit.org)
 * Copyright © 2005 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 _MHEGTIMERS_H
#define _MHEGTIMERS_H

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

#include <techtype.h>
#include "mherrors.h"

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

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

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

typedef void *H_Timer;

/*******************************************************************************
 * NAME: F_TimerCallback
 *       Callback called either when a timer expires or an unexpired timer is
 *       destroyed.
 *
 * Returns : void
 *
 * Parameter     Flow    Description
 * ------------------------------------------------------------------------------
 * triggered     IN      True when the callback is invoked because the timer has
 *                       expired, otherwise false.
 * callerRef     IN      Caller reference which was passed when the timer was
 *                       created.
 * timerHandle   IN      Handle of the timer that caused the callback to be
 *                       invoked.
 *
 *******************************************************************************/
typedef void (*F_TimerCallback)( BOOLEAN triggered,
   void *callerRef,
   H_Timer timerHandle );

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

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

#define mhegTimerCreate VT_TimerCreate
#define mhegTimerDestroy VT_TimerDestroy

E_MhegErr VT_TimerCreate( U32BIT millisecs, F_TimerCallback callback,
   void *callerRef, H_Timer *pTimerHandle);

E_MhegErr VT_TimerDestroy( H_Timer timerHandle );


E_MhegErr VT_TimersInit(U32BIT task_priority);

E_MhegErr VT_TimersExit(void);

#endif /*_MHEGTIMERS_H*/