respond_with_error.h (4237B)
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/respond_with_error.h 41 * @brief The declaration of error response functions and helper macros 42 * @author Karlson2k (Evgeny Grin) 43 */ 44 45 #ifndef MHD_RESPOND_WITH_ERROR_H 46 #define MHD_RESPOND_WITH_ERROR_H 1 47 48 #include "mhd_sys_options.h" 49 #include "sys_base_types.h" 50 #include "sys_null_macro.h" 51 #include "mhd_str_macros.h" 52 53 struct MHD_Connection; /* forward declaration */ 54 55 /** 56 * Respond with provided error response. 57 * Current request will be aborted, stream will be closed after sending 58 * error response. 59 * @param c the connection to use 60 * @param http_code the reply HTTP status code 61 * @param msg_len the length of the @a msg 62 * @param msg the reply content, could be NULL 63 * @param add_hdr_line_len the length the @a add_hdr_line 64 * @param add_hdr_line the additional special header line, could be NULL, 65 * if not NULL it will be deallocated by free(). 66 * 67 */ 68 MHD_INTERNAL void 69 respond_with_error_len (struct MHD_Connection *c, 70 unsigned int http_code, 71 size_t msg_len, 72 const char *msg, 73 size_t add_hdr_line_len, 74 char *add_hdr_line) 75 MHD_FN_PAR_NONNULL_ (1) 76 MHD_FN_PAR_CSTR_ (4) MHD_FN_PAR_CSTR_ (6); 77 78 #ifdef MHD_ENABLE_AUTO_MESSAGES_BODIES 79 /** 80 * Transmit static string as error response 81 */ 82 # define mhd_RESPOND_WITH_ERROR_STATIC(c, code, msg) \ 83 respond_with_error_len ((c), (code), \ 84 mhd_SSTR_LEN (msg), (msg), \ 85 0, NULL) 86 87 /** 88 * Transmit static string as error response and add specified header 89 */ 90 # define mhd_RESPOND_WITH_ERROR_HEADER(c,code,m,hdrl_l,hdrl) \ 91 respond_with_error_len ((c), (code), \ 92 mhd_SSTR_LEN (m), (m), \ 93 (hdrl_l), (hdrl)) 94 95 #else 96 /** 97 * Transmit static string as error response 98 */ 99 # define mhd_RESPOND_WITH_ERROR_STATIC(c, code, msg) \ 100 respond_with_error_len ((c), (code), \ 101 0, NULL, \ 102 0, NULL) 103 104 /** 105 * Transmit static string as error response and add specified header 106 */ 107 # define mhd_RESPOND_WITH_ERROR_HEADER(c,code,m,hdrl_l,hdrl) \ 108 respond_with_error_len ((c), (code), \ 109 0, NULL, \ 110 (hdrl_l), (hdrl)) 111 #endif 112 113 #endif /* ! MHD_RESPOND_WITH_ERROR_H */