Ping#
The Ping component implements a ping service using the ICMPv6 protocol. It can send ICMPv6 Echo Request, receive corresponding responses, and calculate round-trip latency.
Applications can emit a single ping packet using the sl_wisun_ping_request() API. To receive the pong response, the sl_wisun_ping_response() API is called. The sl_wisun_ping() function offers a straightforward solution for periodic ping packet transmission and reception. To halt the process, use the sl_wisun_ping_stop() function.
Ping test parameters such as size, number of pings sent, and timeout for response absence are configurable. Initialization of the component is done by calling the sl_wisun_ping_init() function.
The following example demonstrates how the ping request can be called:
#include "sl_wisun_ping.h"
static void ping_remote(void) {
int32_t ret = 0;
sockaddr_in6_t remote_addr = { 0 };
sl_status_t status = SL_STATUS_FAIL;
// Create address structure from ping
ret = inet_pton(AF_INET6,
"2001:db8::1",
&remote_addr.sin6_addr);
if (ret != 1) {
// Error handling
return;
}
// Send and receive ping requests and responses
status = sl_wisun_ping(&remote_addr, // Ping remote_addr IPv6 address
10, // with 10 packets
512, // packet length is 512 bytes
NULL, // Custom statitistic handler is not required
NULL); // Request/Response handler is not required
if (status != SL_STATUS_OK) {
// Error handling
return;
}
}
Modules#
Functions#
Provide a high level ping API.
Initialize the ping service module.
Send a ping request.
Retrieve a ping response.
Stop the current ping process.
Macros#
Ping echo request code field value.
Ping echo response code field value.
Dedicated port for ICMPv6 echo messages.
Max packet length.
Maximum count of ping request/response for message queues.
Minimum packet length with 1 byte payload.
Ping echo request type field value.
Ping echo response type field value.
Function Documentation#
sl_wisun_ping#
sl_status_t sl_wisun_ping (const sockaddr_in6_t *const remote_addr, const uint16_t packet_count, const uint16_t packet_length, sl_wisun_ping_stat_hnd_t stat_hnd, sl_wisun_ping_req_resp_done_hnd_t req_resp_sent_hnd)
Provide a high level ping API.
Type | Direction | Argument Name | Description |
---|---|---|---|
const sockaddr_in6_t *const | [in] | remote_addr | Remote destination address |
const uint16_t | [in] | packet_count | Count of packets |
const uint16_t | [in] | packet_length | ICMPv6 packet length including header |
sl_wisun_ping_stat_hnd_t | [in] | stat_hnd | Custom statistic handler function |
sl_wisun_ping_req_resp_done_hnd_t | [in] | req_resp_sent_hnd | Request/Response sent handler function |
The function provides an interface for periodically sending and receiving ping ICMPv6 packets, and collecting statistic data. Returns
sl_status_t SL_STATUS_OK on success, otherwise SL_STATUS_FAIL or SL_STATUS_ABORT
sl_wisun_ping_init#
void sl_wisun_ping_init (void )
Initialize the ping service module.
Type | Direction | Argument Name | Description |
---|---|---|---|
void | N/A |
This function initializes the service thread, mutex, and message queues.
sl_wisun_ping_request#
void sl_wisun_ping_request (const sl_wisun_ping_info_t *const ping_request)
Send a ping request.
Type | Direction | Argument Name | Description |
---|---|---|---|
const sl_wisun_ping_info_t *const | [in] | ping_request | Ping Request Information |
The function sends a single ICMPv6 request.
sl_wisun_ping_response#
void sl_wisun_ping_response (sl_wisun_ping_info_t *const ping_response)
Retrieve a ping response.
Type | Direction | Argument Name | Description |
---|---|---|---|
sl_wisun_ping_info_t *const | [out] | ping_response | Ping Response Information |
The function retrieves a ping response information.
sl_wisun_ping_stop#
void sl_wisun_ping_stop (void )
Stop the current ping process.
Type | Direction | Argument Name | Description |
---|---|---|---|
void | N/A |
Reset request and response queues and send a special ping request with interrupt ping status.