libmicrohttpd2

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

upgrade_proc.h (3138B)

      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/upgrade_proc.h
     41  * @brief  The declaration of functions for processing data for HTTP Upgrade
     42  * @author Karlson2k (Evgeny Grin)
     43  */
     44 
     45 #ifndef MHD_UPGRADE_PROC_H
     46 #define MHD_UPGRADE_PROC_H 1
     47 
     48 #include "mhd_sys_options.h"
     49 
     50 #include "sys_bool_type.h"
     51 
     52 struct MHD_Connection; /* forward declaration */
     53 
     54 /**
     55  * Switch to "upgrading" state if the full upgrade headers have been sent
     56  * completely.
     57  * @param c the connection to use
     58  * @return 'true' if connection is switched to "upgrading" state,
     59  *         'false' if headers has not been sent completely yet.
     60  */
     61 MHD_INTERNAL bool
     62 mhd_upgrade_try_start_upgrading (struct MHD_Connection *restrict c)
     63 MHD_FN_PAR_NONNULL_ (1);
     64 
     65 
     66 /**
     67  * Switch connection to "upgraded" state, call application callback for
     68  * switching to "upgraded" state.
     69  * @param c the connection to use
     70  * @return 'true' if connection is switched to "upgraded" state,
     71  *         'false' if connection failed to switch (initialisation error).
     72  */
     73 MHD_INTERNAL bool
     74 mhd_upgrade_finish_switch_to_upgraded (struct MHD_Connection *restrict c)
     75 MHD_FN_PAR_NONNULL_ (1);
     76 
     77 
     78 /**
     79  * De-initialise HTTP-Upgraded-specific data
     80  * @param c the connection the de-initialise
     81  */
     82 MHD_INTERNAL void
     83 mhd_upgraded_deinit (struct MHD_Connection *restrict c)
     84 MHD_FN_PAR_NONNULL_ (1);
     85 
     86 #endif /* ! MHD_UPGRADE_PROC_H */