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 #ifndef NX_DISABLE_EXTENDED_NOTIFY_SUPPORT 32 /* Bring in externs for caller checking code. */ 33 34 NX_CALLER_CHECKING_EXTERNS 35 #endif /* NX_DISABLE_EXTENDED_NOTIFY_SUPPORT */ 36 37 /**************************************************************************/ 38 /* */ 39 /* FUNCTION RELEASE */ 40 /* */ 41 /* _nxe_tcp_socket_establishe_notify PORTABLE C */ 42 /* 6.1 */ 43 /* AUTHOR */ 44 /* */ 45 /* Yuxin Zhou, Microsoft Corporation */ 46 /* */ 47 /* DESCRIPTION */ 48 /* */ 49 /* This function checks for errors in the TCP socket establish notify */ 50 /* function call. */ 51 /* */ 52 /* INPUT */ 53 /* */ 54 /* socket_ptr Pointer to TCP socket */ 55 /* tcp_establish_notify Routine to call when the */ 56 /* connection handshake is */ 57 /* completed */ 58 /* */ 59 /* OUTPUT */ 60 /* */ 61 /* status Completion status */ 62 /* */ 63 /* CALLS */ 64 /* */ 65 /* _nx_tcp_socket_establish_notify Actual socket establish notify*/ 66 /* function */ 67 /* */ 68 /* CALLED BY */ 69 /* */ 70 /* Application Code */ 71 /* */ 72 /* RELEASE HISTORY */ 73 /* */ 74 /* DATE NAME DESCRIPTION */ 75 /* */ 76 /* 05-19-2020 Yuxin Zhou Initial Version 6.0 */ 77 /* 09-30-2020 Yuxin Zhou Modified comment(s), */ 78 /* resulting in version 6.1 */ 79 /* */ 80 /**************************************************************************/ _nxe_tcp_socket_establish_notify(NX_TCP_SOCKET * socket_ptr,VOID (* tcp_establish_notify)(NX_TCP_SOCKET * socket_ptr))81UINT _nxe_tcp_socket_establish_notify(NX_TCP_SOCKET *socket_ptr, VOID (*tcp_establish_notify)(NX_TCP_SOCKET *socket_ptr)) 82 { 83 #ifndef NX_DISABLE_EXTENDED_NOTIFY_SUPPORT 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_establish_notify == NX_NULL)) 88 { 89 return(NX_PTR_ERROR); 90 } 91 92 93 /* Check to see if TCP is enabled. */ 94 if (!(socket_ptr -> nx_tcp_socket_ip_ptr) -> nx_ip_tcp_packet_receive) 95 { 96 return(NX_NOT_ENABLED); 97 } 98 99 /* Check for appropriate caller. */ 100 NX_INIT_AND_THREADS_CALLER_CHECKING 101 102 /* Call actual socket establish notify function. */ 103 status = _nx_tcp_socket_establish_notify(socket_ptr, tcp_establish_notify); 104 105 /* Return to caller. */ 106 return(status); 107 108 #else /* !NX_DISABLE_EXTENDED_NOTIFY_SUPPORT */ 109 NX_PARAMETER_NOT_USED(socket_ptr); 110 NX_PARAMETER_NOT_USED(tcp_establish_notify); 111 112 return(NX_NOT_SUPPORTED); 113 114 #endif /* NX_DISABLE_EXTENDED_NOTIFY_SUPPORT */ 115 } 116 117
