1 /*************************************************************************** 2 * Copyright (c) 2024 Microsoft Corporation 3 * 4 * This program and the accompanying materials are made available under the 5 * terms of the MIT License which is available at 6 * https://opensource.org/licenses/MIT. 7 * 8 * SPDX-License-Identifier: MIT 9 **************************************************************************/ 10 11 12 /**************************************************************************/ 13 /**************************************************************************/ 14 /** */ 15 /** NetX Component */ 16 /** */ 17 /** Transmission Control Protocol (TCP) */ 18 /** */ 19 /**************************************************************************/ 20 /**************************************************************************/ 21 22 #define NX_SOURCE_CODE 23 24 25 /* Include necessary system files. */ 26 27 #include "nx_api.h" 28 #include "nx_tcp.h" 29 30 /* Bring in externs for caller checking code. */ 31 NX_CALLER_CHECKING_EXTERNS 32 33 34 /**************************************************************************/ 35 /* */ 36 /* FUNCTION RELEASE */ 37 /* */ 38 /* _nxde_tcp_socket_peer_info_get PORTABLE C */ 39 /* 6.1 */ 40 /* AUTHOR */ 41 /* */ 42 /* Yuxin Zhou, Microsoft Corporation */ 43 /* */ 44 /* DESCRIPTION */ 45 /* */ 46 /* This function performs error checking on the TCP socket peer info */ 47 /* get service. */ 48 /* */ 49 /* INPUT */ 50 /* */ 51 /* socket_ptr Pointer to the TCP socket */ 52 /* peer_ip_address Pointer to the IP address */ 53 /* of the peer. */ 54 /* peer_port Pointer to the port number */ 55 /* of the peer. */ 56 /* */ 57 /* OUTPUT */ 58 /* */ 59 /* status Actual completion status */ 60 /* NX_PTR_ERROR Invalid pointer input */ 61 /* NX_NOT_ENABLED TCP not enabled on IP instance*/ 62 /* */ 63 /* CALLS */ 64 /* */ 65 /* _nxd_tcp_socket_peer_info_get Actual TCP socket peer info */ 66 /* get function */ 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 /* */ 79 /**************************************************************************/ _nxde_tcp_socket_peer_info_get(NX_TCP_SOCKET * socket_ptr,NXD_ADDRESS * peer_ip_address,ULONG * peer_port)80UINT _nxde_tcp_socket_peer_info_get(NX_TCP_SOCKET *socket_ptr, 81 NXD_ADDRESS *peer_ip_address, 82 ULONG *peer_port) 83 { 84 85 UINT status; 86 87 88 /* Check for invalid input pointers. */ 89 if ((socket_ptr == NX_NULL) || (socket_ptr -> nx_tcp_socket_id != NX_TCP_ID)) 90 { 91 return(NX_PTR_ERROR); 92 } 93 94 if ((peer_ip_address == NX_NULL) || (peer_port == NX_NULL)) 95 { 96 return(NX_PTR_ERROR); 97 } 98 99 /* Check to see if TCP is enabled. */ 100 if (!(socket_ptr -> nx_tcp_socket_ip_ptr) -> nx_ip_tcp_packet_receive) 101 { 102 return(NX_NOT_ENABLED); 103 } 104 105 /* Check for appropriate caller. */ 106 NX_THREADS_ONLY_CALLER_CHECKING 107 108 /* Call actual TCP socket MSS get function. */ 109 status = _nxd_tcp_socket_peer_info_get(socket_ptr, peer_ip_address, peer_port); 110 111 /* Return completion status. */ 112 return(status); 113 } 114 115
