blob: c177813060ba7c9a6eba181ea23e9aa48d2c6aab (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
|
/***************************************************************************
* Copyright (c) 2024 Microsoft Corporation
* Copyright (c) 2025-present Eclipse ThreadX Contributors
*
* This program and the accompanying materials are made available under the
* terms of the MIT License which is available at
* https://opensource.org/licenses/MIT.
*
* SPDX-License-Identifier: MIT
**************************************************************************/
/**************************************************************************/
/**************************************************************************/
/** */
/** NetX Component */
/** */
/** Transmission Control Protocol (TCP) */
/** */
/**************************************************************************/
/**************************************************************************/
#define NX_SOURCE_CODE
/* Include necessary system files. */
#include "nx_api.h"
#include "nx_tcp.h"
#ifdef NX_ENABLE_TCP_QUEUE_DEPTH_UPDATE_NOTIFY
/* Bring in externs for caller checking code. */
NX_CALLER_CHECKING_EXTERNS
#endif /* NX_ENABLE_TCP_QUEUE_DEPTH_UPDATE_NOTIFY */
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* _nxe_tcp_socket_queue_depth_notify_set PORTABLE C */
/* 6.4.3 */
/* AUTHOR */
/* */
/* Yuxin Zhou, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This function is the error handling service for the queue depth */
/* notify callback setting function. */
/* */
/* INPUT */
/* */
/* socket_ptr Pointer to TCP socket */
/* tcp_queue_depth_notify Routine to call when NetX */
/* queue depth decreases below */
/* the maximum transmit depth */
/* */
/* OUTPUT */
/* */
/* status Completion status */
/* */
/* CALLS */
/* */
/* _nx_tcp_socket_queue_depth_notify_set Actual callback set function */
/* */
/* CALLED BY */
/* */
/* Application Code */
/* */
/**************************************************************************/
UINT _nxe_tcp_socket_queue_depth_notify_set(NX_TCP_SOCKET *socket_ptr, VOID (*tcp_socket_queue_depth_notify)(NX_TCP_SOCKET *socket_ptr))
{
#ifdef NX_ENABLE_TCP_QUEUE_DEPTH_UPDATE_NOTIFY
UINT status;
/* Check for invalid input pointers. */
if ((socket_ptr == NX_NULL) || (socket_ptr -> nx_tcp_socket_id != NX_TCP_ID))
{
return(NX_PTR_ERROR);
}
/* Check for invalid input pointers. */
if (tcp_socket_queue_depth_notify == NX_NULL)
{
return(NX_PTR_ERROR);
}
/* Check to see if TCP is enabled. */
if (!(socket_ptr -> nx_tcp_socket_ip_ptr) -> nx_ip_tcp_packet_receive)
{
return(NX_NOT_ENABLED);
}
/* Check for appropriate caller. */
NX_THREADS_ONLY_CALLER_CHECKING
/* Setup the receive notify function pointer. */
status = _nx_tcp_socket_queue_depth_notify_set(socket_ptr, tcp_socket_queue_depth_notify);
/* Return successful completion. */
return(status);
#else /* !NX_ENABLE_TCP_QUEUE_DEPTH_UPDATE_NOTIFY */
NX_PARAMETER_NOT_USED(socket_ptr);
NX_PARAMETER_NOT_USED(tcp_socket_queue_depth_notify);
return(NX_NOT_SUPPORTED);
#endif /* NX_ENABLE_TCP_QUEUE_DEPTH_UPDATE_NOTIFY */
}
|