Rev 4720 | Show entire file | Ignore whitespace | Details | Blame | Last modification | View Log | RSS feed
| Rev 4720 | Rev 4756 | ||
|---|---|---|---|
| Line 61... | Line 61... | ||
| 61 | /*@{*/ |
61 | /*@{*/ |
| 62 | 62 | ||
| 63 | /** Requests an echo message. |
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. |
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. |
65 | * Blocks the caller until the reply or the timeout occurres. |
| 66 | * @param icmp_phone The ICMP module phone used for (semi)remote calls. Input parameter. |
66 | * @param[in] icmp_phone The ICMP module phone used for (semi)remote calls. |
| 67 | * @param size The message data length in bytes. Input parameter. |
67 | * @param[in] size The message data length in bytes. |
| 68 | * @param timeout The timeout in miliseconds. Input parameter. |
68 | * @param[in] timeout The timeout in miliseconds. |
| 69 | * @param ttl The time to live. Input parameter. |
69 | * @param[in] ttl The time to live. |
| 70 | * @param tos The type of service. Input parameter. |
70 | * @param[in] tos The type of service. |
| 71 | * @param dont_fragment The value indicating whether the datagram must not be fragmented. Is used as a MTU discovery. Input parameter. |
71 | * @param[in] dont_fragment The value indicating whether the datagram must not be fragmented. Is used as a MTU discovery. |
| 72 | * @param addr The target host address. Input parameter. |
72 | * @param[in] addr The target host address. |
| 73 | * @param addrlen The torget host address length. Input parameter. |
73 | * @param[in] addrlen The torget host address length. |
| 74 | * @returns ICMP_ECHO on success. |
74 | * @returns ICMP_ECHO on success. |
| 75 | * @returns ETIMEOUT if the reply has not arrived before the timeout. |
75 | * @returns ETIMEOUT if the reply has not arrived before the timeout. |
| 76 | * @returns ICMP type of the received error notification. |
76 | * @returns ICMP type of the received error notification. |
| 77 | * @returns EINVAL if the addrlen parameter is less or equal to zero (<=0). |
77 | * @returns EINVAL if the addrlen parameter is less or equal to zero (<=0). |
| 78 | * @returns ENOMEM if there is not enough memory left. |
78 | * @returns ENOMEM if there is not enough memory left. |