libmicrohttpd2

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

h2_req_data.h (4260B)

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