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