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 #ifndef NX_DISABLE_EXTENDED_NOTIFY_SUPPORT 31 /* Bring in externs for caller checking code. */ 32 33 NX_CALLER_CHECKING_EXTERNS 34 #endif /* NX_DISABLE_EXTENDED_NOTIFY_SUPPORT */ 35 36 37 /**************************************************************************/ 38 /* */ 39 /* FUNCTION RELEASE */ 40 /* */ 41 /* _nxe_tcp_socket_timed_wait_callback PORTABLE C */ 42 /* 6.1 */ 43 /* AUTHOR */ 44 /* */ 45 /* Yuxin Zhou, Microsoft Corporation */ 46 /* */ 47 /* DESCRIPTION */ 48 /* */ 49 /* This function performs error checking for the timed wait callback */ 50 /* service. */ 51 /* */ 52 /* INPUT */ 53 /* */ 54 /* socket_ptr Pointer to TCP socket */ 55 /* tcp_timed_wait_callback Routine to call to start */ 56 /* timed wait before close */ 57 /* */ 58 /* OUTPUT */ 59 /* */ 60 /* status Completion status */ 61 /* */ 62 /* CALLS */ 63 /* */ 64 /* _nx_tcp_socket_timed_wait_callback Actual timed wait callback */ 65 /* service */ 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_timed_wait_callback(NX_TCP_SOCKET * socket_ptr,VOID (* tcp_timed_wait_callback)(NX_TCP_SOCKET * socket_ptr))80UINT _nxe_tcp_socket_timed_wait_callback(NX_TCP_SOCKET *socket_ptr, VOID (*tcp_timed_wait_callback)(NX_TCP_SOCKET *socket_ptr)) 81 { 82 #ifndef NX_DISABLE_EXTENDED_NOTIFY_SUPPORT 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_timed_wait_callback == 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_INIT_AND_THREADS_CALLER_CHECKING 107 108 /* Call the actual service. */ 109 status = _nx_tcp_socket_timed_wait_callback(socket_ptr, tcp_timed_wait_callback); 110 111 /* Return completion status. */ 112 return(status); 113 114 #else /* !NX_DISABLE_EXTENDED_NOTIFY_SUPPORT */ 115 NX_PARAMETER_NOT_USED(socket_ptr); 116 NX_PARAMETER_NOT_USED(tcp_timed_wait_callback); 117 118 return(NX_NOT_SUPPORTED); 119 120 #endif /* NX_DISABLE_EXTENDED_NOTIFY_SUPPORT */ 121 } 122 123
