From bdb3f06e3528818f2b5411b3120189d3662656f3 Mon Sep 17 00:00:00 2001 From: Tony Josi Date: Tue, 6 Dec 2022 21:07:07 +0530 Subject: [PATCH 1/7] Updated comments for FreeRTOS_select return value --- source/FreeRTOS_Sockets.c | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/source/FreeRTOS_Sockets.c b/source/FreeRTOS_Sockets.c index 9a297817db..d09d1e5e9e 100644 --- a/source/FreeRTOS_Sockets.c +++ b/source/FreeRTOS_Sockets.c @@ -712,7 +712,8 @@ Socket_t FreeRTOS_socket( BaseType_t xDomain, * 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 in which an event occurred. + * */ BaseType_t FreeRTOS_select( SocketSet_t xSocketSet, TickType_t xBlockTimeTicks ) From f69e20b752d683f459283d2befe8fc88381497ce Mon Sep 17 00:00:00 2001 From: Ubuntu Date: Wed, 7 Dec 2022 11:39:18 +0000 Subject: [PATCH 2/7] Updated the function brief for FreeRTOS_select --- source/FreeRTOS_Sockets.c | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/source/FreeRTOS_Sockets.c b/source/FreeRTOS_Sockets.c index d09d1e5e9e..2001cf83e7 100644 --- a/source/FreeRTOS_Sockets.c +++ b/source/FreeRTOS_Sockets.c @@ -712,7 +712,9 @@ Socket_t FreeRTOS_socket( BaseType_t xDomain, * If the value is 'portMAX_DELAY' then the function will wait * indefinitely for an event to occur. * - * @return The event bits (event flags) value for the socket in which an event occurred. + * @return The event bits (event flags) value for the socket set in which an + * event occurred. During the call if any socket is signalled + * (using FreeRTOS_SignalSocket), then eSELECT_INTR is returned. * */ BaseType_t FreeRTOS_select( SocketSet_t xSocketSet, From 19ee10fb13de0075f11a8d614e6640bacf4faa9d Mon Sep 17 00:00:00 2001 From: GitHub Action Date: Thu, 8 Dec 2022 04:16:00 +0000 Subject: [PATCH 3/7] Uncrustify: triggered by comment. --- source/FreeRTOS_Sockets.c | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/FreeRTOS_Sockets.c b/source/FreeRTOS_Sockets.c index 2001cf83e7..31e1dce8b5 100644 --- a/source/FreeRTOS_Sockets.c +++ b/source/FreeRTOS_Sockets.c @@ -713,7 +713,7 @@ Socket_t FreeRTOS_socket( BaseType_t xDomain, * indefinitely for an event to occur. * * @return The event bits (event flags) value for the socket set in which an - * event occurred. During the call if any socket is signalled + * event occurred. During the call if any socket is signalled * (using FreeRTOS_SignalSocket), then eSELECT_INTR is returned. * */ From a77b0d786222565db92631d4f47b5788e4a34c90 Mon Sep 17 00:00:00 2001 From: tony-josi-aws Date: Thu, 8 Dec 2022 04:37:21 +0000 Subject: [PATCH 4/7] Updating FreeRTOS_select function @brief --- source/FreeRTOS_Sockets.c | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/FreeRTOS_Sockets.c b/source/FreeRTOS_Sockets.c index 31e1dce8b5..d2241108b7 100644 --- a/source/FreeRTOS_Sockets.c +++ b/source/FreeRTOS_Sockets.c @@ -704,7 +704,7 @@ 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. From c5c84d55744135e4b83e9eca56e08c04d27ddc4a Mon Sep 17 00:00:00 2001 From: tony-josi-aws Date: Thu, 8 Dec 2022 05:16:23 +0000 Subject: [PATCH 5/7] Updated function brief for FreeRTOS_SignalSocket --- source/FreeRTOS_Sockets.c | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/source/FreeRTOS_Sockets.c b/source/FreeRTOS_Sockets.c index d2241108b7..3fab7a2212 100644 --- a/source/FreeRTOS_Sockets.c +++ b/source/FreeRTOS_Sockets.c @@ -713,8 +713,9 @@ Socket_t FreeRTOS_socket( BaseType_t xDomain, * indefinitely for an event to occur. * * @return The event bits (event flags) value for the socket set in which an - * event occurred. During the call if any socket is signalled - * (using FreeRTOS_SignalSocket), then eSELECT_INTR is returned. + * 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, @@ -5136,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. Else 0 is returned. */ BaseType_t FreeRTOS_SignalSocket( Socket_t xSocket ) { From a0585ad137530f2d31140acfe0fb59af76fd33d8 Mon Sep 17 00:00:00 2001 From: GitHub Action Date: Fri, 9 Dec 2022 06:22:21 +0000 Subject: [PATCH 6/7] Uncrustify: triggered by comment. --- source/FreeRTOS_Sockets.c | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/source/FreeRTOS_Sockets.c b/source/FreeRTOS_Sockets.c index 3fab7a2212..a158f7b3c1 100644 --- a/source/FreeRTOS_Sockets.c +++ b/source/FreeRTOS_Sockets.c @@ -713,8 +713,8 @@ Socket_t FreeRTOS_socket( BaseType_t xDomain, * indefinitely for an event to occur. * * @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 + * event occurred. If any socket is signalled during the call, using + * FreeRTOS_SignalSocket() or FreeRTOS_SignalSocketFromISR(), then eSELECT_INTR * is returned. * */ @@ -5137,9 +5137,9 @@ 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 + * + * @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. Else 0 is returned. */ BaseType_t FreeRTOS_SignalSocket( Socket_t xSocket ) From 0bb057990e7e550cc10cf0b77f13c2f38af57cca Mon Sep 17 00:00:00 2001 From: Aniruddha Kanhere <60444055+AniruddhaKanhere@users.noreply.github.com> Date: Fri, 9 Dec 2022 12:11:23 +0530 Subject: [PATCH 7/7] Update source/FreeRTOS_Sockets.c --- source/FreeRTOS_Sockets.c | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/FreeRTOS_Sockets.c b/source/FreeRTOS_Sockets.c index a158f7b3c1..af1248ad24 100644 --- a/source/FreeRTOS_Sockets.c +++ b/source/FreeRTOS_Sockets.c @@ -5140,7 +5140,7 @@ void * pvSocketGetSocketID( const ConstSocket_t xSocket ) * * @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. Else 0 is returned. + * is returned. On successful sending of a signal, 0 is returned. */ BaseType_t FreeRTOS_SignalSocket( Socket_t xSocket ) {