ResTrack.h

Go to the documentation of this file.

/* 
 *  ============================================================================
 *
 *  Copyright (c) 2008-2012, Texas Instruments Incorporated
 *
 *  Redistribution and use in source and binary forms, with or without
 *  modification, are permitted provided that the following conditions
 *  are met:
 *  
 *  *  Redistributions of source code must retain the above copyright
 *     notice, this list of conditions and the following disclaimer.
 *  
 *  *  Redistributions in binary form must reproduce the above copyright
 *     notice, this list of conditions and the following disclaimer in the
 *     documentation and/or other materials provided with the distribution.
 *  
 *  *  Neither the name of Texas Instruments Incorporated nor the names of
 *     its contributors may be used to endorse or promote products derived
 *     from this software without specific prior written permission.
 *  
 *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 *  AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
 *  THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 *  PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
 *  CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 *  EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 *  PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
 *  OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
 *  WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
 *  OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
 *  EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *  Contact information for paper mail:
 *  Texas Instruments
 *  Post Office Box 655303
 *  Dallas, Texas 75265
 *  Contact information: 
 *  http://www-k.ext.ti.com/sc/technical-support/product-information-centers.htm?
 *  DCMP=TIHomeTracking&HQS=Other+OT+home_d_contact
 *  ============================================================================
 *  
 */


#ifndef ti_syslink_utils_ResTrack__include
#define ti_syslink_utils_ResTrack__include

#include <ti/syslink/osal/OsalTypes.h>
#include <ti/syslink/utils/List.h>


#if defined (__cplusplus)
extern "C" {
#endif


/* =============================================================================
 *  Macros and types
 * =============================================================================
 */

#define ResTrack_S_SUCCESS      0
#define ResTrack_E_FAIL         (-1) 
#define ResTrack_E_MEMORY       (-2) 
#define ResTrack_E_PID          (-3) 
#define ResTrack_E_NOTFOUND     (-4) 


typedef Bool (*ResTrack_Fxn)(Void *ptrA, Void *ptrB);

typedef struct ResTrack_Object *ResTrack_Handle;

typedef struct {
    Int temp;
} ResTrack_Params;


/* =============================================================================
 *  APIs
 * =============================================================================
 */
Void ResTrack_Params_init(ResTrack_Params *params);

ResTrack_Handle ResTrack_create(ResTrack_Params *params);

Void ResTrack_delete(ResTrack_Handle *handlePtr);

Int ResTrack_pop(ResTrack_Handle handle, Osal_Pid pid, List_Elem **resPtr);

Int ResTrack_push(ResTrack_Handle handle, Osal_Pid pid, List_Elem *res);

Int ResTrack_register(ResTrack_Handle handle, Osal_Pid pid);

Int ResTrack_remove(ResTrack_Handle handle, Osal_Pid pid, List_Elem *ref,
        ResTrack_Fxn cmpFxn, List_Elem **resPtr);

Int ResTrack_unregister(ResTrack_Handle handle, Osal_Pid pid);


#if defined (__cplusplus)
}
#endif

#endif /* ti_syslink_utils_ResTrack__include */