FreeRTOS
osMessagePeek() is only used within FreeRTOS.
 
Symbols
loading...
Files
loading...
CodeScopeSTM32 Libraries and SamplesFreeRTOSosMessagePeek()

osMessagePeek() function

Receive an item from a queue without removing the item from the queue.

Syntax

osEvent osMessagePeek (osMessageQId queue_id,     uint32_t millisec);
Implemented in cmsis_os.c:1555

Arguments

queue_id

message queue ID obtained with osMessageCreate.

millisec

timeout value or 0 in case of no time-out.

Return value

event information that includes status code.

References

LocationText
cmsis_os.c:1555
osEvent osMessagePeek (osMessageQId queue_id, uint32_t millisec)
cmsis_os.h:970
osEvent osMessagePeek (osMessageQId queue_id, uint32_t millisec);

Call Tree

Functions called by osMessagePeek()
osMessagePeek()
all items filtered out
Data read by osMessagePeek()
Data written by osMessagePeek()
osMessagePeek()::ticks
osMessagePeek()::event
all items filtered out
osMessagePeek()
osMessagePeek()::ticks
all items filtered out
Type of osMessagePeek()
osMessagePeek()
all items filtered out