h2_proc_conn.h (4105B)
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_proc_conn.h 41 * @brief Declarations of HTTP/2 connection processing functions 42 * @author Karlson2k (Evgeny Grin) 43 */ 44 45 #ifndef MHD_H2_PROC_CONN_H 46 #define MHD_H2_PROC_CONN_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 "h2_err_codes.h" 54 55 struct MHD_Connection; /* forward declaration */ 56 struct mhd_Buffer; /* forward declaration */ 57 union mhd_H2FrameUnion; /* forward declaration */ 58 59 /** 60 * Process the first incoming frame 61 * @param c the connection to process 62 * @return 'true' if successfully processed, HTTP/2 connection is fully ready; 63 * 'false' if HTTP/2 connection cannot be used (not ready or broken) 64 */ 65 MHD_INTERNAL bool 66 mhd_h2_conn_process_first_fr (struct MHD_Connection *restrict c) 67 MHD_FN_PAR_NONNULL_ALL_; 68 69 70 /** 71 * Process all changes in the connection. 72 * Create outgoing control frames as necessary, handle errors. 73 * @param c the connection to process 74 * @return 'true' if successfully processed, HTTP/2 processing may continue 75 * 'false' if not enough output buffer to send the control frames or 76 * if connection is broken, HTTP/2 procession may not continue 77 */ 78 MHD_INTERNAL bool 79 mhd_h2_conn_process_changes (struct MHD_Connection *restrict c) 80 MHD_FN_PAR_NONNULL_ALL_; 81 82 83 MHD_INTERNAL bool 84 mhd_h2_conn_process_in_goaway (struct MHD_Connection *restrict c, 85 uint_least32_t last_stream_id, 86 enum mhd_H2ErrorCode err) 87 MHD_FN_PAR_NONNULL_ALL_; 88 89 90 MHD_INTERNAL bool 91 mhd_h2_conn_update_stream_init_window (struct MHD_Connection *restrict c, 92 uint_least32_t init_wind_size) 93 MHD_FN_PAR_NONNULL_ALL_; 94 95 /** 96 * Transition connection to closing state, queue relevant frame for peer. 97 * @param c the connection to process 98 * @param err the error code to use 99 * @param forced if 'true' connection will start closing even if there is 100 * no space to form peer notification frame 101 * @return 'true' if succeed, 102 * 'false' if output buffer has no space 103 */ 104 MHD_INTERNAL bool 105 mhd_h2_conn_finish (struct MHD_Connection *restrict c, 106 enum mhd_H2ErrorCode err, 107 bool forced) 108 MHD_FN_PAR_NONNULL_ALL_; 109 110 #endif /* ! MHD_H2_PROC_CONN_H */