1 /*************************************************************************** 2 * Copyright (c) 2024 Microsoft Corporation 3 * 4 * This program and the accompanying materials are made available under the 5 * terms of the MIT License which is available at 6 * https://opensource.org/licenses/MIT. 7 * 8 * SPDX-License-Identifier: MIT 9 **************************************************************************/ 10 11 12 /**************************************************************************/ 13 /**************************************************************************/ 14 /** */ 15 /** NetX Component */ 16 /** */ 17 /** Transmission Control Protocol (TCP) */ 18 /** */ 19 /**************************************************************************/ 20 /**************************************************************************/ 21 22 #define NX_SOURCE_CODE 23 24 25 /* Include necessary system files. */ 26 27 #include "nx_api.h" 28 #include "nx_tcp.h" 29 30 #ifdef NX_ENABLE_TCP_QUEUE_DEPTH_UPDATE_NOTIFY 31 /* Bring in externs for caller checking code. */ 32 NX_CALLER_CHECKING_EXTERNS 33 #endif /* NX_ENABLE_TCP_QUEUE_DEPTH_UPDATE_NOTIFY */ 34 35 36 /**************************************************************************/ 37 /* */ 38 /* FUNCTION RELEASE */ 39 /* */ 40 /* _nxe_tcp_socket_queue_depth_notify_set PORTABLE C */ 41 /* 6.1 */ 42 /* AUTHOR */ 43 /* */ 44 /* Yuxin Zhou, Microsoft Corporation */ 45 /* */ 46 /* DESCRIPTION */ 47 /* */ 48 /* This function is the error handling service for the queue depth */ 49 /* notify callback setting function. */ 50 /* */ 51 /* INPUT */ 52 /* */ 53 /* socket_ptr Pointer to TCP socket */ 54 /* tcp_queue_depth_notify Routine to call when NetX */ 55 /* queue depth decreases below */ 56 /* the maximum transmit depth */ 57 /* */ 58 /* OUTPUT */ 59 /* */ 60 /* status Completion status */ 61 /* */ 62 /* CALLS */ 63 /* */ 64 /* _nx_tcp_socket_queue_depth_notify_set Actual callback set function */ 65 /* */ 66 /* CALLED BY */ 67 /* */ 68 /* Application Code */ 69 /* */ 70 /* RELEASE HISTORY */ 71 /* */ 72 /* DATE NAME DESCRIPTION */ 73 /* */ 74 /* 05-19-2020 Yuxin Zhou Initial Version 6.0 */ 75 /* 09-30-2020 Yuxin Zhou Modified comment(s), */ 76 /* resulting in version 6.1 */ 77 /* */ 78 /**************************************************************************/ _nxe_tcp_socket_queue_depth_notify_set(NX_TCP_SOCKET * socket_ptr,VOID (* tcp_socket_queue_depth_notify)(NX_TCP_SOCKET * socket_ptr))79UINT _nxe_tcp_socket_queue_depth_notify_set(NX_TCP_SOCKET *socket_ptr, VOID (*tcp_socket_queue_depth_notify)(NX_TCP_SOCKET *socket_ptr)) 80 { 81 #ifdef NX_ENABLE_TCP_QUEUE_DEPTH_UPDATE_NOTIFY 82 83 UINT status; 84 85 86 /* Check for invalid input pointers. */ 87 if ((socket_ptr == NX_NULL) || (socket_ptr -> nx_tcp_socket_id != NX_TCP_ID)) 88 { 89 return(NX_PTR_ERROR); 90 } 91 92 /* Check for invalid input pointers. */ 93 if (tcp_socket_queue_depth_notify == NX_NULL) 94 { 95 return(NX_PTR_ERROR); 96 } 97 98 /* Check to see if TCP is enabled. */ 99 if (!(socket_ptr -> nx_tcp_socket_ip_ptr) -> nx_ip_tcp_packet_receive) 100 { 101 return(NX_NOT_ENABLED); 102 } 103 104 /* Check for appropriate caller. */ 105 NX_THREADS_ONLY_CALLER_CHECKING 106 107 /* Setup the receive notify function pointer. */ 108 status = _nx_tcp_socket_queue_depth_notify_set(socket_ptr, tcp_socket_queue_depth_notify); 109 110 /* Return successful completion. */ 111 return(status); 112 113 #else /* !NX_ENABLE_TCP_QUEUE_DEPTH_UPDATE_NOTIFY */ 114 NX_PARAMETER_NOT_USED(socket_ptr); 115 NX_PARAMETER_NOT_USED(tcp_socket_queue_depth_notify); 116 117 return(NX_NOT_SUPPORTED); 118 119 #endif /* NX_ENABLE_TCP_QUEUE_DEPTH_UPDATE_NOTIFY */ 120 } 121 122
