Skip to content

Commit c5c84d5

Browse files
committed
Updated function brief for FreeRTOS_SignalSocket
1 parent a77b0d7 commit c5c84d5

File tree

1 file changed

+7
-2
lines changed

1 file changed

+7
-2
lines changed

source/FreeRTOS_Sockets.c

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -713,8 +713,9 @@ Socket_t FreeRTOS_socket( BaseType_t xDomain,
713713
* indefinitely for an event to occur.
714714
*
715715
* @return The event bits (event flags) value for the socket set in which an
716-
* event occurred. During the call if any socket is signalled
717-
* (using FreeRTOS_SignalSocket), then eSELECT_INTR is returned.
716+
* event occurred. If any socket is signalled during the call, using
717+
* FreeRTOS_SignalSocket() or FreeRTOS_SignalSocketFromISR(), then eSELECT_INTR
718+
* is returned.
718719
*
719720
*/
720721
BaseType_t FreeRTOS_select( SocketSet_t xSocketSet,
@@ -5136,6 +5137,10 @@ void * pvSocketGetSocketID( const ConstSocket_t xSocket )
51365137
* and return the value -pdFREERTOS_ERRNO_EINTR ( -4 ).
51375138
*
51385139
* @param[in] xSocket: The socket that will be signalled.
5140+
*
5141+
* @return If xSocket is an invalid socket (NULL) or if the socket set is invalid (NULL)
5142+
* and/or if event group is invalid/not created, then, -pdFREERTOS_ERRNO_EINVAL
5143+
* is returned. Else 0 is returned.
51395144
*/
51405145
BaseType_t FreeRTOS_SignalSocket( Socket_t xSocket )
51415146
{

0 commit comments

Comments
 (0)