mhd_read_file.h (3500B)
1 /* SPDX-License-Identifier: LGPL-2.1-or-later OR (GPL-2.0-or-later WITH eCos-exception-2.0) */ 2 /* 3 This file is part of GNU libmicrohttpd. 4 Copyright (C) 2024 Evgeny Grin (Karlson2k) 5 6 GNU libmicrohttpd is free software; you can redistribute it and/or 7 modify it under the terms of the GNU Lesser General Public 8 License as published by the Free Software Foundation; either 9 version 2.1 of the License, or (at your option) any later version. 10 11 GNU libmicrohttpd is distributed in the hope that it will be useful, 12 but WITHOUT ANY WARRANTY; without even the implied warranty of 13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 14 Lesser General Public License for more details. 15 16 Alternatively, you can redistribute GNU libmicrohttpd and/or 17 modify it under the terms of the GNU General Public License as 18 published by the Free Software Foundation; either version 2 of 19 the License, or (at your option) any later version, together 20 with the eCos exception, as follows: 21 22 As a special exception, if other files instantiate templates or 23 use macros or inline functions from this file, or you compile this 24 file and link it with other works to produce a work based on this 25 file, this file does not by itself cause the resulting work to be 26 covered by the GNU General Public License. However the source code 27 for this file must still be made available in accordance with 28 section (3) of the GNU General Public License v2. 29 30 This exception does not invalidate any other reasons why a work 31 based on this file might be covered by the GNU General Public 32 License. 33 34 You should have received copies of the GNU Lesser General Public 35 License and the GNU General Public License along with this library; 36 if not, see <https://www.gnu.org/licenses/>. 37 */ 38 39 /** 40 * @file src/mhd2/mhd_read_file.h 41 * @brief The declaration of mhd_read_file() function 42 * @author Karlson2k (Evgeny Grin) 43 */ 44 45 #ifndef MHD_READ_FILE_H 46 #define MHD_READ_FILE_H 1 47 48 #include "mhd_sys_options.h" 49 50 #include "sys_base_types.h" 51 52 /** 53 * Results of file reading 54 */ 55 enum mhd_FileReadResult 56 { 57 /** 58 * File read succeed 59 */ 60 mhd_FILE_READ_OK = 0 61 , 62 /** 63 * File read failed 64 */ 65 mhd_FILE_READ_ERROR 66 , 67 /** 68 * The requested offset is too large 69 */ 70 mhd_FILE_READ_OFFSET_TOO_LARGE 71 , 72 /** 73 * Got "end of file" 74 */ 75 mhd_FILE_READ_EOF 76 }; 77 78 79 /** 80 * Perform one iteration of data reading from the file to the provided buffer. 81 * 82 * This function may read the file completely or just some part of it -- the 83 * amount is not controlled. Whatever is provided by the OS on a single file 84 * read operation is returned. 85 * 86 * @param file_fd the FD of file to read 87 * @param offset the offset in the file to read from 88 * @param buf_size the size of the @a buf buffer 89 * @param[out] buf the buffer to fill with the read data 90 * @param[out] size_filled the pointer to variable to get the size of the data 91 * actually put to the @a buffer 92 * @return #mhd_FILE_READ_OK if read succeeded (the @a size_filled gets 93 * the actual read size), 94 * error otherwise 95 */ 96 MHD_INTERNAL enum mhd_FileReadResult 97 mhd_read_file (int file_fd, 98 uint_fast64_t offset, 99 size_t buf_size, 100 char buf[MHD_FN_PAR_DYN_ARR_SIZE_ (buf_size)], 101 size_t *restrict size_filled) 102 MHD_FN_MUST_CHECK_RESULT_ MHD_FN_PAR_NONNULL_ALL_ 103 MHD_FN_PAR_OUT_SIZE_(4, 3) MHD_FN_PAR_OUT_ (5); 104 105 106 #endif /* ! MHD_READ_FILE_H */