h2_proc_settings.h (3874B)
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_settings.h 41 * @brief Declarations of HTTP/2 connection settings processing functions 42 * @author Karlson2k (Evgeny Grin) 43 */ 44 45 #ifndef MHD_H2_PROC_SETTINGS_H 46 #define MHD_H2_PROC_SETTINGS_H 1 47 48 #include "mhd_sys_options.h" 49 50 #include "sys_bool_type.h" 51 52 /** 53 * Default value of Initial Window Size 54 */ 55 #define mhd_H2_STNG_DEF_INIT_WIN_SIZE (65535u) 56 57 /** 58 * Minimal allowed value of Maximum Frame Size 59 */ 60 #define mhd_H2_STNG_MIN_MAX_FRAME_SIZE (16384u) 61 62 /** 63 * Maximum allowed value of Maximum Frame Size 64 */ 65 #define mhd_H2_STNG_MAX_MAX_FRAME_SIZE (16777215u) 66 67 /** 68 * Default value of Maximum Frame Size 69 */ 70 #define mhd_H2_STNG_DEF_MAX_FRAME_SIZE mhd_H2_STNG_MIN_MAX_FRAME_SIZE 71 72 struct MHD_Connection; /* forward declaration */ 73 struct mhd_Buffer; /* forward declaration */ 74 75 enum mhd_H2SettingsProcessResult 76 { 77 /** 78 * Settings processed. 79 * Settings ACK queued. 80 */ 81 mhd_H2_STNGS_PROC_OK = 0 82 , 83 /** 84 * No output buffer space to queue settings ACK. 85 * The frame should be processed later again 86 */ 87 mhd_H2_STNGS_PROC_NO_OUT_BUFF 88 , 89 /** 90 * Settings error. 91 * GOAWAY frame queued, connection marked as closing 92 */ 93 mhd_H2_STNGS_PROC_STNGS_ERR 94 }; 95 96 /** 97 * Process first settings frame sent by peer 98 * @param c the connection to use 99 * @param stngs_payload the payload of the settings frame 100 * @return 'true' if setting successfully processed; 101 * 'false' on failure, GOAWAY queued if possible and connection 102 * is marked as "closing" or "broken". 103 */ 104 MHD_INTERNAL bool 105 mhd_h2_proc_first_settings (struct MHD_Connection *restrict c, 106 const struct mhd_Buffer *restrict stngs_payload) 107 MHD_FN_PAR_NONNULL_ALL_; 108 109 MHD_INTERNAL enum mhd_H2SettingsProcessResult 110 mhd_h2_proc_new_settings (struct MHD_Connection *restrict c, 111 const struct mhd_Buffer *restrict stngs_payload) 112 MHD_FN_PAR_NONNULL_ALL_; 113 114 115 MHD_INTERNAL bool 116 mhd_h2_q_settings_first_fr (struct MHD_Connection *restrict c) 117 MHD_FN_PAR_NONNULL_ALL_; 118 119 #endif /* ! MHD_H2_PROC_SETTINGS_H */