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 /*    _nxe_tcp_socket_window_update_notify_set            PORTABLE C      */
39 /*                                                           6.1          */
40 /*  AUTHOR                                                                */
41 /*                                                                        */
42 /*    Yuxin Zhou, Microsoft Corporation                                   */
43 /*                                                                        */
44 /*  DESCRIPTION                                                           */
45 /*                                                                        */
46 /*    This function checks for errors in the TCP socket window update     */
47 /*    notify set call.                                                    */
48 /*                                                                        */
49 /*  INPUT                                                                 */
50 /*                                                                        */
51 /*    socket_ptr                            Pointer to TCP socket         */
52 /*    tcp_window_udpate_notify              Routine to call when NetX     */
53 /*                                            receives a window update    */
54 /*                                                                        */
55 /*  OUTPUT                                                                */
56 /*                                                                        */
57 /*    status                                Completion status             */
58 /*                                                                        */
59 /*  CALLS                                                                 */
60 /*                                                                        */
61 /*    _nx_tcp_socket_window_update_notify_set                             */
62 /*                                          Acutal notify set routine.    */
63 /*                                                                        */
64 /*  CALLED BY                                                             */
65 /*                                                                        */
66 /*    Application Code                                                    */
67 /*                                                                        */
68 /*  RELEASE HISTORY                                                       */
69 /*                                                                        */
70 /*    DATE              NAME                      DESCRIPTION             */
71 /*                                                                        */
72 /*  05-19-2020     Yuxin Zhou               Initial Version 6.0           */
73 /*  09-30-2020     Yuxin Zhou               Modified comment(s),          */
74 /*                                            resulting in version 6.1    */
75 /*                                                                        */
76 /**************************************************************************/
_nxe_tcp_socket_window_update_notify_set(NX_TCP_SOCKET * socket_ptr,VOID (* tcp_socket_window_update_notify)(NX_TCP_SOCKET * socket_ptr))77 UINT  _nxe_tcp_socket_window_update_notify_set(NX_TCP_SOCKET *socket_ptr,
78                                                VOID (*tcp_socket_window_update_notify)(NX_TCP_SOCKET *socket_ptr))
79 {
80 
81     /* Check for invalid input pointers.  */
82     if ((socket_ptr == NX_NULL) || (socket_ptr -> nx_tcp_socket_id != NX_TCP_ID))
83     {
84         return(NX_PTR_ERROR);
85     }
86 
87     /* Check for invalid input pointers.  */
88     if (tcp_socket_window_update_notify == NX_NULL)
89     {
90         return(NX_PTR_ERROR);
91     }
92 
93     /* Check to see if TCP is enabled.  */
94     if (!(socket_ptr -> nx_tcp_socket_ip_ptr) -> nx_ip_tcp_packet_receive)
95     {
96         return(NX_NOT_ENABLED);
97     }
98 
99     /* Check for appropriate caller.  */
100     NX_INIT_AND_THREADS_CALLER_CHECKING
101 
102     return(_nx_tcp_socket_window_update_notify_set(socket_ptr, tcp_socket_window_update_notify));
103 }
104 
105