github-forks
/
FreeRTOS
mirror of https://github.com/FreeRTOS/FreeRTOS.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Update comments only.

Browse Source
pull/1/head
Richard Barry 17 years ago
parent f03b362ee9
commit b6e93f2e42
1 changed files with 20 additions and 14 deletions
Show Stats Download Patch File Download Diff File

34
Source/include/queue.h
Unescape Escape View File

@ -151,9 +151,9 @@ xQueueHandle xQueueCreate( unsigned portBASE_TYPE uxQueueLength, unsigned portBA
* *
* @param xTicksToWait The maximum amount of time the task should block * @param xTicksToWait The maximum amount of time the task should block
* waiting for space to become available on the queue, should it already * waiting for space to become available on the queue, should it already
* be full. The call will return immediately if this is set to 0. The * be full. The call will return immediately if this is set to 0 and the
* time is defined in tick periods so the constant portTICK_RATE_MS * queue is full. The time is defined in tick periods so the constant
* should be used to convert to real time if this is required. * portTICK_RATE_MS should be used to convert to real time if this is required.
* *
* @return pdTRUE if the item was successfully posted, otherwise errQUEUE_FULL. * @return pdTRUE if the item was successfully posted, otherwise errQUEUE_FULL.
* *
@ -233,9 +233,9 @@ xQueueHandle xQueueCreate( unsigned portBASE_TYPE uxQueueLength, unsigned portBA
* *
* @param xTicksToWait The maximum amount of time the task should block * @param xTicksToWait The maximum amount of time the task should block
* waiting for space to become available on the queue, should it already * waiting for space to become available on the queue, should it already
* be full. The call will return immediately if this is set to 0. The * be full. The call will return immediately if this is set to 0 and the queue
* time is defined in tick periods so the constant portTICK_RATE_MS * is full. The time is defined in tick periods so the constant
* should be used to convert to real time if this is required. * portTICK_RATE_MS should be used to convert to real time if this is required.
* *
* @return pdTRUE if the item was successfully posted, otherwise errQUEUE_FULL. * @return pdTRUE if the item was successfully posted, otherwise errQUEUE_FULL.
* *
@ -317,9 +317,9 @@ xQueueHandle xQueueCreate( unsigned portBASE_TYPE uxQueueLength, unsigned portBA
* *
* @param xTicksToWait The maximum amount of time the task should block * @param xTicksToWait The maximum amount of time the task should block
* waiting for space to become available on the queue, should it already * waiting for space to become available on the queue, should it already
* be full. The call will return immediately if this is set to 0. The * be full. The call will return immediately if this is set to 0 and the
* time is defined in tick periods so the constant portTICK_RATE_MS * queue is full. The time is defined in tick periods so the constant
* should be used to convert to real time if this is required. * portTICK_RATE_MS should be used to convert to real time if this is required.
* *
* @return pdTRUE if the item was successfully posted, otherwise errQUEUE_FULL. * @return pdTRUE if the item was successfully posted, otherwise errQUEUE_FULL.
* *
@ -401,9 +401,9 @@ xQueueHandle xQueueCreate( unsigned portBASE_TYPE uxQueueLength, unsigned portBA
* *
* @param xTicksToWait The maximum amount of time the task should block * @param xTicksToWait The maximum amount of time the task should block
* waiting for space to become available on the queue, should it already * waiting for space to become available on the queue, should it already
* be full. The call will return immediately if this is set to 0. The * be full. The call will return immediately if this is set to 0 and the
* time is defined in tick periods so the constant portTICK_RATE_MS * queue is full. The time is defined in tick periods so the constant
* should be used to convert to real time if this is required. * portTICK_RATE_MS should be used to convert to real time if this is required.
* *
* @param xCopyPosition Can take the value queueSEND_TO_BACK to place the * @param xCopyPosition Can take the value queueSEND_TO_BACK to place the
* item at the back of the queue, or queueSEND_TO_FRONT to place the item * item at the back of the queue, or queueSEND_TO_FRONT to place the item
@ -492,6 +492,8 @@ signed portBASE_TYPE xQueueGenericSend( xQueueHandle xQueue, const void * const
* waiting for an item to receive should the queue be empty at the time * waiting for an item to receive should the queue be empty at the time
* of the call. The time is defined in tick periods so the constant * of the call. The time is defined in tick periods so the constant
* portTICK_RATE_MS should be used to convert to real time if this is required. * portTICK_RATE_MS should be used to convert to real time if this is required.
* xQueuePeek() will return immediately if xTicksToWait is 0 and the queue
* is empty.
* *
* @return pdTRUE if an item was successfully received from the queue, * @return pdTRUE if an item was successfully received from the queue,
* otherwise pdFALSE. * otherwise pdFALSE.
@ -581,8 +583,10 @@ signed portBASE_TYPE xQueueGenericSend( xQueueHandle xQueue, const void * const
* *
* @param xTicksToWait The maximum amount of time the task should block * @param xTicksToWait The maximum amount of time the task should block
* waiting for an item to receive should the queue be empty at the time * waiting for an item to receive should the queue be empty at the time
* of the call. The time is defined in tick periods so the constant * of the call. xQueueReceive() will return immediately if xTicksToWait
* portTICK_RATE_MS should be used to convert to real time if this is required. * is zero and the queue is empty. The time is defined in tick periods so the
* constant portTICK_RATE_MS should be used to convert to real time if this is
* required.
* *
* @return pdTRUE if an item was successfully received from the queue, * @return pdTRUE if an item was successfully received from the queue,
* otherwise pdFALSE. * otherwise pdFALSE.
@ -675,6 +679,8 @@ signed portBASE_TYPE xQueueGenericSend( xQueueHandle xQueue, const void * const
* waiting for an item to receive should the queue be empty at the time * waiting for an item to receive should the queue be empty at the time
* of the call. The time is defined in tick periods so the constant * of the call. The time is defined in tick periods so the constant
* portTICK_RATE_MS should be used to convert to real time if this is required. * portTICK_RATE_MS should be used to convert to real time if this is required.
* xQueueGenericReceive() will return immediately if the queue is empty and
* xTicksToWait is 0.
* *
* @param xJustPeek When set to true, the item received from the queue is not * @param xJustPeek When set to true, the item received from the queue is not
* actually removed from the queue - meaning a subsequent call to * actually removed from the queue - meaning a subsequent call to

Write Preview
Loading…
Cancel
Save