mhd_socket_error.h (4856B)
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/mhd_socket_error.h 41 * @brief The definition of the mhd_SocketError enum and related macros 42 * @author Karlson2k (Evgeny Grin) 43 */ 44 45 #ifndef MHD_SOCKET_ERROR_H 46 #define MHD_SOCKET_ERROR_H 1 47 48 #include "mhd_sys_options.h" 49 #include "mhd_socket_type.h" 50 51 // TODO: better classification, when clearer local closing / network aborts 52 /** 53 * Recognised socket errors for recv() and send() 54 */ 55 enum MHD_FIXED_ENUM_ mhd_SocketError 56 { 57 /** 58 * No error. 59 */ 60 mhd_SOCKET_ERR_NO_ERROR = 0 61 , 62 /** 63 * No more data to get / no more space to put the data. 64 */ 65 mhd_SOCKET_ERR_AGAIN 66 , 67 /** 68 * The process has been interrupted by external factors. 69 */ 70 mhd_SOCKET_ERR_INTR 71 , 72 /** 73 * "Not enough memory" / "not enough system resources" 74 */ 75 mhd_SOCKET_ERR_NOMEM 76 , 77 /** 78 * The connection has been gracefully closed by remote peer 79 */ 80 mhd_SOCKET_ERR_REMT_DISCONN 81 , 82 /** 83 * The connection has been hard-closed by remote peer. 84 */ 85 mhd_SOCKET_ERR_CONNRESET 86 , 87 /** 88 * Meta-error for any other errors indicating a broken connection. 89 * It can be keep-alive ping failure or timeout to get ACK for the 90 * transmitted data. 91 */ 92 mhd_SOCKET_ERR_CONN_BROKEN 93 , 94 /** 95 * Connection is not connected anymore due to network error or 96 * any other reason. 97 */ 98 mhd_SOCKET_ERR_NOTCONN 99 #ifdef MHD_SUPPORT_HTTPS 100 , 101 /** 102 * General TLS encryption or decryption error or other TLS-related error. 103 */ 104 mhd_SOCKET_ERR_TLS 105 #endif /* MHD_SUPPORT_HTTPS */ 106 , 107 /** 108 * The socket has been shut down for writing or no longer connected 109 * Only for 'send()'. 110 */ 111 mhd_SOCKET_ERR_PIPE 112 , 113 /** 114 * The error status reported, but concrete code error has not been 115 * checked by MHD 116 */ 117 mhd_SOCKET_ERR_NOT_CHECKED 118 , 119 /** 120 * The socket FD is invalid 121 */ 122 mhd_SOCKET_ERR_BADF 123 , 124 /** 125 * Socket function parameters are invalid 126 */ 127 mhd_SOCKET_ERR_INVAL 128 , 129 /** 130 * Socket function parameters are not supported 131 */ 132 mhd_SOCKET_ERR_OPNOTSUPP 133 , 134 /** 135 * Used FD is not a socket 136 */ 137 mhd_SOCKET_ERR_NOTSOCK 138 , 139 /** 140 * Other socket error 141 */ 142 mhd_SOCKET_ERR_OTHER 143 , 144 /** 145 * Internal (MHD) error 146 * Not actually reported by the OS 147 */ 148 mhd_SOCKET_ERR_INTERNAL 149 150 }; 151 152 /** 153 * Check whether the socket error is unrecoverable 154 */ 155 #define mhd_SOCKET_ERR_IS_HARD(err) (mhd_SOCKET_ERR_REMT_DISCONN <= (err)) 156 157 /** 158 * Check whether the socket error is unexpected 159 */ 160 #define mhd_SOCKET_ERR_IS_BAD(err) (mhd_SOCKET_ERR_BADF <= (err)) 161 162 /** 163 * Check whether the socket error is actually artificial, not a socket error 164 * @warning This macro may evaluate its argument multiple times, 165 * so do not use it with expressions! 166 */ 167 #ifdef MHD_SUPPORT_HTTPS 168 # define mhd_SOCKET_ERR_IS_NOT_SCKT(err) \ 169 ((mhd_SOCKET_ERR_TLS == (err)) || (mhd_SOCKET_ERR_INTERNAL == (err))) 170 #else /* ! MHD_SUPPORT_HTTPS */ 171 # define mhd_SOCKET_ERR_IS_NOT_SCKT(err) \ 172 (mhd_SOCKET_ERR_INTERNAL == (err)) 173 #endif /* ! MHD_SUPPORT_HTTPS */ 174 175 #endif /* ! MHD_SOCKET_ERROR_H */