/******************************************************************************
 * file    include/file_fifo.h 
 * author  YuLiang
 * version 1.0.0
 * date    10-Jun-2025
 * brief   This file provides all the headers of the file fifo functions.
 
 ******************************************************************************
 * Attention
 *
 * <h2><center>&copy; COPYRIGHT(c) 2025 LandPower</center></h2>
 *
 * 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.
 *   3. Neither the name of LandPower 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 HOLDER 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 _FILE_FIFO_H_
#define _FILE_FIFO_H_

/* Includes ------------------------------------------------------------------*/

/* Define --------------------------------------------------------------------*/
#define FILE_FIFO_PATH_LEN 256

/* Exported types ------------------------------------------------------------*/
/* 配置文件结构体 */
typedef struct
{
    char dir[FILE_FIFO_PATH_LEN];       // 目录路径
    int32_t files_max;                  // 存储最大文件数量
    int64_t index_min;                  // 目录当前最小索引
    int64_t index_max;                  // 目录当前最大索引, 该索引为下次下入的文件名
} file_fifo_t;

/* Exported macro ------------------------------------------------------------*/

/* Extern global variables ---------------------------------------------------*/

/* Extern functions ----------------------------------------------------------*/
extern int32_t file_fifo_write(file_fifo_t *config, const char *content, int32_t len);
extern int32_t file_fifo_read(file_fifo_t *config, char *content, int32_t *len);
extern void file_fifo_delete_by_min_index(file_fifo_t *config);
extern int32_t file_fifo_init(file_fifo_t *config);

#endif
/************************ (C) COPYRIGHT LandPower ***** END OF FILE ****************/