Subversion Repositories HelenOS

Rev

Rev 4715 | 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 icmp
  30.  *  @{
  31.  */
  32.  
  33. /** @file
  34.  *  ICMP module interface.
  35.  *  The same interface is used for standalone remote modules as well as for bundle modules.
  36.  *  The standalone remote modules have to be compiled with the icmp_remote.c source file.
  37.  *  The bundle modules with the icmp.c source file.
  38.  */
  39.  
  40. #ifndef __NET_ICMP_INTERFACE_H__
  41. #define __NET_ICMP_INTERFACE_H__
  42.  
  43. #include "device.h"
  44.  
  45. #include "../structures/measured_strings.h"
  46.  
  47. #include "icmp_codes.h"
  48.  
  49. /** @name ICMP module interface
  50.  *  This interface is used by other modules.
  51.  */
  52. /*@{*/
  53.  
  54. /** \todo
  55.  */
  56. int icmp_echo_msg( int icmp_phone, icmp_param_t identifier, icmp_param_t sequence_number, const void * data, size_t length );
  57.  
  58. /** \todo
  59.  */
  60. int icmp_destination_unreachable_msg( int icmp_phone, icmp_code_t code, icmp_param_t mtu, packet_t packet );
  61.  
  62. /** \todo
  63.  */
  64. int icmp_source_quench_msg( int icmp_phone, packet_t packet );
  65.  
  66. /** \todo
  67.  */
  68. int icmp_time_exceeded_msg( int icmp_phone, icmp_code_t code, packet_t packet );
  69.  
  70. /** \todo
  71.  */
  72. int icmp_parameter_problem_msg( int icmp_phone, icmp_code_t code, icmp_param_t pointer, packet_t packet );
  73.  
  74. /** Connects to the ICMP module.
  75.  *  @param service The ICMP module service. Ignored parameter.
  76.  *  @returns The ICMP module phone on success.
  77.  *  @returns 0 if called by the bundle module.
  78.  */
  79. int icmp_connect_module( services_t service );
  80.  
  81. /*@}*/
  82.  
  83. #endif
  84.  
  85. /** @}
  86.  */
  87.