libmicrohttpd2

HTTP server C library (MHD 2.x, alpha)
Log | Files | Refs | README | LICENSE

h2_stream_data.h (4104B)

      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_stream_data.h
     41  * @brief  Definition of structure for HTTP/2 stream data
     42  * @author Karlson2k (Evgeny Grin)
     43  */
     44 
     45 #ifndef MHD_H2_STREAM_DATA_H
     46 #define MHD_H2_STREAM_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_dlinked_list.h"
     54 #include "mhd_handle_tag.h"
     55 
     56 #include "h2_err_codes.h"
     57 
     58 #include "h2_req_data.h"
     59 
     60 #define mhd_H2_REQ_ITEM_POS_INVALID     ((size_t) (~((size_t) 0u)))
     61 
     62 #ifndef MHD_SIZE_UNKNOWN
     63 #  define MHD_SIZE_UNKNOWN ((uint_least64_t) 0xFFFFFFFFFFFFFFFFu)
     64 #endif /* MHD_SIZE_UNKNOWN */
     65 
     66 struct MHD_Connection;  /* forward declaration */
     67 struct MHD_Response;    /* forward declaration */
     68 
     69 enum mhd_H2ReplyStage
     70 {
     71   /**
     72    * Headers should be formed and sent
     73    */
     74   mhd_H2_RPL_STAGE_HEADERS_INCOMPLETE = 0,
     75   mhd_H2_RPL_STAGE_HEADERS_COMPLETE,
     76   mhd_H2_RPL_STAGE_TRAILERS_INCOMPLETE,
     77   mhd_H2_RPL_STAGE_END_STREAM,
     78   mhd_H2_RPL_STAGE_BROKEN
     79 };
     80 
     81 struct mhd_H2ReplyFieldsData
     82 {
     83   bool auto_cntn_len;
     84 
     85   size_t num_sent;
     86 };
     87 
     88 struct mhd_H2ReplyData
     89 {
     90   /**
     91    * Response to transmit (initially NULL).
     92    */
     93   struct MHD_Response *response;
     94 
     95   enum mhd_H2ReplyStage stage;
     96 
     97   struct mhd_H2ReplyFieldsData fields;
     98 
     99   uint_fast64_t cntn_read_pos;
    100 
    101 
    102   bool send_content;
    103 };
    104 
    105 struct mhd_H2StreamState
    106 {
    107   int_least32_t send_window;
    108 
    109   int_least32_t recv_window;
    110 
    111   bool rcvd_rst_stream;
    112   enum mhd_H2ErrorCode peer_err;
    113 
    114   bool sent_rst_stream;
    115   enum mhd_H2ErrorCode mhd_err;
    116 };
    117 
    118 struct mhd_H2Stream; /* Forward declaration */
    119 
    120 mhd_DLINKEDL_LINKS_DEF (mhd_H2Stream);
    121 
    122 struct mhd_H2Stream
    123 {
    124 #ifdef mhd_MULTI_HTTP_VER_BUILD
    125   /**
    126    * The handle tag.
    127    * Must be the first member, see #mhd_HandleTag.
    128    * Always indicates HTTP/2 for this structure.
    129    */
    130   struct mhd_HandleTag tag;
    131 #endif /* mhd_MULTI_HTTP_VER_BUILD */
    132 
    133   uint_least32_t stream_id;
    134 
    135   /**
    136    * The links in the container
    137    */
    138   mhd_DLNKDL_LINKS (mhd_H2Stream, streams);
    139 
    140   /**
    141    * The links in the sending list (when sending only)
    142    */
    143   mhd_DLNKDL_LINKS (mhd_H2Stream, send_q);
    144 
    145   /**
    146    * Pointer to the connection structure which is processing this stream
    147    */
    148   struct MHD_Connection *c;
    149 
    150   struct mhd_H2RequestData req;
    151 
    152   struct mhd_H2ReplyData rpl;
    153 
    154   struct mhd_H2StreamState state;
    155 };
    156 
    157 #endif /* ! MHD_H2_STREAM_DATA_H */