Subversion Repositories HelenOS

Rev

Rev 4721 | 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 icmp
  30.  *  @{
  31.  */
  32.  
  33. /** @file
  34.  *  ICMP client interface.
  35.  */
  36.  
  37. #ifndef __NET_ICMP_CLIENT_H__
  38. #define __NET_ICMP_CLIENT_H__
  39.  
  40. #include "icmp_codes.h"
  41. #include "../structures/packet/packet.h"
  42.  
  43. /** Processes the received packet prefixed with an ICMP header.
  44.  *  @param[in] packet The received packet.
  45.  *  @param[out] type The ICMP header type.
  46.  *  @param[out] code The ICMP header code.
  47.  *  @param[out] pointer The ICMP header pointer.
  48.  *  @param[out] mtu The ICMP header MTU.
  49.  *  @returns The ICMP header length.
  50.  *  @returns Zero (0) if the packet contains no data.
  51.  */
  52. int icmp_client_process_packet( packet_t packet, icmp_type_t * type, icmp_code_t * code, icmp_param_t * pointer, icmp_param_t * mtu );
  53.  
  54. /** Returns the ICMP header length.
  55.  *  @param[in] packet The packet.
  56.  *  @returns The ICMP header length in bytes.
  57.  */
  58. size_t  icmp_client_header_length( packet_t packet );
  59.  
  60. #endif
  61.  
  62. /** @}
  63.  */
  64.