QueueP.h

Go to the documentation of this file.

/*
 * Copyright (c) 2017-present, Texas Instruments Incorporated
 * All rights reserved.
 *
 * 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.
 */

#ifndef ti_osal_QueueP__include
#define ti_osal_QueueP__include

#include <stdbool.h>
#include <stdint.h>
#include <stddef.h>

#ifdef __cplusplus
extern "C" {
#endif

typedef int32_t QueueP_Status;
#define QueueP_OK           (int32_t)(0)

#define QueueP_FAILURE      (int32_t)(-1)
/* @} */

typedef bool QueueP_State;
#define QueueP_NOTEMPTY            ((bool)false)

#define QueueP_EMPTY               ((bool)true)
/* @} */

typedef  void *QueueP_Handle;

typedef struct QueueP_Elem_s{
    struct QueueP_Elem_s *next;

    struct QueueP_Elem_s *prev;
} QueueP_Elem;

typedef struct QueueP_Params_s
{
    void *pErrBlk;     
} QueueP_Params;

extern void QueueP_Params_init(QueueP_Params *params);

extern QueueP_Handle QueueP_create(const QueueP_Params *params);

extern QueueP_Status QueueP_delete(QueueP_Handle handle);

extern void * QueueP_get(QueueP_Handle handle);

extern QueueP_Status QueueP_put(QueueP_Handle handle,
                                     void *elem);

extern QueueP_State QueueP_isEmpty(QueueP_Handle handle);

extern void * QueueP_getQPtr(QueueP_Handle handle);

#ifdef __cplusplus
}
#endif

#endif /* ti_osal_QueueP__include */
/* @} */