Skip to content

Updated comments for FreeRTOS_select return value #596

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 7 commits into from
Dec 9, 2022
Merged

Updated comments for FreeRTOS_select return value #596

Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
bdb3f06
Updated comments for FreeRTOS_select return value
tony-josi-aws Dec 6, 2022
f69e20b
Updated the function brief for FreeRTOS_select
Dec 7, 2022
19ee10f
Uncrustify: triggered by comment.
actions-user Dec 8, 2022
a77b0d7
Updating FreeRTOS_select function @brief
tony-josi-aws Dec 8, 2022
c5c84d5
Updated function brief for FreeRTOS_SignalSocket
tony-josi-aws Dec 8, 2022
a0585ad
Uncrustify: triggered by comment.
actions-user Dec 9, 2022
0bb0579
Update source/FreeRTOS_Sockets.c
AniruddhaKanhere Dec 9, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 10 additions & 2 deletions source/FreeRTOS_Sockets.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -704,15 +704,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 @@ -5133,6 +5137,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