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 /**************************************************************************/
33 /* */
34 /* FUNCTION RELEASE */
35 /* */
36 /* _nx_tcp_client_socket_port_get PORTABLE C */
37 /* 6.1 */
38 /* AUTHOR */
39 /* */
40 /* Yuxin Zhou, Microsoft Corporation */
41 /* */
42 /* DESCRIPTION */
43 /* */
44 /* This function retrieves the bound port of the specified socket, */
45 /* which is especially useful in situations where NX_ANY_PORT was */
46 /* used to bind. */
47 /* */
48 /* INPUT */
49 /* */
50 /* socket_ptr Pointer to TCP client socket */
51 /* port_ptr Destination for port bound to */
52 /* this socket */
53 /* */
54 /* OUTPUT */
55 /* */
56 /* status Completion status */
57 /* */
58 /* CALLS */
59 /* */
60 /* tx_mutex_get Obtain protection */
61 /* tx_mutex_put Release protection */
62 /* */
63 /* CALLED BY */
64 /* */
65 /* Application Code */
66 /* */
67 /* RELEASE HISTORY */
68 /* */
69 /* DATE NAME DESCRIPTION */
70 /* */
71 /* 05-19-2020 Yuxin Zhou Initial Version 6.0 */
72 /* 09-30-2020 Yuxin Zhou Modified comment(s), */
73 /* resulting in version 6.1 */
74 /* */
75 /**************************************************************************/
_nx_tcp_client_socket_port_get(NX_TCP_SOCKET * socket_ptr,UINT * port_ptr)76 UINT _nx_tcp_client_socket_port_get(NX_TCP_SOCKET *socket_ptr, UINT *port_ptr)
77 {
78
79 NX_IP *ip_ptr;
80
81
82 /* Setup IP pointer. */
83 ip_ptr = socket_ptr -> nx_tcp_socket_ip_ptr;
84
85 /* If trace is enabled, insert this event into the trace buffer. */
86 NX_TRACE_IN_LINE_INSERT(NX_TRACE_TCP_CLIENT_SOCKET_PORT_GET, ip_ptr, socket_ptr, socket_ptr -> nx_tcp_socket_port, 0, NX_TRACE_TCP_EVENTS, 0, 0);
87
88 /* Obtain the IP mutex so we can examine the bound port. */
89 tx_mutex_get(&(ip_ptr -> nx_ip_protection), TX_WAIT_FOREVER);
90
91 /* Determine if the socket has already been bound to port or if a socket bind is
92 already pending from another thread. */
93 if (!socket_ptr -> nx_tcp_socket_bound_next)
94 {
95
96 /* Release protection. */
97 tx_mutex_put(&(ip_ptr -> nx_ip_protection));
98
99 /* Return a not bound error code. */
100 return(NX_NOT_BOUND);
101 }
102
103 /* Return the port number from the socket. */
104 *port_ptr = socket_ptr -> nx_tcp_socket_port;
105
106 /* Release protection. */
107 tx_mutex_put(&(ip_ptr -> nx_ip_protection));
108
109 /* Return successful completion status. */
110 return(NX_SUCCESS);
111 }
112
113
