Adds a warning if the stream-buffer or windows properties are changed…

… on an already connected socket. Discussed in FreeRTOS#1184 (FreeRTOS#1188) Also changes the error message to using FreeRTOS_printf instead of FreeRTOS_debug_printf to increase the chances of being seen. Co-authored-by: Emil Popov <[email protected]>
HTRamsey · Sep 16, 2024 · 8aebab7 · 8aebab7
1 parent a45bfe2
commit 8aebab7
Showing 1 changed file with 12 additions and 4 deletions.
diff --git a/source/FreeRTOS_Sockets.c b/source/FreeRTOS_Sockets.c
@@ -2356,17 +2356,25 @@ void * vSocketClose( FreeRTOS_Socket_t * pxSocket )
         uint32_t ulNewValue;
         BaseType_t xReturn;
 
+        if( ( FreeRTOS_issocketconnected( pxSocket ) == pdTRUE ) )
+        {
+            /* If this socket is the child of a listening socket, the remote client may or may not have already sent
+             * us data. If data was already sent, then pxSocket->u.xTCP.rxStream != NULL and this call will fail.
+             * Warn the user about this inconsistent behavior. */
+            FreeRTOS_printf( ( "Warning: Changing buffer/window properties on a connected socket may fail." ) );
+        }
+
         if( pxSocket->ucProtocol != ( uint8_t ) FREERTOS_IPPROTO_TCP )
         {
-            FreeRTOS_debug_printf( ( "Set SO_%sBUF: wrong socket type\n",
-                                     ( lOptionName == FREERTOS_SO_SNDBUF ) ? "SND" : "RCV" ) );
+            FreeRTOS_printf( ( "Set SO_%sBUF: wrong socket type\n",
+                               ( lOptionName == FREERTOS_SO_SNDBUF ) ? "SND" : "RCV" ) );
             xReturn = -pdFREERTOS_ERRNO_EINVAL;
         }
         else if( ( ( lOptionName == FREERTOS_SO_SNDBUF ) && ( pxSocket->u.xTCP.txStream != NULL ) ) ||
                  ( ( lOptionName == FREERTOS_SO_RCVBUF ) && ( pxSocket->u.xTCP.rxStream != NULL ) ) )
         {
-            FreeRTOS_debug_printf( ( "Set SO_%sBUF: buffer already created\n",
-                                     ( lOptionName == FREERTOS_SO_SNDBUF ) ? "SND" : "RCV" ) );
+            FreeRTOS_printf( ( "Set SO_%sBUF: buffer already created\n",
+                               ( lOptionName == FREERTOS_SO_SNDBUF ) ? "SND" : "RCV" ) );
             xReturn = -pdFREERTOS_ERRNO_EINVAL;
         }
         else