libmicrohttpd2

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

response_from.h (3149B)


      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/response_from.h
     41  * @brief  The declarations of internal functions for response creation and
     42  *         deletion
     43  * @author Karlson2k (Evgeny Grin)
     44  */
     45 
     46 #ifndef MHD_RESPONSE_FROM_H
     47 #define MHD_RESPONSE_FROM_H 1
     48 
     49 #include "mhd_sys_options.h"
     50 #include "sys_base_types.h"
     51 
     52 struct MHD_Response; /* forward declaration */
     53 
     54 /**
     55  * Deinit / free / cleanup content data of the response
     56  * @param r the response to use
     57  */
     58 MHD_INTERNAL void
     59 mhd_response_deinit_content_data (struct MHD_Response *restrict r)
     60 MHD_FN_PAR_NONNULL_ (1);
     61 
     62 /**
     63  * Create special internal-only response for sending automatic error messages
     64  * @param sc the HTTP status code (enum MHD_HTTP_StatusCode)
     65  * @param cntn_len the length of the @a cntn
     66  * @param cntn the response content
     67  * @param spec_hdr_len the length of the @a spec_hdr
     68  * @param spec_hdr the special string to be used as a header string
     69  * @return the response object if succeed,
     70  *         NULL if failed (out of memory)
     71  */
     72 MHD_INTERNAL struct MHD_Response *
     73 mhd_response_special_for_error (unsigned int sc,
     74                                 size_t cntn_len,
     75                                 const char *cntn,
     76                                 size_t spec_hdr_len,
     77                                 char *spec_hdr)
     78 MHD_FN_PAR_CSTR_(3) MHD_FN_PAR_CSTR_(5);
     79 
     80 
     81 #endif /* ! MHD_RESPONSE_FROM_H */