Skip to content

Group crDELAY

Modules > crDELAY


Detailed Description

croutine. h

Delay a co-routine for a fixed period of time.

crDELAY can only be called from the co-routine function itself - not from within a function called by the co-routine function. This is because co-routines do not maintain their own stack.


  • xHandle The handle of the co-routine to delay. This is the xHandle parameter of the co-routine function.
  • xTickToDelay The number of ticks that the co-routine should delay for. The actual amount of time this equates to is defined by configTICK_RATE_HZ (set in FreeRTOSConfig.h). The constant portTICK_PERIOD_MS can be used to convert ticks to milliseconds.

Example usage: