amxc_aqueue.h

Go to the documentation of this file.

/****************************************************************************
**
** SPDX-License-Identifier: BSD-2-Clause-Patent
**
** SPDX-FileCopyrightText: Copyright (c) 2023 SoftAtHome
**
** Redistribution and use in source and binary forms, with or without modification,
** are permitted provided that the following conditions are met:
**
** 1. Redistributions of source code must retain the above copyright notice,
** this list of conditions and the following disclaimer.
**
** 2. 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.
**
** Subject to the terms and conditions of this license, each copyright holder
** and contributor hereby grants to those receiving rights under this license
** a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable
** (except for failure to satisfy the conditions of this license) patent license
** to make, have made, use, offer to sell, sell, import, and otherwise transfer
** this software, where such license applies only to those patent claims, already
** acquired or hereafter acquired, licensable by such copyright holder or contributor
** that are necessarily infringed by:
**
** (a) their Contribution(s) (the licensed copyrights of copyright holders and
** non-copyrightable additions of contributors, in source or binary form) alone;
** or
**
** (b) combination of their Contribution(s) with the work of authorship to which
** such Contribution(s) was added by such copyright holder or contributor, if,
** at the time the Contribution is added, such addition causes such combination
** to be necessarily infringed. The patent license shall not apply to any other
** combinations which include the Contribution.
**
** Except as expressly stated above, no rights or licenses from any copyright
** holder or contributor is granted under this license, whether expressly, by
** implication, estoppel or otherwise.
**
** DISCLAIMER
**
** 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 HOLDERS 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.
**
****************************************************************************/
 
#if !defined(__AMXC_AQUEUE_H__)
#define __AMXC_AQUEUE_H__
 
#ifdef __cplusplus
extern "C"
{
#endif
 
#include <amxc/amxc_common.h>
#include <amxc/amxc_array.h>
 
typedef amxc_array_t amxc_aqueue_t;
 
typedef amxc_array_it_t amxc_aqueue_it_t;
 
typedef amxc_array_it_delete_t amxc_aqueue_it_delete_t;
 
AMXC_INLINE
int amxc_aqueue_new(amxc_aqueue_t** aqueue) {
    return amxc_array_new(aqueue, 10);
}
 
AMXC_INLINE
void amxc_aqueue_delete(amxc_aqueue_t** aqueue, amxc_aqueue_it_delete_t func) {
    amxc_array_delete(aqueue, func);
}
 
AMXC_INLINE
int amxc_aqueue_init(amxc_aqueue_t* const aqueue) {
    return amxc_array_init(aqueue, 10);
}
 
AMXC_INLINE
void amxc_aqueue_clean(amxc_aqueue_t* const aqueue,
                       amxc_aqueue_it_delete_t func) {
    amxc_array_clean(aqueue, func);
}
 
AMXC_INLINE
amxc_aqueue_it_t* amxc_aqueue_add(amxc_aqueue_t* const aqueue, void* data) {
    return amxc_array_append_data(aqueue, data);
}
 
AMXC_INLINE
void* amxc_aqueue_remove(amxc_aqueue_t* const aqueue) {
    void* rv = amxc_array_take_first_data(aqueue);
    amxc_array_shift_left(aqueue, 1, NULL);
    return rv;
}
 
AMXC_INLINE
size_t amxc_aqueue_size(const amxc_aqueue_t* const aqueue) {
    return amxc_array_size(aqueue);
}
 
AMXC_INLINE
size_t amxc_aqueue_is_empty(const amxc_aqueue_t* const aqueue) {
    return amxc_array_is_empty(aqueue);
}
 
#ifdef __cplusplus
}
#endif
 
#endif // __AMXC_AQUEUE_H__