source/dscore/src/siQuery.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 _SIQUERY_H_
#define _SIQUERY_H_


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


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

#ifdef __cplusplus
extern "C" {
#endif


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

#define SI_QUERY_MAGIC    0xC537D89E


/*******************
* EXPORTED TYPES   *
********************/

typedef enum {
    SIQS_INITIAL = 0,
    SIQS_PENDING,   /* -- Waiting for results to be supplied asynchronously */
    SIQS_COMPLETED, /* -- Results supplied */
    SIQS_ABORTED,   /* -- Aborted before results supplied */
    SIQS_EXPIRED    /* -- Aborted before results supplied but has duplicates */
} SiQueryState_t;

typedef struct  {
    S_LLObject          llData[NUM_LISTS_SI_QUERY];

    U32BIT              magic;
    SiQueryState_t      state;

    clDsmSIQuery_t      query;
    void*               target;

    void*               queryHandle;    /* -- External handle */

    P_LLControl         llcDuplSiQuerys;   /* -- Only used if original == True */
    BOOLEAN             original;           /* -- original or duplicate (False) */

} SiQuery_t, *pSiQuery_t;


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

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

clDsmErr_t siQueryStart( pclDsmInstData_t idp,
    /*I*/ pclDsmSIQuery_t pQueryData, void* queryTarget,
    /*O*/ clDsmSIQueryResult_t *pResult );

void siQueryAbortPending( pclDsmInstData_t idp,
    /*IO*/ MemHandle *phPendingSiQueryRef );

void siQueryStop( pclDsmInstData_t idp,
    /*IO*/ MemHandle *phSiQueryRef );

clDsmErr_t siQueryProcessResult( pclDsmInstData_t idp,
    /*I*/ MemHandle hSiQueryRef, pclDsmSIQueryResult_t pResult );

#ifdef GET_PID_LIST
clDsmErr_t siQueryGetPIDList( pclDsmInstData_t idp );
#endif /*GET_PID_LIST*/

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