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_client_socket_bind 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 bind */ 49 /* function call. */ 50 /* */ 51 /* INPUT */ 52 /* */ 53 /* socket_ptr Pointer to TCP socket */ 54 /* port 16-bit TCP port number */ 55 /* wait_option Suspension option */ 56 /* */ 57 /* OUTPUT */ 58 /* */ 59 /* status Completion status */ 60 /* */ 61 /* CALLS */ 62 /* */ 63 /* _nx_tcp_client_socket_bind Actual TCP client socket bind */ 64 /* function */ 65 /* */ 66 /* CALLED BY */ 67 /* */ 68 /* Application Code */ 69 /* */ 70 /* RELEASE HISTORY */ 71 /* */ 72 /* DATE NAME DESCRIPTION */ 73 /* */ 74 /* 05-19-2020 Yuxin Zhou Initial Version 6.0 */ 75 /* 09-30-2020 Yuxin Zhou Modified comment(s), */ 76 /* resulting in version 6.1 */ 77 /* */ 78 /**************************************************************************/ _nxe_tcp_client_socket_bind(NX_TCP_SOCKET * socket_ptr,UINT port,ULONG wait_option)79UINT _nxe_tcp_client_socket_bind(NX_TCP_SOCKET *socket_ptr, UINT port, ULONG wait_option) 80 { 81 82 UINT status; 83 84 85 /* Check for invalid input pointers. */ 86 if ((socket_ptr == NX_NULL) || (socket_ptr -> nx_tcp_socket_id != NX_TCP_ID)) 87 { 88 return(NX_PTR_ERROR); 89 } 90 91 /* Check to see if TCP is enabled. */ 92 if (!(socket_ptr -> nx_tcp_socket_ip_ptr) -> nx_ip_tcp_packet_receive) 93 { 94 return(NX_NOT_ENABLED); 95 } 96 97 /* Check for an invalid port. */ 98 if (((ULONG)port) > (ULONG)NX_MAX_PORT) 99 { 100 return(NX_INVALID_PORT); 101 } 102 103 /* Check for appropriate caller. */ 104 NX_THREADS_ONLY_CALLER_CHECKING 105 106 /* Call actual TCP client socket bind function. */ 107 status = _nx_tcp_client_socket_bind(socket_ptr, port, wait_option); 108 109 /* Return completion status. */ 110 return(status); 111 } 112 113
