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
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
|
/***************************************************************************
* 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 Duo Component */
/** */
/** Hypertext Transfer Protocol (HTTP) */
/** */
/**************************************************************************/
/**************************************************************************/
/**************************************************************************/
/* */
/* APPLICATION INTERFACE DEFINITION RELEASE */
/* */
/* nxd_http_client.h PORTABLE C */
/* 6.4.3 */
/* AUTHOR */
/* */
/* Yuxin Zhou, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This file defines the NetX Hypertext Transfer Protocol (HTTP) */
/* component, including all data types and external references. */
/* It is assumed that nx_api.h and nx_port.h have already been */
/* included, along with fx_api.h and fx_port.h. */
/* */
/**************************************************************************/
#ifndef NXD_HTTP_CLIENT_H
#define NXD_HTTP_CLIENT_H
/* Determine if a C++ compiler is being used. If so, ensure that standard
C is used to process the API information. */
#ifdef __cplusplus
/* Yes, C++ compiler is present. Use standard C. */
extern "C" {
#endif
#include "nx_api.h"
/* Define the HTTP ID. */
#define NXD_HTTP_CLIENT_ID 0x48545450UL
/* Define HTTP TCP socket create options. */
#ifndef NX_HTTP_TYPE_OF_SERVICE
#define NX_HTTP_TYPE_OF_SERVICE NX_IP_NORMAL
#endif
#ifndef NX_HTTP_FRAGMENT_OPTION
#define NX_HTTP_FRAGMENT_OPTION NX_DONT_FRAGMENT
#endif
#ifndef NX_HTTP_TIME_TO_LIVE
#define NX_HTTP_TIME_TO_LIVE 0x80
#endif
#ifndef NX_HTTP_MAX_RESOURCE
#define NX_HTTP_MAX_RESOURCE 40
#endif
#ifndef NX_HTTP_MAX_NAME
#define NX_HTTP_MAX_NAME 20
#endif
#ifndef NX_HTTP_MAX_PASSWORD
#define NX_HTTP_MAX_PASSWORD 20
#endif
#ifndef NX_HTTP_CLIENT_TIMEOUT
#define NX_HTTP_CLIENT_TIMEOUT (10 * NX_IP_PERIODIC_RATE)
#endif
#ifndef NX_PHYSICAL_TRAILER
#define NX_PHYSICAL_TRAILER 4
#endif
#ifndef NX_HTTP_CLIENT_MIN_PACKET_SIZE
#define NX_HTTP_CLIENT_MIN_PACKET_SIZE 600
#endif
/* NX_HTTP_MAX_STRING is base64 of "name:password" and plus 1 if an extra conversion is needed and plus 2 pad if needed. */
#define NX_HTTP_MAX_STRING ((NX_HTTP_MAX_NAME + NX_HTTP_MAX_PASSWORD + 1) * 4 / 3 + 1 + 2)
#define NX_HTTP_MAX_BINARY_MD5 16
#define NX_HTTP_MAX_ASCII_MD5 32
/* Define HTTP Client states. */
#define NX_HTTP_CLIENT_STATE_READY 1
#define NX_HTTP_CLIENT_STATE_GET 2
#define NX_HTTP_CLIENT_STATE_PUT 3
/* Define return code constants. */
#define NX_HTTP_ERROR 0xE0 /* HTTP internal error */
#define NX_HTTP_TIMEOUT 0xE1 /* HTTP timeout occurred */
#define NX_HTTP_FAILED 0xE2 /* HTTP error */
#define NX_HTTP_DONT_AUTHENTICATE 0xE3 /* HTTP authentication not needed */
#define NX_HTTP_BASIC_AUTHENTICATE 0xE4 /* HTTP basic authentication requested */
#define NX_HTTP_DIGEST_AUTHENTICATE 0xE5 /* HTTP digest authentication requested */
#define NX_HTTP_NOT_FOUND 0xE6 /* HTTP request not found */
#define NX_HTTP_DATA_END 0xE7 /* HTTP end of content area */
#define NX_HTTP_CALLBACK_COMPLETED 0xE8 /* HTTP user callback completed the processing */
#define NX_HTTP_POOL_ERROR 0xE9 /* HTTP supplied pool payload is too small */
#define NX_HTTP_NOT_READY 0xEA /* HTTP client not ready for operation */
#define NX_HTTP_AUTHENTICATION_ERROR 0xEB /* HTTP client authentication failed */
#define NX_HTTP_GET_DONE 0xEC /* HTTP client get is complete */
#define NX_HTTP_BAD_PACKET_LENGTH 0xED /* Invalid packet received - length incorrect */
#define NX_HTTP_REQUEST_UNSUCCESSFUL_CODE 0xEE /* Received an error code instead of 2xx from server */
#define NX_HTTP_INCOMPLETE_PUT_ERROR 0xEF /* Server responds before PUT is complete */
#define NX_HTTP_PASSWORD_TOO_LONG 0xF0 /* Password exceeded expected length */
#define NX_HTTP_USERNAME_TOO_LONG 0xF1 /* Username exceeded expected length */
#define NX_HTTP_NO_QUERY_PARSED 0xF2 /* Server unable to find query in client request */
/* Define the default HTTP Server TCP port number. To change this at runtime
see nx_http_client_set_connect_port(). */
#define NX_HTTP_SERVER_PORT 80
#ifdef NX_HTTP_DIGEST_ENABLE
/* Include the MD5 digest header file. */
#include "nx_md5.h"
#endif
/* Define the HTTP Client data structure. */
typedef struct NX_HTTP_CLIENT_STRUCT
{
ULONG nx_http_client_id; /* HTTP Server ID */
CHAR *nx_http_client_name; /* Name of this HTTP Client */
UINT nx_http_client_state; /* Current state of HTTP Client */
UINT nx_http_client_connect_port; /* Client port to connect to the server */
NX_IP *nx_http_client_ip_ptr; /* Pointer to associated IP structure */
NX_PACKET_POOL *nx_http_client_packet_pool_ptr; /* Pointer to HTTP Client packet pool */
ULONG nx_http_client_total_transfer_bytes; /* Total number of bytes to transfer */
ULONG nx_http_client_actual_bytes_transferred; /* Number of bytes actually transferred */
NX_PACKET *nx_http_client_first_packet; /* Pointer to first packet with data */
NX_TCP_SOCKET nx_http_client_socket; /* HTTP Client TCP socket */
#ifdef NX_HTTP_DIGEST_ENABLE
NX_MD5 nx_http_client_md5data; /* HTTP Client MD5 work area */
#endif
} NX_HTTP_CLIENT;
#ifndef NX_HTTP_SOURCE_CODE
/* Application caller is present, perform API mapping. */
/* Determine if error checking is desired. If so, map API functions
to the appropriate error checking front-ends. Otherwise, map API
functions to the core functions that actually perform the work.
Note: error checking is enabled by default. */
#ifdef NX_DISABLE_ERROR_CHECKING
/* Services without error checking. */
#define nx_http_client_create _nx_http_client_create
#define nx_http_client_delete _nx_http_client_delete
#define nx_http_client_get_start _nx_http_client_get_start
#define nx_http_client_get_start_extended _nx_http_client_get_start_extended
#define nx_http_client_get_packet _nx_http_client_get_packet
#define nx_http_client_put_start _nx_http_client_put_start
#define nx_http_client_put_start_extended _nx_http_client_put_start_extended
#define nx_http_client_put_packet _nx_http_client_put_packet
#define nx_http_client_set_connect_port _nx_http_client_set_connect_port
#define nxd_http_client_get_start _nxd_http_client_get_start
#define nxd_http_client_get_start_extended _nxd_http_client_get_start_extended
#define nxd_http_client_put_start _nxd_http_client_put_start
#define nxd_http_client_put_start_extended _nxd_http_client_put_start_extended
#else
/* Services with error checking. */
#define nx_http_client_create(p,n,i,pp,w) _nxe_http_client_create(p,n,i,pp,w, sizeof(NX_HTTP_CLIENT))
#define nx_http_client_delete _nxe_http_client_delete
#define nx_http_client_get_start _nxe_http_client_get_start
#define nx_http_client_get_start_extended _nxe_http_client_get_start_extended
#define nx_http_client_get_packet _nxe_http_client_get_packet
#define nx_http_client_put_start _nxe_http_client_put_start
#define nx_http_client_put_start_extended _nxe_http_client_put_start_extended
#define nx_http_client_put_packet _nxe_http_client_put_packet
#define nx_http_client_set_connect_port _nxe_http_client_set_connect_port
#define nxd_http_client_put_start _nxde_http_client_put_start
#define nxd_http_client_put_start_extended _nxde_http_client_put_start_extended
#define nxd_http_client_get_start _nxde_http_client_get_start
#define nxd_http_client_get_start_extended _nxde_http_client_get_start_extended
#endif /* NX_DISABLE_ERROR_CHECKING */
/* Define the prototypes accessible to the application software. */
#ifdef NX_DISABLE_ERROR_CHECKING
UINT _nx_http_client_create(NX_HTTP_CLIENT *client_ptr, CHAR *client_name, NX_IP *ip_ptr, NX_PACKET_POOL *pool_ptr, ULONG window_size);
#else
UINT _nxe_http_client_create(NX_HTTP_CLIENT *client_ptr, CHAR *client_name, NX_IP *ip_ptr, NX_PACKET_POOL *pool_ptr, ULONG window_size, UINT http_client_size);
#endif /* NX_DISABLE_ERROR_CHECKING */
UINT nx_http_client_delete(NX_HTTP_CLIENT *client_ptr);
UINT nx_http_client_get_start(NX_HTTP_CLIENT *client_ptr, ULONG ip_address, CHAR *resource, CHAR *input_ptr, UINT input_size, CHAR *username, CHAR *password, ULONG wait_option);
UINT nx_http_client_get_start_extended(NX_HTTP_CLIENT *client_ptr, ULONG ip_address, CHAR *resource, UINT resource_length, CHAR *input_ptr, UINT input_size, CHAR *username, UINT username_length, CHAR *password, UINT password_length, ULONG wait_option);
UINT nx_http_client_get_packet(NX_HTTP_CLIENT *client_ptr, NX_PACKET **packet_ptr, ULONG wait_option);
UINT nx_http_client_put_start(NX_HTTP_CLIENT *client_ptr, ULONG ip_address, CHAR *resource, CHAR *username, CHAR *password, ULONG total_bytes, ULONG wait_option);
UINT nx_http_client_put_start_extended(NX_HTTP_CLIENT *client_ptr, ULONG ip_address, CHAR *resource, UINT resource_length, CHAR *username, UINT username_length, CHAR *password, UINT password_length, ULONG total_bytes, ULONG wait_option);
UINT nx_http_client_put_packet(NX_HTTP_CLIENT *client_ptr, NX_PACKET *packet_ptr, ULONG wait_option);
UINT nx_http_client_set_connect_port(NX_HTTP_CLIENT *client_ptr, UINT port);
UINT nxd_http_client_get_start(NX_HTTP_CLIENT *client_ptr, NXD_ADDRESS *ip_address, CHAR *resource, CHAR *input_ptr, UINT input_size, CHAR *username, CHAR *password, ULONG wait_option);
UINT nxd_http_client_get_start_extended(NX_HTTP_CLIENT *client_ptr, NXD_ADDRESS *ip_address, CHAR *resource, UINT resource_length, CHAR *input_ptr, UINT input_size, CHAR *username, UINT username_length, CHAR *password, UINT password_length, ULONG wait_option);
UINT nxd_http_client_put_start(NX_HTTP_CLIENT *client_ptr, NXD_ADDRESS *ip_address, CHAR *resource, CHAR *username, CHAR *password, ULONG total_bytes, ULONG wait_option);
UINT nxd_http_client_put_start_extended(NX_HTTP_CLIENT *client_ptr, NXD_ADDRESS *ip_address, CHAR *resource, UINT resource_length, CHAR *username, UINT username_length, CHAR *password, UINT password_length, ULONG total_bytes, ULONG wait_option);
#else
/* HTTP source code is being compiled, do not perform any API mapping. */
UINT _nxe_http_client_create(NX_HTTP_CLIENT *client_ptr, CHAR *client_name, NX_IP *ip_ptr, NX_PACKET_POOL *pool_ptr, ULONG window_size, UINT http_client_size);
UINT _nx_http_client_create(NX_HTTP_CLIENT *client_ptr, CHAR *client_name, NX_IP *ip_ptr, NX_PACKET_POOL *pool_ptr, ULONG window_size);
UINT _nxe_http_client_delete(NX_HTTP_CLIENT *client_ptr);
UINT _nx_http_client_delete(NX_HTTP_CLIENT *client_ptr);
UINT _nxe_http_client_get_start(NX_HTTP_CLIENT *client_ptr, ULONG ip_address, CHAR *resource, CHAR *input_ptr, UINT input_size, CHAR *username, CHAR *password, ULONG wait_option);
UINT _nx_http_client_get_start(NX_HTTP_CLIENT *client_ptr, ULONG ip_address, CHAR *resource, CHAR *input_ptr, UINT input_size, CHAR *username, CHAR *password, ULONG wait_option);
UINT _nxe_http_client_get_start_extended(NX_HTTP_CLIENT *client_ptr, ULONG ip_address, CHAR *resource, UINT resource_length, CHAR *input_ptr, UINT input_size, CHAR *username, UINT username_length, CHAR *password, UINT password_length, ULONG wait_option);
UINT _nx_http_client_get_start_extended(NX_HTTP_CLIENT *client_ptr, ULONG ip_address, CHAR *resource, UINT resource_length, CHAR *input_ptr, UINT input_size, CHAR *username, UINT username_length, CHAR *password, UINT password_length, ULONG wait_option);
UINT _nxe_http_client_get_packet(NX_HTTP_CLIENT *client_ptr, NX_PACKET **packet_ptr, ULONG wait_option);
UINT _nx_http_client_get_packet(NX_HTTP_CLIENT *client_ptr, NX_PACKET **packet_ptr, ULONG wait_option);
UINT _nxe_http_client_put_start(NX_HTTP_CLIENT *client_ptr, ULONG ip_address, CHAR *resource, CHAR *username, CHAR *password, ULONG total_bytes, ULONG wait_option);
UINT _nx_http_client_put_start(NX_HTTP_CLIENT *client_ptr, ULONG ip_address, CHAR *resource, CHAR *username, CHAR *password, ULONG total_bytes, ULONG wait_option);
UINT _nxe_http_client_put_start_extended(NX_HTTP_CLIENT *client_ptr, ULONG ip_address, CHAR *resource, UINT resource_length, CHAR *username, UINT username_length, CHAR *password, UINT password_length, ULONG total_bytes, ULONG wait_option);
UINT _nx_http_client_put_start_extended(NX_HTTP_CLIENT *client_ptr, ULONG ip_address, CHAR *resource, UINT resource_length, CHAR *username, UINT username_length, CHAR *password, UINT password_length, ULONG total_bytes, ULONG wait_option);
UINT _nxe_http_client_put_packet(NX_HTTP_CLIENT *client_ptr, NX_PACKET *packet_ptr, ULONG wait_option);
UINT _nx_http_client_put_packet(NX_HTTP_CLIENT *client_ptr, NX_PACKET *packet_ptr, ULONG wait_option);
UINT _nxe_http_client_set_connect_port(NX_HTTP_CLIENT *client_ptr, UINT port);
UINT _nx_http_client_set_connect_port(NX_HTTP_CLIENT *client_ptr, UINT port);
UINT _nxde_http_client_get_start(NX_HTTP_CLIENT *client_ptr, NXD_ADDRESS *ip_address, CHAR *resource, CHAR *input_ptr, UINT input_size, CHAR *username, CHAR *password, ULONG wait_option);
UINT _nxd_http_client_get_start(NX_HTTP_CLIENT *client_ptr, NXD_ADDRESS *ip_address, CHAR *resource, CHAR *input_ptr, UINT input_size, CHAR *username, CHAR *password, ULONG wait_option);
UINT _nxde_http_client_get_start_extended(NX_HTTP_CLIENT *client_ptr, NXD_ADDRESS *ip_address, CHAR *resource, UINT resource_length, CHAR *input_ptr, UINT input_size, CHAR *username, UINT username_length, CHAR *password, UINT password_length, ULONG wait_option);
UINT _nxd_http_client_get_start_extended(NX_HTTP_CLIENT *client_ptr, NXD_ADDRESS *ip_address, CHAR *resource, UINT resource_length, CHAR *input_ptr, UINT input_size, CHAR *username, UINT username_length, CHAR *password, UINT password_length, ULONG wait_option);
UINT _nxde_http_client_put_start(NX_HTTP_CLIENT *client_ptr, NXD_ADDRESS *ip_address, CHAR *resource, CHAR *username, CHAR *password, ULONG total_bytes, ULONG wait_option);
UINT _nxd_http_client_put_start(NX_HTTP_CLIENT *client_ptr, NXD_ADDRESS *ip_address, CHAR *resource, CHAR *username, CHAR *password, ULONG total_bytes, ULONG wait_option);
UINT _nxde_http_client_put_start_extended(NX_HTTP_CLIENT *client_ptr, NXD_ADDRESS *ip_address, CHAR *resource, UINT resource_length, CHAR *username, UINT username_length, CHAR *password, UINT password_length, ULONG total_bytes, ULONG wait_option);
UINT _nxd_http_client_put_start_extended(NX_HTTP_CLIENT *client_ptr, NXD_ADDRESS *ip_address, CHAR *resource, UINT resource_length, CHAR *username, UINT username_length, CHAR *password, UINT password_length, ULONG total_bytes, ULONG wait_option);
/* Define internal HTTP functions. */
UINT _nx_http_client_type_get(CHAR *name, CHAR *http_type_string);
UINT _nx_http_client_content_length_get(NX_PACKET *packet_ptr);
UINT _nx_http_client_calculate_content_offset(NX_PACKET *packet_ptr);
UINT _nx_http_client_number_convert(UINT number, CHAR *string);
#endif /* NX_HTTP_SOURCE_CODE */
/* Determine if a C++ compiler is being used. If so, complete the standard
C conditional started above. */
#ifdef __cplusplus
}
#endif
#endif /* NXD_HTTP_CLIENT_H */
|
