Important changes to repositories hosted on mbed.com
Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.
To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.
It is also possible to export all your personal repositories from the account settings page.
ping.h File Reference
Ping utility. More...
Go to the source code of this file.
Data Structures | |
| struct | PingContext |
| Ping context. More... | |
Functions | |
| error_t | ping (NetInterface *interface, const IpAddr *targetIpAddr, size_t size, uint8_t ttl, systime_t timeout, systime_t *rtt) |
| Test the reachability of a host. | |
| void | pingInit (PingContext *context) |
| Initialize ping context. | |
| error_t | pingSetTimeout (PingContext *context, systime_t timeout) |
| Set timeout value. | |
| error_t | pingBindToInterface (PingContext *context, NetInterface *interface) |
| Select a particular network interface. | |
| error_t | pingSendRequest (PingContext *context, const IpAddr *targetIpAddr, size_t size, uint8_t ttl) |
| Send an ICMP Echo Request message. | |
| error_t | pingWaitForReply (PingContext *context, IpAddr *targetIpAddr, systime_t *rtt) |
| Wait for a matching ICMP Echo Reply message. | |
| void | pingRelease (PingContext *context) |
| Release ping context. | |
Detailed Description
Ping utility.
License
Copyright (C) 2010-2017 Oryx Embedded SARL. All rights reserved.
This file is part of CycloneTCP Open.
This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
- Version:
- 1.7.6
Definition in file ping.h.
Function Documentation
| error_t ping | ( | NetInterface * | interface, |
| const IpAddr * | targetIpAddr, | ||
| size_t | size, | ||
| uint8_t | ttl, | ||
| systime_t | timeout, | ||
| systime_t * | rtt | ||
| ) |
Test the reachability of a host.
Ping operates by sending an ICMP Echo Request message to the target host and waiting for an ICMP Echo Reply message
- Parameters:
-
[in] interface Underlying network interface (optional parameter) [in] targetIpAddr IP address of the host to reach [in] size Size of the data payload in bytes [in] ttl Time-To-Live value to be used [in] timeout Maximum time to wait before giving up [out] rtt Round-trip time (optional parameter)
- Returns:
- Error code
| error_t pingBindToInterface | ( | PingContext * | context, |
| NetInterface * | interface | ||
| ) |
| void pingInit | ( | PingContext * | context ) |
| void pingRelease | ( | PingContext * | context ) |
| error_t pingSendRequest | ( | PingContext * | context, |
| const IpAddr * | targetIpAddr, | ||
| size_t | size, | ||
| uint8_t | ttl | ||
| ) |
| error_t pingSetTimeout | ( | PingContext * | context, |
| systime_t | timeout | ||
| ) |
| error_t pingWaitForReply | ( | PingContext * | context, |
| IpAddr * | targetIpAddr, | ||
| systime_t * | rtt | ||
| ) |
Generated on Tue Jul 12 2022 17:10:21 by
1.7.2