Subversion Repositories HelenOS

Rev

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_app
  30.  *  @{
  31.  */
  32.  
  33. /** @file
  34.  *  Generic application error printing functions.
  35.  */
  36.  
  37. #ifndef __NET_APP_PRINT__
  38. #define __NET_APP_PRINT__
  39.  
  40. /** Returns whether the error code may be an ICMP error code.
  41.  *  @param error_code The error code. Input parameter.
  42.  *  @returns A value indicating whether the error code may be an ICMP error code.
  43.  */
  44. #define IS_ICMP_ERROR( error_code )     (( error_code ) > 0 )
  45.  
  46. /** Returns whether the error code may be socket error code.
  47.  *  @param error_code The error code. Input parameter.
  48.  *  @returns A value indicating whether the error code may be a socket error code.
  49.  */
  50. #define IS_SOCKET_ERROR( error_code )   (( error_code ) < 0 )
  51.  
  52. /** Prints the error description.
  53.  *  Supports ICMP and socket error codes.
  54.  *  @param output The description output stream. May be NULL. Input parameter.
  55.  *  @param error_code The error code. Input parameter.
  56.  *  @param prefix The error description prefix. May be NULL. Input parameter.
  57.  *  @param suffix The error description suffix. May be NULL. Input parameter.
  58.  */
  59. void print_error( FILE * output, int error_code, const char * prefix, const char * suffix );
  60.  
  61. /** Prints the specific ICMP error description.
  62.  *  @param output The description output stream. May be NULL. Input parameter.
  63.  *  @param error_code The ICMP error code. Input parameter.
  64.  *  @param prefix The error description prefix. May be NULL. Input parameter.
  65.  *  @param suffix The error description suffix. May be NULL. Input parameter.
  66.  */
  67. void icmp_print_error( FILE * output, int error_code, const char * prefix, const char * suffix );
  68.  
  69. /** Prints the specific socket error description.
  70.  *  @param output The description output stream. May be NULL. Input parameter.
  71.  *  @param error_code The socket error code. Input parameter.
  72.  *  @param prefix The error description prefix. May be NULL. Input parameter.
  73.  *  @param suffix The error description suffix. May be NULL. Input parameter.
  74.  */
  75. void socket_print_error( FILE * output, int error_code, const char * prefix, const char * suffix );
  76.  
  77. #endif
  78.  
  79. /** @}
  80.  */
  81.