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 /* Bring in externs for caller checking code. */ 32 NX_CALLER_CHECKING_EXTERNS 33 34 35 /**************************************************************************/ 36 /* */ 37 /* FUNCTION RELEASE */ 38 /* */ 39 /* _nxe_tcp_socket_window_update_notify_set PORTABLE C */ 40 /* 6.1 */ 41 /* AUTHOR */ 42 /* */ 43 /* Yuxin Zhou, Microsoft Corporation */ 44 /* */ 45 /* DESCRIPTION */ 46 /* */ 47 /* This function checks for errors in the TCP socket window update */ 48 /* notify set call. */ 49 /* */ 50 /* INPUT */ 51 /* */ 52 /* socket_ptr Pointer to TCP socket */ 53 /* tcp_window_udpate_notify Routine to call when NetX */ 54 /* receives a window update */ 55 /* */ 56 /* OUTPUT */ 57 /* */ 58 /* status Completion status */ 59 /* */ 60 /* CALLS */ 61 /* */ 62 /* _nx_tcp_socket_window_update_notify_set */ 63 /* Acutal notify set routine. */ 64 /* */ 65 /* CALLED BY */ 66 /* */ 67 /* Application Code */ 68 /* */ 69 /* RELEASE HISTORY */ 70 /* */ 71 /* DATE NAME DESCRIPTION */ 72 /* */ 73 /* 05-19-2020 Yuxin Zhou Initial Version 6.0 */ 74 /* 09-30-2020 Yuxin Zhou Modified comment(s), */ 75 /* resulting in version 6.1 */ 76 /* */ 77 /**************************************************************************/ _nxe_tcp_socket_window_update_notify_set(NX_TCP_SOCKET * socket_ptr,VOID (* tcp_socket_window_update_notify)(NX_TCP_SOCKET * socket_ptr))78UINT _nxe_tcp_socket_window_update_notify_set(NX_TCP_SOCKET *socket_ptr, 79 VOID (*tcp_socket_window_update_notify)(NX_TCP_SOCKET *socket_ptr)) 80 { 81 82 /* Check for invalid input pointers. */ 83 if ((socket_ptr == NX_NULL) || (socket_ptr -> nx_tcp_socket_id != NX_TCP_ID)) 84 { 85 return(NX_PTR_ERROR); 86 } 87 88 /* Check for invalid input pointers. */ 89 if (tcp_socket_window_update_notify == NX_NULL) 90 { 91 return(NX_PTR_ERROR); 92 } 93 94 /* Check to see if TCP is enabled. */ 95 if (!(socket_ptr -> nx_tcp_socket_ip_ptr) -> nx_ip_tcp_packet_receive) 96 { 97 return(NX_NOT_ENABLED); 98 } 99 100 /* Check for appropriate caller. */ 101 NX_INIT_AND_THREADS_CALLER_CHECKING 102 103 return(_nx_tcp_socket_window_update_notify_set(socket_ptr, tcp_socket_window_update_notify)); 104 } 105 106
