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