diff --git a/cpukit/include/rtems/chain.h b/cpukit/include/rtems/chain.h index 4f9f9495d5..6f36a16535 100644 --- a/cpukit/include/rtems/chain.h +++ b/cpukit/include/rtems/chain.h @@ -138,8 +138,15 @@ rtems_status_code rtems_chain_get_with_notification( ); /** - * @brief Gets the first @a node of the @a chain and sends the @a events to the - * @a task if the @a chain is empty afterwards. + * @brief Gets the first @a node from the @a chain with an @a events wait if + * empty. + * + * This routine gets the first @a node of the @a chain if it is available, + * otherwise it waits for the calling task to receive all @a events and then + * tries to get the first node again. The get and wait is retried indefinitely + * until either a node is available or the event receive times out. + * + * Each event receive starts a new timeout based on the value of @a timeout. * * @see rtems_chain_get() and rtems_event_receive(). *