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 31 /**************************************************************************/ 32 /* */ 33 /* FUNCTION RELEASE */ 34 /* */ 35 /* _nx_tcp_socket_queue_depth_notify_set PORTABLE C */ 36 /* 6.1 */ 37 /* AUTHOR */ 38 /* */ 39 /* Yuxin Zhou, Microsoft Corporation */ 40 /* */ 41 /* DESCRIPTION */ 42 /* */ 43 /* This function sets the transmit queue depth update callback to the */ 44 /* function specified by the application, which is called whenever */ 45 /* the specified socket determines that it has released packets from */ 46 /* the transmit queue such that the queue depth is no longer exceeded. */ 47 /* */ 48 /* If a NULL pointer is supplied, the queue depth notify function is */ 49 /* disabled. */ 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 /* None */ 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 /**************************************************************************/ _nx_tcp_socket_queue_depth_notify_set(NX_TCP_SOCKET * socket_ptr,VOID (* tcp_socket_queue_depth_notify)(NX_TCP_SOCKET * socket_ptr))79UINT _nx_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 TX_INTERRUPT_SAVE_AREA 83 84 /* Get mutex protection. */ 85 tx_mutex_get(&(socket_ptr -> nx_tcp_socket_ip_ptr -> nx_ip_protection), TX_WAIT_FOREVER); 86 87 /* Disable interrupts. */ 88 TX_DISABLE 89 90 /* Setup the receive notify function pointer. */ 91 socket_ptr -> nx_tcp_socket_queue_depth_notify = tcp_socket_queue_depth_notify; 92 93 /* Restore interrupts. */ 94 TX_RESTORE 95 96 /* Release protection. */ 97 tx_mutex_put(&(socket_ptr -> nx_tcp_socket_ip_ptr -> nx_ip_protection)); 98 99 /* Return successful completion. */ 100 return(NX_SUCCESS); 101 102 #else /* !NX_ENABLE_TCP_QUEUE_DEPTH_UPDATE_NOTIFY */ 103 NX_PARAMETER_NOT_USED(socket_ptr); 104 NX_PARAMETER_NOT_USED(tcp_socket_queue_depth_notify); 105 106 return(NX_NOT_SUPPORTED); 107 108 #endif /* NX_ENABLE_TCP_QUEUE_DEPTH_UPDATE_NOTIFY */ 109 } 110 111
