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
31 /**************************************************************************/
32 /* */
33 /* FUNCTION RELEASE */
34 /* */
35 /* _nx_tcp_socket_window_update_notify_set PORTABLE C */
36 /* 6.1 */
37 /* AUTHOR */
38 /* */
39 /* Yuxin Zhou, Microsoft Corporation */
40 /* */
41 /* DESCRIPTION */
42 /* */
43 /* This function sets the window update notify function pointer to the */
44 /* function specified by the application, which is called whenever */
45 /* the specified socket receives a packet indicating an increase in */
46 /* window size of the remote host. */
47 /* */
48 /* If a NULL pointer is supplied, the window update notify function is */
49 /* disabled. */
50 /* */
51 /* INPUT */
52 /* */
53 /* socket_ptr Pointer to TCP socket */
54 /* tcp_window_udpate_notify Routine to call when NetX */
55 /* receives a window update */
56 /* */
57 /* OUTPUT */
58 /* */
59 /* status Completion status */
60 /* */
61 /* CALLS */
62 /* */
63 /* None */
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 /**************************************************************************/
_nx_tcp_socket_window_update_notify_set(NX_TCP_SOCKET * socket_ptr,VOID (* tcp_socket_window_update_notify)(NX_TCP_SOCKET * socket_ptr))78 UINT _nx_tcp_socket_window_update_notify_set(NX_TCP_SOCKET *socket_ptr,
79 VOID (*tcp_socket_window_update_notify)(NX_TCP_SOCKET *socket_ptr))
80 {
81 TX_INTERRUPT_SAVE_AREA
82
83 /* If trace is enabled, insert this event into the trace buffer. */
84 NX_TRACE_IN_LINE_INSERT(NX_TRACE_TCP_SOCKET_WINDOW_UPDATE_NOTIFY_SET, socket_ptr, 0, 0, 0, NX_TRACE_TCP_EVENTS, 0, 0);
85
86 /* Get mutex protection. */
87 tx_mutex_get(&(socket_ptr -> nx_tcp_socket_ip_ptr -> nx_ip_protection), TX_WAIT_FOREVER);
88
89 /* Disable interrupts. */
90 TX_DISABLE
91
92 /* Setup the receive notify function pointer. */
93 socket_ptr -> nx_tcp_socket_window_update_notify = tcp_socket_window_update_notify;
94
95 /* Restore interrupts. */
96 TX_RESTORE
97
98 /* Release protection. */
99 tx_mutex_put(&(socket_ptr -> nx_tcp_socket_ip_ptr -> nx_ip_protection));
100
101 /* Return successful completion. */
102 return(NX_SUCCESS);
103 }
104
105
