h2_req_data.h (4472B)
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) 2025 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/h2/h2_req_data.h 41 * @brief Definition of HTTP/2 request data structure 42 * @author Karlson2k (Evgeny Grin) 43 */ 44 45 #ifndef MHD_H2_REQ_DATA_H 46 #define MHD_H2_REQ_DATA_H 1 47 48 #include "mhd_sys_options.h" 49 50 #include "sys_bool_type.h" 51 #include "sys_base_types.h" 52 53 #include "mhd_handle_tag.h" 54 55 #include "http_method.h" 56 57 struct MHD_Connection; /* Forward declaration */ 58 59 60 enum MHD_FIXED_ENUM_ mhd_H2ReqStage 61 { 62 /** 63 * Headers are not completely received. 64 * Processing the opening HEADERS frame or receiving and processing 65 * CONTINUATION frames. 66 */ 67 mhd_H2_REQ_STAGE_HEADERS_INCOMPLETE 68 , 69 mhd_H2_REQ_STAGE_HEADERS_DECODING 70 , 71 mhd_H2_REQ_STAGE_HEADERS_PROCESSING 72 , 73 /** 74 * Headers are completely received. 75 * DATA frames or second HEADERS frame (containing trailers) can be received. 76 */ 77 mhd_H2_REQ_STAGE_HEADERS_COMPLETE 78 , 79 /** 80 * Trailers are not completely received. 81 * Processing the second HEADERS frame (which started trailers) or receiving 82 * and processing CONTINUATION frames. 83 */ 84 mhd_H2_REQ_STAGE_TRAILERS_INCOMPLETE 85 , 86 mhd_H2_REQ_STAGE_TRAILERS_DECODING 87 , 88 mhd_H2_REQ_STAGE_TRAILERS_PROCESSING 89 , 90 /** 91 * The client must not send any HEADERS or DATA frames. 92 */ 93 mhd_H2_REQ_STAGE_END_STREAM 94 , 95 /** 96 * Any frames ignored with RST_STREAM. 97 */ 98 mhd_H2_REQ_STAGE_BROKEN 99 100 }; 101 102 struct mhd_H2RequestData 103 { 104 #ifdef mhd_MULTI_HTTP_VER_BUILD 105 /** 106 * The handle tag. 107 * Must be the first member, see #mhd_HandleTag. 108 * Always indicates HTTP/2 for this structure. 109 */ 110 struct mhd_HandleTag tag; 111 #endif /* mhd_MULTI_HTTP_VER_BUILD */ 112 113 enum mhd_H2ReqStage stage; 114 115 /** 116 * 'true' when 'end stream' flag was received. The stage could be still 117 * #mhd_H2_REQ_STAGE_HEADERS_INCOMPLETE or 118 * #mhd_H2_REQ_STAGE_TRAILERS_INCOMPLETE as CONTINUATION frames are being 119 * processed 120 */ 121 bool got_end_stream; 122 123 enum mhd_HTTP_Method method; 124 125 uint_fast64_t cntn_size; 126 127 /** 128 * Position of ":method" pseudo-header in request items block. 129 * Set to #mhd_H2_REQ_ITEM_POS_INVALID if not available. 130 */ 131 size_t pos_method; 132 /** 133 * Position of ":path" pseudo-header in request items block. 134 * Set to #mhd_H2_REQ_ITEM_POS_INVALID if not available. 135 */ 136 size_t pos_path; 137 /** 138 * Position of ":authority" pseudo-header or "Host" header in request items 139 * block. 140 * Set to #mhd_H2_REQ_ITEM_POS_INVALID if not available. 141 */ 142 size_t pos_authority; 143 144 struct mhd_ApplicationAction app_act; 145 146 /** 147 * Set to 'true' when application gets any information about this 148 * request or stream. 149 */ 150 bool app_seen; 151 152 void *app_context; 153 }; 154 155 #endif /* ! MHD_H2_REQ_DATA_H */