dsmObject.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 © 2002 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 _DSMOBJECT_H_
#define _DSMOBJECT_H_


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

#include "clDsmSystem.h"
#include "linkList.h"
#include "object.h"

#ifdef __cplusplus
extern "C" {
#endif


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


#define DSM_OBJECT_MAGIC    0xF1D3B597

#define DSM_OBJECT_VALIDATE( pDsmObject )   \
            (pDsmObject->magic == DSM_OBJECT_MAGIC)

#define DEFFERED_SERVICE_RECEIVED  0xD0FE

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

typedef struct _clDsmObjectHandle_struct DsmObject_t, *pDsmObject_t;


struct _clDsmObjectHandle_struct {
   S_LLObject          llData[NUM_LISTS_OBJECT];

   U32BIT              magic;
   MemHandle           myHandle;

   clDsmObjLoadStatus_t status;

   clDsmCachingRules_t cachingRules;

   clDsmObjectKind_t   kind;

   pObjectCarousel_t   pObjCarousel;
   MemHandle           hModule;

   ObjectDataInfo_t    objectInfo;
   U32BIT              objectDataOffset;
   MemSeqRef           objectDataSeq;

   /* Use of below depends on 'status' */
   union {
      MemHandle        hLoadRequest;       /* non-NULL when (status == OBJ_LOAD_IN_PROGRESS) */
      MemHandle        hPendingSiQueryRef; /* non-NULL when (status == OBJ_LOAD_COMPLETED) and getting deferred service */
   } r;

   /* Use of below depends on 'kind', and only valid when (status == OBJ_LOAD_COMPLETED) */
   union {
      /* deferred service query - temporary held data, while (hPendingSiQueryRef != NULL) */
      struct {
         void* userData1;
         void* userData2;
      } ds;

      /* stream object, deferred service */
      struct {
         S_DvbLocator   multiplex;
         U16BIT         retrieved;
      } so;

      /* directory object ...*/

   } data;
};

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

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

clDsmErr_t objectCreate( pclDsmInstData_t idp, MemHandle *phObject );

void objectDestroy( pclDsmInstData_t idp, MemHandle *phObject );


/*----------------------------------------------------------------------------*/
#ifdef __cplusplus
}
#endif
#endif /* _DSMOBJECT_H_ */