libmicrohttpd2

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

stream_process_states.h (3069B)


      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) 2024 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/stream_process_states.h
     41  * @brief  The declarations of internal functions for processing
     42  *         stream states
     43  * @author Karlson2k (Evgeny Grin)
     44  */
     45 
     46 #ifndef MHD_STREAM_PROCESS_STATES_H
     47 #define MHD_STREAM_PROCESS_STATES_H 1
     48 
     49 #include "mhd_sys_options.h"
     50 
     51 #include "sys_bool_type.h"
     52 
     53 struct MHD_Connection; /* forward declaration */
     54 
     55 /**
     56  * Update event loop state for the connection.
     57  * Event loop state indicates current stage: sending or receiving the data.
     58  * The underlying connection layer (plain TCP or TLS) must be already connected.
     59  * @param c the connection to process
     60  */
     61 MHD_INTERNAL void
     62 mhd_conn_event_loop_state_update (struct MHD_Connection *restrict c)
     63 MHD_FN_PAR_NONNULL_ALL_;
     64 
     65 /**
     66  * Process states and the data for the connection.
     67  * For HTTP/1.1: connection is equal stream.
     68  * The function updates the states of the connection.
     69  * The underlying connection layer (plain TCP or TLS) must be already connected.
     70  * @param c the connection to process
     71  * @return true if states and data has been successfully processed,
     72  *         false if connection needs to be closed
     73  */
     74 MHD_INTERNAL bool
     75 mhd_conn_process_data (struct MHD_Connection *restrict c)
     76 MHD_FN_PAR_NONNULL_ALL_;
     77 
     78 #endif /* ! MHD_STREAM_PROCESS_STATES_H */