Skip to content

Commit

Permalink
Updated comments for FreeRTOS_select return value (FreeRTOS#596)
Browse files Browse the repository at this point in the history
* Updated comments for FreeRTOS_select return value

* Updated the function brief for FreeRTOS_select

* Uncrustify: triggered by comment.

* Updating FreeRTOS_select function @brief

* Updated function brief for FreeRTOS_SignalSocket

* Uncrustify: triggered by comment.

* Update source/FreeRTOS_Sockets.c

Co-authored-by: Ubuntu <ubuntu@ip-172-31-22-210.ec2.internal>
Co-authored-by: GitHub Action <action@github.com>
Co-authored-by: Aniruddha Kanhere <60444055+AniruddhaKanhere@users.noreply.github.com>
  • Loading branch information
4 people authored and ActoryOu committed Mar 17, 2023
1 parent f1e5ef3 commit d0db6ba
Showing 1 changed file with 10 additions and 2 deletions.
12 changes: 10 additions & 2 deletions source/FreeRTOS_Sockets.c
Original file line number Diff line number Diff line change
Expand Up @@ -901,15 +901,19 @@ Socket_t FreeRTOS_socket( BaseType_t xDomain,

/**
* @brief The select() statement: wait for an event to occur on any of the sockets
* included in a socket set.
* included in a socket set and return its event bits when the event occurs.
*
* @param[in] xSocketSet: The socket set including the sockets on which we are
* waiting for an event to occur.
* @param[in] xBlockTimeTicks: Maximum time ticks to wait for an event to occur.
* If the value is 'portMAX_DELAY' then the function will wait
* indefinitely for an event to occur.
*
* @return The socket which might have triggered the event bit.
* @return The event bits (event flags) value for the socket set in which an
* event occurred. If any socket is signalled during the call, using
* FreeRTOS_SignalSocket() or FreeRTOS_SignalSocketFromISR(), then eSELECT_INTR
* is returned.
*
*/
BaseType_t FreeRTOS_select( SocketSet_t xSocketSet,
TickType_t xBlockTimeTicks )
Expand Down Expand Up @@ -5862,6 +5866,10 @@ void * pvSocketGetSocketID( const ConstSocket_t xSocket )
* and return the value -pdFREERTOS_ERRNO_EINTR ( -4 ).
*
* @param[in] xSocket: The socket that will be signalled.
*
* @return If xSocket is an invalid socket (NULL) or if the socket set is invalid (NULL)
* and/or if event group is invalid/not created, then, -pdFREERTOS_ERRNO_EINVAL
* is returned. On successful sending of a signal, 0 is returned.
*/
BaseType_t FreeRTOS_SignalSocket( Socket_t xSocket )
{
Expand Down

0 comments on commit d0db6ba

Please sign in to comment.