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_client_socket_connect 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 TCP client socket connect */
50 /* function call. */
51 /* */
52 /* INPUT */
53 /* */
54 /* socket_ptr Pointer to TCP client socket */
55 /* server_ip IP address of server */
56 /* server_port Port number of server */
57 /* wait_option Suspension option */
58 /* */
59 /* OUTPUT */
60 /* */
61 /* status Completion status */
62 /* */
63 /* CALLS */
64 /* */
65 /* _nx_tcp_client_socket_connect Actual client socket connect */
66 /* function */
67 /* */
68 /* CALLED BY */
69 /* */
70 /* Application Code */
71 /* */
72 /* RELEASE HISTORY */
73 /* */
74 /* DATE NAME DESCRIPTION */
75 /* */
76 /* 05-19-2020 Yuxin Zhou Initial Version 6.0 */
77 /* 09-30-2020 Yuxin Zhou Modified comment(s), */
78 /* resulting in version 6.1 */
79 /* */
80 /**************************************************************************/
_nxe_tcp_client_socket_connect(NX_TCP_SOCKET * socket_ptr,ULONG server_ip,UINT server_port,ULONG wait_option)81 UINT _nxe_tcp_client_socket_connect(NX_TCP_SOCKET *socket_ptr, ULONG server_ip, UINT server_port, ULONG wait_option)
82 {
83
84 #ifndef NX_DISABLE_IPV4
85
86 UINT status;
87
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 invalid IP address. */
102 if (!server_ip)
103 {
104 return(NX_IP_ADDRESS_ERROR);
105 }
106
107 /* Check for invalid IP address. */
108 if (((server_ip & NX_IP_CLASS_A_MASK) != NX_IP_CLASS_A_TYPE) &&
109 ((server_ip & NX_IP_CLASS_B_MASK) != NX_IP_CLASS_B_TYPE) &&
110 ((server_ip & NX_IP_CLASS_C_MASK) != NX_IP_CLASS_C_TYPE))
111 {
112 return(NX_IP_ADDRESS_ERROR);
113 }
114
115 /* Check for an invalid port. */
116 if (((ULONG)server_port) > (ULONG)NX_MAX_PORT)
117 {
118 return(NX_INVALID_PORT);
119 }
120
121 /* Check for appropriate caller. */
122 NX_THREADS_ONLY_CALLER_CHECKING
123
124 /* Call actual TCP client socket connect function. */
125 status = _nx_tcp_client_socket_connect(socket_ptr, server_ip, server_port, wait_option);
126
127 /* Return completion status. */
128 return(status);
129 #else /* NX_DISABLE_IPV4 */
130 NX_PARAMETER_NOT_USED(socket_ptr);
131 NX_PARAMETER_NOT_USED(server_ip);
132 NX_PARAMETER_NOT_USED(server_port);
133 NX_PARAMETER_NOT_USED(wait_option);
134
135 return(NX_NOT_SUPPORTED);
136 #endif /* !NX_DISABLE_IPV4 */
137 }
138
139
