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 33 NX_CALLER_CHECKING_EXTERNS 34 35 36 /**************************************************************************/ 37 /* */ 38 /* FUNCTION RELEASE */ 39 /* */ 40 /* _nxe_tcp_socket_receive_notify PORTABLE C */ 41 /* 6.2.1 */ 42 /* AUTHOR */ 43 /* */ 44 /* Yuxin Zhou, Microsoft Corporation */ 45 /* */ 46 /* DESCRIPTION */ 47 /* */ 48 /* This function checks for errors in the TCP socket receive notify */ 49 /* function call. */ 50 /* */ 51 /* INPUT */ 52 /* */ 53 /* socket_ptr Pointer to TCP socket */ 54 /* tcp_receive_notify Routine to call when one or */ 55 /* receive packets are */ 56 /* available for the socket */ 57 /* */ 58 /* OUTPUT */ 59 /* */ 60 /* status Completion status */ 61 /* */ 62 /* CALLS */ 63 /* */ 64 /* _nx_tcp_socket_receive_notify Actual socket receive notify */ 65 /* 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 /* 03-08-2023 Yajun Xia Modified comment(s), */ 79 /* removed invalid check, */ 80 /* resulting in version 6.2.1 */ 81 /* */ 82 /**************************************************************************/ _nxe_tcp_socket_receive_notify(NX_TCP_SOCKET * socket_ptr,VOID (* tcp_receive_notify)(NX_TCP_SOCKET * socket_ptr))83UINT _nxe_tcp_socket_receive_notify(NX_TCP_SOCKET *socket_ptr, 84 VOID (*tcp_receive_notify)(NX_TCP_SOCKET *socket_ptr)) 85 { 86 87 UINT status; 88 89 /* Check for invalid input pointers. */ 90 if ((socket_ptr == NX_NULL) || (socket_ptr -> nx_tcp_socket_id != NX_TCP_ID)) 91 { 92 return(NX_PTR_ERROR); 93 } 94 95 /* Check to see if TCP is enabled. */ 96 if (!(socket_ptr -> nx_tcp_socket_ip_ptr) -> nx_ip_tcp_packet_receive) 97 { 98 return(NX_NOT_ENABLED); 99 } 100 101 /* Check for appropriate caller. */ 102 NX_INIT_AND_THREADS_CALLER_CHECKING 103 104 105 /* Call actual socket receive notify function. */ 106 status = _nx_tcp_socket_receive_notify(socket_ptr, tcp_receive_notify); 107 108 /* Return to caller. */ 109 return(status); 110 } 111 112
