include/lwip/err.h

0001 /*
0002  * Copyright (c) 2001-2004 Swedish Institute of Computer Science.
0003  * All rights reserved.
0004  *
0005  * Redistribution and use in source and binary forms, with or without modification,
0006  * are permitted provided that the following conditions are met:
0007  *
0008  * 1. Redistributions of source code must retain the above copyright notice,
0009  *    this list of conditions and the following disclaimer.
0010  * 2. Redistributions in binary form must reproduce the above copyright notice,
0011  *    this list of conditions and the following disclaimer in the documentation
0012  *    and/or other materials provided with the distribution.
0013  * 3. The name of the author may not be used to endorse or promote products
0014  *    derived from this software without specific prior written permission.
0015  *
0016  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED
0017  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
0018  * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
0019  * SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
0020  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
0021  * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
0022  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
0023  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
0024  * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
0025  * OF SUCH DAMAGE.
0026  *
0027  * This file is part of the lwIP TCP/IP stack.
0028  *
0029  * Author: Adam Dunkels <adam@sics.se>
0030  *
0031  */
0032 #ifndef __LWIP_ERR_H__
0033 #define __LWIP_ERR_H__
0034
0035 #include "lwip/opt.h"
0036 #include "lwip/arch.h"
0037
0038 #ifdef __cplusplus
0039 extern "C" {
0040 #endif
0041
0042 /** Define LWIP_ERR_T in cc.h if you want to use
0043  *  a different type for your platform (must be signed). */
0044 #ifdef LWIP_ERR_T
0045 typedef LWIP_ERR_T err_t;
0046 #else /* LWIP_ERR_T */
0047  typedef s8_t err_t;
0048 #endif /* LWIP_ERR_T*/
0049
0050 /* Definitions for error constants. */
0051
0052 #define ERR_OK          0    /* No error, everything OK. */
0053 #define ERR_MEM        -1    /* Out of memory error.     */
0054 #define ERR_BUF        -2    /* Buffer error.            */
0055 #define ERR_TIMEOUT    -3    /* Timeout.                 */
0056 #define ERR_RTE        -4    /* Routing problem.         */
0057
0058 #define ERR_IS_FATAL(e) ((e) < ERR_RTE)
0059
0060 #define ERR_ABRT       -5    /* Connection aborted.      */
0061 #define ERR_RST        -6    /* Connection reset.        */
0062 #define ERR_CLSD       -7    /* Connection closed.       */
0063 #define ERR_CONN       -8    /* Not connected.           */
0064
0065 #define ERR_VAL        -9    /* Illegal value.           */
0066
0067 #define ERR_ARG        -10   /* Illegal argument.        */
0068
0069 #define ERR_USE        -11   /* Address in use.          */
0070
0071 #define ERR_IF         -12   /* Low-level netif error    */
0072 #define ERR_ISCONN     -13   /* Already connected.       */
0073
0074 #define ERR_INPROGRESS -14   /* Operation in progress    */
0075
0076
0077 #ifdef LWIP_DEBUG
0078 extern const char *lwip_strerr(err_t err);
0079 #else
0080 #define lwip_strerr(x) ""
0081 #endif /* LWIP_DEBUG */
0082
0083 #ifdef __cplusplus
0084 }
0085 #endif
0086
0087 #endif /* __LWIP_ERR_H__ */