len0rd/FreeRTOS-Kernel
1
0
Fork 0
mirror of https://github.com/FreeRTOS/FreeRTOS-Kernel.git synced 2026-05-12 11:42:57 -04:00
Code Issues Projects Releases Packages Wiki Activity

fix: Correct xStreamBufferReceive and xMessageBufferReceiveFromISR example type and timeout

Browse source
This commit is contained in:
1294644079@qq.com 2026-04-18 21:46:31 +08:00
parent 7c0c890c64
commit b6499d9caa
1 changed files with 3 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

6
include/message_buffer.h
View file

@ -560,14 +560,14 @@ typedef StreamBufferHandle_t MessageBufferHandle_t;
* *
* Example use: * Example use:
* @code{c} * @code{c}
* void vAFunction( MessageBuffer_t xMessageBuffer ) * void vAFunction( MessageBufferHandle_t xMessageBuffer )
* { * {
* uint8_t ucRxData[ 20 ]; * uint8_t ucRxData[ 20 ];
* size_t xReceivedBytes; * size_t xReceivedBytes;
* const TickType_t xBlockTime = pdMS_TO_TICKS( 20 ); * const TickType_t xBlockTime = pdMS_TO_TICKS( 20 );
* *
* // Receive the next message from the message buffer. Wait in the Blocked * // Receive the next message from the message buffer. Wait in the Blocked
* // state (so not using any CPU processing time) for a maximum of 100ms for * // state (so not using any CPU processing time) for a maximum of 20ms for
* // a message to become available. * // a message to become available.
* xReceivedBytes = xMessageBufferReceive( xMessageBuffer, * xReceivedBytes = xMessageBufferReceive( xMessageBuffer,
* ( void * ) ucRxData, * ( void * ) ucRxData,
@ -655,7 +655,7 @@ typedef StreamBufferHandle_t MessageBufferHandle_t;
* Example use: * Example use:
* @code{c} * @code{c}
* // A message buffer that has already been created. * // A message buffer that has already been created.
* MessageBuffer_t xMessageBuffer; * MessageBufferHandle_t xMessageBuffer;
* *
* void vAnInterruptServiceRoutine( void ) * void vAnInterruptServiceRoutine( void )
* { * {