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 32 /* Bring in externs for caller checking code. */ 33 34 NX_CALLER_CHECKING_EXTERNS 35 36 37 /**************************************************************************/ 38 /* */ 39 /* FUNCTION RELEASE */ 40 /* */ 41 /* _nxe_tcp_socket_state_wait 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 socket state wait */ 50 /* function call. */ 51 /* */ 52 /* INPUT */ 53 /* */ 54 /* socket_ptr Pointer to socket */ 55 /* desired_state Desired TCP state */ 56 /* wait_option Suspension option */ 57 /* */ 58 /* OUTPUT */ 59 /* */ 60 /* status Completion status */ 61 /* */ 62 /* CALLS */ 63 /* */ 64 /* _nx_tcp_socket_state_wait Actual socket state wait */ 65 /* function */ 66 /* */ 67 /* CALLED BY */ 68 /* */ 69 /* Application */ 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_state_wait(NX_TCP_SOCKET * socket_ptr,UINT desired_state,ULONG wait_option)80UINT _nxe_tcp_socket_state_wait(NX_TCP_SOCKET *socket_ptr, UINT desired_state, ULONG wait_option) 81 { 82 83 UINT status; 84 85 86 /* Check for invalid input pointers. */ 87 if ((socket_ptr == NX_NULL) || (socket_ptr -> nx_tcp_socket_id != NX_TCP_ID)) 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 an invalid state request. */ 99 if ((desired_state < NX_TCP_CLOSED) || (desired_state > NX_TCP_LAST_ACK)) 100 { 101 return(NX_OPTION_ERROR); 102 } 103 104 /* Check for appropriate caller. */ 105 NX_THREADS_ONLY_CALLER_CHECKING 106 107 /* Call actual TCP socket state wait function. */ 108 status = _nx_tcp_socket_state_wait(socket_ptr, desired_state, wait_option); 109 110 /* Return completion status. */ 111 return(status); 112 } 113 114
