request_funcs.h (3783B)
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) 2022-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/request_funcs.h 41 * @brief The declaration of the request internal functions 42 * @author Karlson2k (Evgeny Grin) 43 */ 44 45 #ifndef MHD_REQUEST_FUNCS_H 46 #define MHD_REQUEST_FUNCS_H 1 47 48 #include "mhd_sys_options.h" 49 #include "sys_bool_type.h" 50 #include "mhd_str_types.h" 51 #include "mhd_public_api.h" 52 53 struct MHD_Stream; /* forward declaration */ 54 55 /** 56 * Add field to the request. 57 * The memory allocated in the request memory pool 58 * 59 * @param s the stream to use 60 * @param kind the kind of the field to add 61 * @param name the name of the field to add, the string is not copied, 62 * only copied the pointer value 63 * @param value the value of the field to add, the string is not copied, 64 * only copied the pointer value 65 * @return true if succeed, 66 * false if memory cannot be allocated 67 */ 68 MHD_INTERNAL bool 69 mhd_stream_add_field (struct MHD_Stream *restrict s, 70 enum MHD_ValueKind kind, 71 const struct MHD_String *restrict name, 72 const struct MHD_String *restrict value) 73 MHD_FN_PAR_NONNULL_ALL_; 74 75 /** 76 * Add field to the request. 77 * The memory allocated in the request memory pool 78 * The value can have NULL string ("no value"). 79 * 80 * @param s the stream to use 81 * @param kind the kind of the field to add 82 * @param name the name of the field to add, the string is not copied, 83 * only copied the pointer value 84 * @param value the value of the field to add, the string is not copied, 85 * only copied the pointer value 86 * @return true if succeed, 87 * false if memory cannot be allocated 88 */ 89 MHD_INTERNAL bool 90 mhd_stream_add_field_nullable (struct MHD_Stream *restrict s, 91 enum MHD_ValueKind kind, 92 const struct MHD_String *restrict name, 93 const struct MHD_StringNullable *restrict value) 94 MHD_FN_PAR_NONNULL_ALL_; 95 96 #endif /* ! MHD_REQUEST_FUNCS_H */