Real time embedded FreeRTOS RSS feed 
Real time embedded FreeRTOS mailing list 
Homepage FreeRTOS+ Products FreeRTOS Labs Integration Services Contact / Enquiries


[FreeRTOS Embedded IP Stack API]

void vApplicationPingReplyHook( ePingReplyStatus_t eStatus, uint16_t usIdentifier );

vApplicationPingReplyHook() is an application defined hook (or callback) function that is called by the IP stack when the stack receives a reply to an ICMP echo (ping) request that was generated using the FreeRTOS_SendPingRequest() function.

Callback functions are implemented by the application writer, but called by the IP stack. The prototype of the callback function must exactly match the prototype above (including the function name).


eStatus   eStatus will be set (by the IP stack) to one of the following values:

Value Description
eSuccess The echo reply was received correctly.
eInvalidChecksum The data received in the echo reply matched that sent in the echo request, but the reply had an incorrect checksum.
eInvalidData The data received in the echo reply did not match that sent in the echo request.

usIdentifier   The identifier received in the echo reply.

Each echo request has a unique identifier to allow replies to be matched to the requests. The FreeRTOS_SendPingRequest() function returns the identifier of the outgoing echo request it generated.

Example usage:

The example on the FreeRTOS_SendPingRequest() documentation page includes an example implementation of vApplicationPingReplyHook().

[ Back to the top ]    [ About FreeRTOS ]    [ FreeRTOS+ Sitemap ]    [ Main FreeRTOS Sitemap ]    [ ]

Copyright (C) 2004-2010 Richard Barry. Copyright (C) 2010-2016 Real Time Engineers Ltd.
Any and all data, files, source code, html content and documentation included in the FreeRTOSTM distribution or available on this site are the exclusive property of Real Time Engineers Ltd.. See the files license.txt (included in the distribution) and this copyright notice for more information. FreeRTOSTM and FreeRTOS.orgTM are trade marks of Real Time Engineers Ltd.