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

FreeRTOS_ReleaseUDPPayloadBuffer()

[FreeRTOS Embedded IP Stack API]

FreeRTOS_sockets.h
void FreeRTOS_ReleaseUDPPayloadBuffer( void *pvBuffer );
		

FreeRTOS_ReleaseUDPPayloadBuffer() is used to return to the IP stack a buffer that was used with the zero copy interface.

The zero copy interface for transmitting data is described on the FreeRTOS_sendto() documentation page.

The zero copy interface for receiving data is described on the FreeRTOS_recvfrom() documentation page.

A buffer needs to be returned to the stack if:

  1. It is obtained from a call to FreeRTOS_recvfrom() and the data it contains is no longer required, or

  2. It was obtained from a call to FreeRTOS_GetUDPPayloadBuffer() but the buffer could not be passed into the IP stack (the call to FreeRTOS_sendto() in which the buffer was used failed).
A buffer can also be re-used rather than returned to the IP stack.

Parameters:

pvBuffer   The buffer that is being returned to the IP stack.

Example usage:

The FreeRTOS_sendto() documentation page includes an example zero copy send operation that demonstrates how to use FreeRTOS_ReleaseUDPPayloadBuffer() when the send operation fails.

the FreeRTOS_recvfrom() documentation page includes an example that demonstrates how to use FreeRTOS_ReleaseUDPPayloadBuffer() to release a buffer obtained from a call to FreeRTOS_recvfrom().


[ 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.