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 /* FUNCTION RELEASE */ 39 /* */ 40 /* _nxe_tcp_socket_disconnect_complete_notify PORTABLE C */ 41 /* 6.1 */ 42 /* AUTHOR */ 43 /* */ 44 /* Yuxin Zhou, Microsoft Corporation */ 45 /* */ 46 /* DESCRIPTION */ 47 /* */ 48 /* This function checks for errors in the TCP socket disconnect */ 49 /* complete notify function call. */ 50 /* */ 51 /* INPUT */ 52 /* */ 53 /* socket_ptr Pointer to TCP socket */ 54 /* tcp_disconnect_complete_notify Routine to call when the */ 55 /* disconnect is completed */ 56 /* */ 57 /* OUTPUT */ 58 /* */ 59 /* status Completion status */ 60 /* */ 61 /* CALLS */ 62 /* */ 63 /* _nx_tcp_socket_disconnect_complete_notify */ 64 /* Actual socket disconnect */ 65 /* complete notify 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_disconnect_complete_notify(NX_TCP_SOCKET * socket_ptr,VOID (* tcp_disconnect_complete_notify)(NX_TCP_SOCKET * socket_ptr))80UINT _nxe_tcp_socket_disconnect_complete_notify(NX_TCP_SOCKET *socket_ptr, VOID (*tcp_disconnect_complete_notify)(NX_TCP_SOCKET *socket_ptr)) 81 { 82 #ifndef NX_DISABLE_EXTENDED_NOTIFY_SUPPORT 83 84 UINT status; 85 86 /* Check for invalid input pointers. */ 87 if ((socket_ptr == NX_NULL) || (socket_ptr -> nx_tcp_socket_id != NX_TCP_ID) || (tcp_disconnect_complete_notify == NX_NULL)) 88 { 89 return(NX_PTR_ERROR); 90 } 91 92 /* Check to see if TCP is enabled. */ 93 if (!(socket_ptr -> nx_tcp_socket_ip_ptr) -> nx_ip_tcp_packet_receive) 94 { 95 return(NX_NOT_ENABLED); 96 } 97 98 /* Check for appropriate caller. */ 99 NX_INIT_AND_THREADS_CALLER_CHECKING 100 101 /* Call actual socket disconnect complete notify function. */ 102 status = _nx_tcp_socket_disconnect_complete_notify(socket_ptr, tcp_disconnect_complete_notify); 103 104 /* Return to caller. */ 105 return(status); 106 107 #else /* !NX_DISABLE_EXTENDED_NOTIFY_SUPPORT */ 108 NX_PARAMETER_NOT_USED(socket_ptr); 109 NX_PARAMETER_NOT_USED(tcp_disconnect_complete_notify); 110 111 return(NX_NOT_SUPPORTED); 112 113 #endif /* NX_DISABLE_EXTENDED_NOTIFY_SUPPORT */ 114 } 115 116
