Rev 4720 | Details | Compare with Previous | Last modification | View Log | RSS feed
| Rev | Author | Line No. | Line |
|---|---|---|---|
| 4715 | mejdrech | 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 application interface. |
||
| 35 | */ |
||
| 36 | |||
| 37 | #ifndef __NET_ICMP_API_H__ |
||
| 38 | #define __NET_ICMP_API_H__ |
||
| 39 | |||
| 40 | #include <sys/types.h> |
||
| 41 | |||
| 42 | #include "device.h" |
||
| 43 | |||
| 44 | #include "../structures/measured_strings.h" |
||
| 45 | #include "../structures/packet/packet.h" |
||
| 46 | |||
| 47 | #include "inet.h" |
||
| 48 | #include "ip_codes.h" |
||
| 49 | #include "socket_codes.h" |
||
| 50 | |||
| 51 | #include "icmp_codes.h" |
||
| 52 | #include "icmp_common.h" |
||
| 53 | |||
| 4720 | mejdrech | 54 | /** Miliseconds type definition. |
| 55 | */ |
||
| 56 | typedef size_t mseconds_t; |
||
| 57 | |||
| 4715 | mejdrech | 58 | /** @name ICMP module application interface |
| 59 | * This interface is used by other application modules. |
||
| 60 | */ |
||
| 61 | /*@{*/ |
||
| 62 | |||
| 4720 | mejdrech | 63 | /** Requests an echo message. |
| 64 | * Sends a packet with specified parameters to the target host and waits for the reply upto the given timeout. |
||
| 65 | * Blocks the caller until the reply or the timeout occurres. |
||
| 4756 | mejdrech | 66 | * @param[in] icmp_phone The ICMP module phone used for (semi)remote calls. |
| 67 | * @param[in] size The message data length in bytes. |
||
| 68 | * @param[in] timeout The timeout in miliseconds. |
||
| 69 | * @param[in] ttl The time to live. |
||
| 70 | * @param[in] tos The type of service. |
||
| 71 | * @param[in] dont_fragment The value indicating whether the datagram must not be fragmented. Is used as a MTU discovery. |
||
| 72 | * @param[in] addr The target host address. |
||
| 73 | * @param[in] addrlen The torget host address length. |
||
| 4720 | mejdrech | 74 | * @returns ICMP_ECHO on success. |
| 75 | * @returns ETIMEOUT if the reply has not arrived before the timeout. |
||
| 76 | * @returns ICMP type of the received error notification. |
||
| 77 | * @returns EINVAL if the addrlen parameter is less or equal to zero (<=0). |
||
| 78 | * @returns ENOMEM if there is not enough memory left. |
||
| 79 | * @returns EPARTY if there was an internal error. |
||
| 4715 | mejdrech | 80 | */ |
| 4720 | mejdrech | 81 | int icmp_echo_msg( int icmp_phone, size_t size, mseconds_t timeout, ip_ttl_t ttl, ip_tos_t tos, int dont_fragment, const struct sockaddr * addr, socklen_t addrlen ); |
| 4715 | mejdrech | 82 | |
| 83 | /*@}*/ |
||
| 84 | |||
| 85 | #endif |
||
| 86 | |||
| 87 | /** @} |
||
| 88 | */ |