src/main/common/circular_queue.h

   1 /*
   2  * This file is part of INAV Project.
   3  *
   4  * This Source Code Form is subject to the terms of the Mozilla Public
   5  * License, v. 2.0. If a copy of the MPL was not distributed with this file,
   6  * You can obtain one at http://mozilla.org/MPL/2.0/.
   7  *
   8  * Alternatively, the contents of this file may be used under the terms
   9  * of the GNU General Public License Version 3, as described below:
  10  *
  11  * This file is free software: you may copy, redistribute and/or modify
  12  * it under the terms of the GNU General Public License as published by the
  13  * Free Software Foundation, either version 3 of the License, or (at your
  14  * option) any later version.
  15  *
  16  * This file is distributed in the hope that it will be useful, but
  17  * WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General
  19  * Public License for more details.
  20  *
  21  * You should have received a copy of the GNU General Public License
  22  * along with this program. If not, see http://www.gnu.org/licenses/.
  23  */
  24
  25 #ifndef INAV_CIRCULAR_QUEUE_H
  26 #define INAV_CIRCULAR_QUEUE_H
  27
  28 #include "stdint.h"
  29 #include "string.h"
  30
  31 typedef struct circularBuffer_s{
  32     size_t head;
  33     size_t tail;
  34     size_t bufferSize;
  35     uint8_t * buffer;
  36     size_t elementSize;
  37     size_t size;
  38 }circularBuffer_t;
  39
  40 void    circularBufferInit(circularBuffer_t * circularBuffer, uint8_t * buffer, size_t bufferSize, size_t bufferElementSize);
  41 void    circularBufferPushElement(circularBuffer_t * circularBuffer, uint8_t * element);
  42 void    circularBufferPopHead(circularBuffer_t * circularBuffer, uint8_t * element);
  43 int     circularBufferIsFull(circularBuffer_t * circularBuffer);
  44 int     circularBufferIsEmpty(circularBuffer_t *circularBuffer);
  45 size_t  circularBufferCountElements(circularBuffer_t * circularBuffer);
  46
  47 #endif //INAV_CIRCULAR_QUEUE_H