mirror of
https://github.com/FreeRTOS/FreeRTOS-Plus-TCP
synced 2025-10-22 07:51:40 +08:00
7af0bfe578
* Stream Buffer Const Correctness * cleanup & simplify * Uncrustify: triggered by comment. * fix test * add const for pass by value parameters * don't change parameters * remove pass by value parameter consts --------- Co-authored-by: Holden <holden-zenithaerotech.com> Co-authored-by: Holden <68555040+holden-zenith@users.noreply.github.com> Co-authored-by: GitHub Action <action@github.com> Co-authored-by: Holden <holden@zenithaerotech.com> Co-authored-by: Tony Josi <tonyjosi@amazon.com>
102 lines
3.9 KiB
C
102 lines
3.9 KiB
C
/*
|
|
* FreeRTOS+TCP <DEVELOPMENT BRANCH>
|
|
* Copyright (C) 2022 Amazon.com, Inc. or its affiliates. All Rights Reserved.
|
|
*
|
|
* SPDX-License-Identifier: MIT
|
|
*
|
|
* Permission is hereby granted, free of charge, to any person obtaining a copy of
|
|
* this software and associated documentation files (the "Software"), to deal in
|
|
* the Software without restriction, including without limitation the rights to
|
|
* use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
|
|
* the Software, and to permit persons to whom the Software is furnished to do so,
|
|
* subject to the following conditions:
|
|
*
|
|
* The above copyright notice and this permission notice shall be included in all
|
|
* copies or substantial portions of the Software.
|
|
*
|
|
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
|
|
* FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
|
|
* COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
|
|
* IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
|
|
* CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
|
*
|
|
* http://aws.amazon.com/freertos
|
|
* http://www.FreeRTOS.org
|
|
*/
|
|
|
|
/*
|
|
* FreeRTOS_Stream_Buffer.h
|
|
*
|
|
* An implementation of a circular character buffer without a length field
|
|
* If LENGTH defines the size of the buffer, a maximum of (LENGTH-1) bytes can be stored
|
|
* In order to add or read data from the buffer, memcpy() will be called at most 2 times
|
|
*/
|
|
|
|
#ifndef FREERTOS_STREAM_BUFFER_H
|
|
#define FREERTOS_STREAM_BUFFER_H
|
|
|
|
/* *INDENT-OFF* */
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
/* *INDENT-ON* */
|
|
|
|
/* Struct to store all the details of a stream buffer. */
|
|
typedef struct xSTREAM_BUFFER
|
|
{
|
|
volatile size_t uxTail; /**< next item to read */
|
|
volatile size_t uxMid; /**< iterator within the valid items */
|
|
volatile size_t uxHead; /**< next position store a new item */
|
|
volatile size_t uxFront; /**< iterator within the free space */
|
|
size_t LENGTH; /**< const value: number of reserved elements */
|
|
uint8_t ucArray[ sizeof( size_t ) ]; /**< array big enough to store any pointer address */
|
|
} StreamBuffer_t;
|
|
|
|
size_t uxStreamBufferSpace( const StreamBuffer_t * const pxBuffer,
|
|
size_t uxLower,
|
|
size_t uxUpper );
|
|
|
|
size_t uxStreamBufferDistance( const StreamBuffer_t * const pxBuffer,
|
|
size_t uxLower,
|
|
size_t uxUpper );
|
|
|
|
size_t uxStreamBufferGetSpace( const StreamBuffer_t * const pxBuffer );
|
|
|
|
size_t uxStreamBufferFrontSpace( const StreamBuffer_t * const pxBuffer );
|
|
|
|
size_t uxStreamBufferGetSize( const StreamBuffer_t * const pxBuffer );
|
|
|
|
size_t uxStreamBufferMidSpace( const StreamBuffer_t * pxBuffer );
|
|
|
|
void vStreamBufferClear( StreamBuffer_t * const pxBuffer );
|
|
|
|
void vStreamBufferMoveMid( StreamBuffer_t * const pxBuffer,
|
|
const size_t uxCount );
|
|
|
|
BaseType_t xStreamBufferLessThenEqual( const StreamBuffer_t * const pxBuffer,
|
|
size_t uxLeft,
|
|
size_t uxRight );
|
|
|
|
size_t uxStreamBufferGetPtr( StreamBuffer_t * const pxBuffer,
|
|
uint8_t ** const ppucData );
|
|
|
|
size_t uxStreamBufferAdd( StreamBuffer_t * const pxBuffer,
|
|
size_t uxOffset,
|
|
const uint8_t * const pucData,
|
|
size_t uxByteCount );
|
|
|
|
size_t uxStreamBufferGet( StreamBuffer_t * const pxBuffer,
|
|
size_t uxOffset,
|
|
uint8_t * const pucData,
|
|
size_t uxMaxCount,
|
|
BaseType_t xPeek );
|
|
|
|
/* *INDENT-OFF* */
|
|
#ifdef __cplusplus
|
|
} /* extern "C" */
|
|
#endif
|
|
/* *INDENT-ON* */
|
|
|
|
#endif /* FREERTOS_STREAM_BUFFER_H */
|