Subversion Repositories HelenOS

Rev

Rev 3846 | Rev 4307 | Go to most recent revision | Blame | Compare with Previous | Last modification | View Log | Download | RSS feed

  1. /*
  2.  * Copyright (c) 2009 Lukas Mejdrech
  3.  * All rights reserved.
  4.  *
  5.  * Redistribution and use in source and binary forms, with or without
  6.  * modification, are permitted provided that the following conditions
  7.  * are met:
  8.  *
  9.  * - Redistributions of source code must retain the above copyright
  10.  *   notice, this list of conditions and the following disclaimer.
  11.  * - Redistributions in binary form must reproduce the above copyright
  12.  *   notice, this list of conditions and the following disclaimer in the
  13.  *   documentation and/or other materials provided with the distribution.
  14.  * - The name of the author may not be used to endorse or promote products
  15.  *   derived from this software without specific prior written permission.
  16.  *
  17.  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  18.  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  19.  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  20.  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  21.  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  22.  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  23.  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  24.  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  25.  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  26.  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  27.  */
  28.  
  29. /** @addtogroup net
  30.  *  @{
  31.  */
  32.  
  33. /** @file
  34.  *  Common error processing codes and routines.
  35.  */
  36.  
  37. #ifndef __NET_ERR_H__
  38. #define __NET_ERR_H__
  39.  
  40. #include <errno.h>
  41.  
  42. /** An actual stored error code.
  43.  */
  44. #define ERROR_CODE                  error_check_return_value
  45.  
  46. /** An error processing routines declaration.
  47.  *  This has to be declared in the block where the error processing is desired.
  48.  */
  49. #define ERROR_DECLARE               int ERROR_CODE
  50.  
  51. /** Stores the value as an error code and checks if an error occurred.
  52.  *  @param value The value to be checked. May be a function call. Input parameter.
  53.  *  @returns FALSE if the value indicates success (EOK).
  54.  *  @returns TRUE otherwise.
  55.  */
  56. #define ERROR_OCCURRED( value )     (( ERROR_CODE = ( value )) != EOK )
  57.  
  58. /** Checks if an error occurred and immediately exits the actual function returning the error code.
  59.  *  @param value The value to be checked. May be a function call. Input parameter.
  60.  */
  61. #define ERROR_PROPAGATE( value )    if( ERROR_OCCURRED( value )) return ERROR_CODE
  62.  
  63. #endif
  64.  
  65. /** @}
  66.  */
  67.