sckt_recv.h (2984B)
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-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/sckt_recv.h 41 * @brief The declaration of the mhd_sckt_recv() function 42 * @author Karlson2k (Evgeny Grin) 43 */ 44 45 #ifndef MHD_SCKT_RECV_H 46 #define MHD_SCKT_RECV_H 1 47 48 #include "mhd_sys_options.h" 49 50 #include "sys_sizet_type.h" 51 52 #include "mhd_socket_error.h" 53 54 struct mhd_ConnSocket; /* Forward declaration */ 55 56 /** 57 * Receive the data from the network socket. 58 * 59 * Clear #mhd_SOCKET_NET_STATE_RECV_READY in @a sk->ready if necessary. 60 * 61 * @param sk the socket data 62 * @param buf_size the size of the @a buf buffer 63 * @param[out] buf the buffer to fill with the received data 64 * @param[out] received the pointer to variable to set the size of the data 65 * actually put to the @a buffer 66 * @return mhd_SOCKET_ERR_NO_ERROR if receive succeed (the @a received gets 67 * the received size) or socket error 68 */ 69 MHD_INTERNAL enum mhd_SocketError 70 mhd_sckt_recv (struct mhd_ConnSocket *restrict sk, 71 size_t buf_size, 72 char buf[MHD_FN_PAR_DYN_ARR_SIZE_ (buf_size)], 73 size_t *restrict received) 74 MHD_FN_PAR_NONNULL_ALL_ MHD_FN_PAR_OUT_SIZE_ (3,2) MHD_FN_PAR_OUT_ (4); 75 76 77 #endif /* ! MHD_SCKT_RECV_H */