http 1.12.11devel
Loading...
Searching...
No Matches
http.h
Go to the documentation of this file.
1/*
2 * This file is part of the Sofia-SIP package
3 *
4 * Copyright (C) 2005 Nokia Corporation.
5 *
6 * Contact: Pekka Pessi <pekka.pessi@nokia-email.address.hidden>
7 *
8 * This library is free software; you can redistribute it and/or
9 * modify it under the terms of the GNU Lesser General Public License
10 * as published by the Free Software Foundation; either version 2.1 of
11 * the License, or (at your option) any later version.
12 *
13 * This library is distributed in the hope that it will be useful, but
14 * WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 * Lesser General Public License for more details.
17 *
18 * You should have received a copy of the GNU Lesser General Public
19 * License along with this library; if not, write to the Free Software
20 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
21 * 02110-1301 USA
22 *
23 */
24
25#ifndef HTTP_H
27#define HTTP_H
28
40#ifndef MSG_H
41#include <sofia-sip/msg.h>
42#endif
43#ifndef URL_H
44#include <sofia-sip/url.h>
45#endif
46#ifndef MSG_MIME_H
47#include <sofia-sip/msg_mime.h>
48#endif
49
50SOFIA_BEGIN_DECLS
51
52/* ----------------------------------------------------------------------
53 * 1) Constants
54 */
55
56#define HTTP_NONE ((http_header_t *)MSG_HEADER_NONE)
57#define HTTP_DEFAULT_PORT (80)
58#define HTTP_DEFAULT_SERV "80"
59
61#define HTTP_PROTOCOL_TAG ((void *)(uintptr_t)0x48545450) /* 'HTTP' */
62
64enum {
65 HTTP_FLG_NO_BODY = (1 << 15)
66};
67
81
82#define HTTP_METHOD(s) http_method_unknown, #s
83#define HTTP_NO_METHOD http_method_unknown, NULL
84#define HTTP_METHOD_GET http_method_get, "GET"
85#define HTTP_METHOD_POST http_method_post, "POST"
86#define HTTP_METHOD_HEAD http_method_head, "HEAD"
87#define HTTP_METHOD_OPTIONS http_method_options, "OPTIONS"
88#define HTTP_METHOD_PUT http_method_put, "PUT"
89#define HTTP_METHOD_DELETE http_method_delete, "DELETE"
90#define HTTP_METHOD_TRACE http_method_trace, "TRACE"
91#define HTTP_METHOD_CONNECT http_method_connect, "CONNECT"
92
93/* ----------------------------------------------------------------------
94 * 2) Type declarations
95 */
96
98typedef struct http_s http_t;
99
102
103typedef struct http_request_s http_request_t;
104typedef struct http_status_s http_status_t;
105typedef msg_accept_t http_accept_t;
106typedef msg_accept_charset_t http_accept_charset_t;
107typedef msg_accept_encoding_t http_accept_encoding_t;
108typedef msg_accept_language_t http_accept_language_t;
110typedef msg_numeric_t http_age_t;
112typedef msg_auth_info_t http_authentication_info_t;
113typedef msg_auth_t http_authorization_t;
116typedef msg_content_encoding_t http_content_encoding_t;
117typedef msg_content_language_t http_content_language_t;
118typedef msg_content_length_t http_content_length_t;
119typedef msg_content_location_t http_content_location_t;
120typedef msg_generic_t http_content_md5_t;
122typedef msg_content_type_t http_content_type_t;
123typedef struct http_date_s http_date_t;
124typedef msg_generic_t http_etag_t;
125typedef msg_generic_t http_expect_t;
127typedef msg_generic_t http_from_t;
128typedef struct http_host_s http_host_t;
132typedef struct http_if_range_s http_if_range_t;
135typedef struct http_location_s http_location_t;
137typedef msg_generic_t http_mime_version_t;
139typedef msg_auth_t http_proxy_authenticate_t;
140typedef msg_auth_t http_proxy_authorization_t;
141typedef struct http_range_s http_range_t;
142typedef struct http_location_s http_referer_t;
144typedef msg_generic_t http_server_t;
145typedef struct http_te_s http_te_t;
149typedef msg_generic_t http_user_agent_t;
150typedef msg_list_t http_vary_t;
151typedef struct http_via_s http_via_t;
152typedef msg_warning_t http_warning_t;
153typedef msg_auth_t http_www_authenticate_t;
154
156
158typedef struct http_cookie_s http_cookie_t;
159
161typedef msg_error_t http_error_t;
163typedef msg_generic_t http_unknown_t;
165typedef msg_separator_t http_separator_t;
167typedef msg_payload_t http_payload_t;
169typedef unsigned long http_time_t;
171typedef unsigned long http_off_t;
172
173
174/* ----------------------------------------------------------------------
175 * 3) Structure definitions
176 */
177
180 msg_common_t rq_common[1];
181 http_error_t *rq_next;
182 http_method_t rq_method;
183 char const *rq_method_name;
185 char const *rq_version;
186};
187
190 msg_common_t st_common[1];
191 http_error_t *st_next;
192 char const *st_version;
193 int st_status;
194 char const *st_phrase;
195};
196
203{
205 msg_error_t *ai_next;
206 msg_param_t const *ai_params;
207};
208
217
220 msg_common_t d_common[1];
221 http_error_t *d_next;
223};
224
227 msg_common_t h_common[1];
228 http_error_t *h_next;
229 char const *h_host;
230 char const *h_port;
231};
232
235 msg_common_t ifr_common[1];
236 http_error_t *ifr_next;
237 char const *ifr_tag;
239};
240
243 msg_common_t loc_common[1];
244 http_error_t *loc_next;
245 url_t loc_url[1];
246};
247
250 msg_common_t mf_common[1];
251 http_error_t *mf_next;
252 unsigned long mf_count;
253};
254
257{
258 msg_common_t rng_common[1];
259 http_error_t *rng_next;
260 char const *rng_unit;
261 char const **rng_specs;
262};
263
271
273struct http_te_s {
276 char const *te_extension;
277 msg_param_t const *te_params;
278 char const *te_q;
279};
280
283 msg_common_t v_common[1];
284 http_via_t *v_next;
285 char const *v_version;
286 char const *v_host;
287 char const *v_port;
288 char const *v_comment;
289};
290
293 msg_common_t c_common[1];
294 http_cookie_t *c_next;
295 msg_param_t const *c_params;
296 char const *c_version;
297 char const *c_name;
298 char const *c_domain;
299 char const *c_path;
300};
301
304 msg_common_t sc_common[1];
305 http_set_cookie_t *sc_next;
306 msg_param_t const *sc_params;
307 char const *sc_name;
308 char const *sc_version;
309 char const *sc_domain;
310 char const *sc_path;
311 char const *sc_comment;
312 char const *sc_max_age;
313 unsigned sc_secure;
314};
315
323struct http_s {
326 void *http_user;
327 unsigned http_size;
334 /* === Headers start here */
335 http_accept_t *http_accept;
336 http_accept_charset_t *http_accept_charset;
337 http_accept_encoding_t *http_accept_encoding;
338 http_accept_language_t *http_accept_language;
341 http_authentication_info_t*http_authentication_info;
342 http_authorization_t *http_authorization;
343 http_age_t *http_age;
347 http_etag_t *http_etag;
348 http_expect_t *http_expect;
350 http_from_t *http_from;
361 http_proxy_authenticate_t *http_proxy_authenticate;
362 http_proxy_authorization_t*http_proxy_authorization;
366 http_server_t *http_server;
371 http_user_agent_t *http_user_agent;
374 http_warning_t *http_warning;
375 http_www_authenticate_t *http_www_authenticate;
381 http_mime_version_t *http_mime_version;
382 http_content_encoding_t *http_content_encoding;
383 http_content_language_t *http_content_language;
384 http_content_length_t *http_content_length;
385 http_content_location_t *http_content_location;
386 http_content_md5_t *http_content_md5;
388 http_content_type_t *http_content_type;
390 /* === Headers end here */
395};
396
404 msg_common_t sh_common[1];
405 struct {
406 msg_common_t shn_common;
407 http_header_t *shn_next;
408 } sh_header_next[1];
409
410 msg_auth_t sh_auth[1];
411 msg_generic_t sh_generic[1];
412 msg_numeric_t sh_numeric[1];
413
414 http_request_t sh_request[1];
415 http_status_t sh_status[1];
416 http_error_t sh_error[1];
417 http_unknown_t sh_unknown[1];
418 http_separator_t sh_separator[1];
419 http_payload_t sh_payload[1];
420
421 /* Proper headers */
422 http_via_t sh_via[1];
423 http_host_t sh_host[1];
424 http_from_t sh_from[1];
425 http_referer_t sh_referer[1];
426 http_connection_t sh_connection[1];
427
428 http_accept_t sh_accept[1];
429 http_accept_charset_t sh_accept_charset[1];
430 http_accept_encoding_t sh_accept_encoding[1];
431 http_accept_language_t sh_accept_language[1];
432 http_accept_ranges_t sh_accept_ranges[1];
433 http_allow_t sh_allow[1];
434 http_te_t sh_te[1];
435
436 http_authentication_info_t sh_authentication_info[1];
437 http_authorization_t sh_authorization[1];
438 http_www_authenticate_t sh_www_authenticate[1];
439 http_proxy_authenticate_t sh_proxy_authenticate[1];
440 http_proxy_authorization_t sh_proxy_authorization[1];
441
442 http_age_t sh_age[1];
443 http_cache_control_t sh_cache_control[1];
444 http_date_t sh_date[1];
445 http_expires_t sh_expires[1];
446 http_if_match_t sh_if_match[1];
447 http_if_modified_since_t sh_if_modified_since[1];
448 http_if_none_match_t sh_if_none_match[1];
449 http_if_range_t sh_if_range[1];
450 http_if_unmodified_since_t sh_if_unmodified_since[1];
451
452 http_etag_t sh_etag[1];
453 http_expect_t sh_expect[1];
454 http_last_modified_t sh_last_modified[1];
455 http_location_t sh_location[1];
456 http_max_forwards_t sh_max_forwards[1];
457 http_pragma_t sh_pragma[1];
458 http_range_t sh_range[1];
459 http_retry_after_t sh_retry_after[1];
460 http_trailer_t sh_trailer[1];
461 http_upgrade_t sh_upgrade[1];
462 http_vary_t sh_vary[1];
463 http_warning_t sh_warning[1];
464
465 http_user_agent_t sh_user_agent[1];
466 http_server_t sh_server[1];
467
468 http_mime_version_t sh_mime_version[1];
469 http_content_language_t sh_content_language[1];
470 http_content_location_t sh_content_location[1];
471 http_content_md5_t sh_content_md5[1];
472 http_content_range_t sh_content_range[1];
473 http_content_encoding_t sh_content_encoding[1];
474 http_transfer_encoding_t sh_transfer_encoding[1];
475 http_content_type_t sh_content_type[1];
476 http_content_length_t sh_content_length[1];
477
478};
479
480SOFIA_END_DECLS
481
482#endif /* !defined(HTTP_H) */
msg_error_t http_error_t
Erroneous header.
Definition http.h:161
http_method_t
IDs for well-known HTTP methods.
Definition http.h:69
@ http_method_trace
TRACE.
Definition http.h:78
@ http_method_unknown
Unknown method, use method_name.
Definition http.h:71
@ http_method_connect
CONNECT.
Definition http.h:79
@ http_method_put
PUT.
Definition http.h:76
@ http_method_post
POST.
Definition http.h:73
@ http_method_delete
DELETE.
Definition http.h:77
@ http_method_invalid
Invalid method name.
Definition http.h:70
@ http_method_options
OPTIONS.
Definition http.h:75
@ http_method_get
GET.
Definition http.h:72
@ http_method_head
HEAD.
Definition http.h:74
msg_generic_t http_unknown_t
Unknown header.
Definition http.h:163
msg_payload_t http_payload_t
Entity-body.
Definition http.h:167
unsigned long http_off_t
Range offset.
Definition http.h:171
msg_separator_t http_separator_t
Separator line between headers and message contents.
Definition http.h:165
unsigned long http_time_t
Time in seconds since 01-Jan-1900.
Definition http.h:169
MSG_PUB_T msg_pub_t
Structure for Authentication-Info header.
Definition http.h:203
msg_common_t ai_common[1]
Common fragment info.
Definition http.h:204
msg_error_t * ai_next
Dummy link to next.
Definition http.h:205
msg_param_t const * ai_params
List of authentication info.
Definition http.h:206
Content-Range.
Definition http.h:210
http_off_t cr_last
Last-byte-pos.
Definition http.h:214
http_off_t cr_first
First-byte-pos.
Definition http.h:213
http_off_t cr_length
Instance-length.
Definition http.h:215
Date, Expires, If-Modified-Since, If-Unmodified-Since, Last-Modified.
Definition http.h:219
http_time_t d_time
Seconds since Jan 1, 1900.
Definition http.h:222
Host.
Definition http.h:226
If-Range.
Definition http.h:234
http_time_t ifr_time
Timestamp.
Definition http.h:238
char const * ifr_tag
Tag.
Definition http.h:237
Location, Referer.
Definition http.h:242
Max-Forwards.
Definition http.h:249
Range.
Definition http.h:257
HTTP request line.
Definition http.h:179
char const * rq_method_name
Method enum.
Definition http.h:183
char const * rq_version
URL.
Definition http.h:185
url_t rq_url[1]
Method name.
Definition http.h:184
Retry-After.
Definition http.h:265
http_time_t ra_date
When to retry.
Definition http.h:268
msg_common_t ra_common[1]
Common fragment info.
Definition http.h:266
http_error_t * ra_next
Link to next (dummy)
Definition http.h:267
http_time_t ra_delta
Seconds to before retry.
Definition http.h:269
HTTP message object.
Definition http.h:323
http_allow_t * http_allow
Allow.
Definition http.h:340
msg_common_t http_common[1]
For recursive inclusion.
Definition http.h:324
http_content_length_t * http_content_length
Content-Length.
Definition http.h:384
http_content_location_t * http_content_location
Content-Location.
Definition http.h:385
http_content_md5_t * http_content_md5
Content-MD5.
Definition http.h:386
http_referer_t * http_referer
Referer.
Definition http.h:364
http_accept_ranges_t * http_accept_ranges
Accept-Ranges.
Definition http.h:339
http_if_unmodified_since_t * http_if_unmodified_since
If-Unmodified-Since.
Definition http.h:356
http_proxy_connection_t * http_proxy_connection
Proxy-Connection.
Definition http.h:377
http_pragma_t * http_pragma
Pragma.
Definition http.h:360
http_mime_version_t * http_mime_version
MIME-Version.
Definition http.h:381
unsigned http_size
Size of this structure.
Definition http.h:327
http_status_t * http_status
Status line.
Definition http.h:332
http_error_t * http_error
Erroneous headers.
Definition http.h:329
http_upgrade_t * http_upgrade
Upgrade.
Definition http.h:370
http_server_t * http_server
Server.
Definition http.h:366
http_proxy_authenticate_t * http_proxy_authenticate
Proxy-Authenticate.
Definition http.h:361
http_set_cookie_t * http_set_cookie
Set-Cookie.
Definition http.h:378
http_accept_charset_t * http_accept_charset
Accept-Charset.
Definition http.h:336
int http_flags
Flags.
Definition http.h:328
http_content_range_t * http_content_range
Content-Range.
Definition http.h:387
http_accept_language_t * http_accept_language
Accept-Language.
Definition http.h:338
http_header_t * http_unknown
Unknown headers.
Definition http.h:391
http_content_encoding_t * http_content_encoding
Content-Encoding.
Definition http.h:382
http_host_t * http_host
Host.
Definition http.h:351
http_cookie_t * http_cookie
Cookie.
Definition http.h:379
http_retry_after_t * http_retry_after
Retry-After.
Definition http.h:365
http_user_agent_t * http_user_agent
User-Agent.
Definition http.h:371
http_accept_t * http_accept
Accept.
Definition http.h:335
http_payload_t * http_payload
Message entity-body.
Definition http.h:394
http_etag_t * http_etag
ETag.
Definition http.h:347
http_cache_control_t * http_cache_control
Cache-Control.
Definition http.h:344
http_authentication_info_t * http_authentication_info
Authentication-Info.
Definition http.h:341
http_warning_t * http_warning
Warning.
Definition http.h:374
http_range_t * http_range
Range.
Definition http.h:363
http_max_forwards_t * http_max_forwards
Max-Forwards.
Definition http.h:359
http_via_t * http_via
Via.
Definition http.h:373
http_content_language_t * http_content_language
Content-Language.
Definition http.h:383
http_expires_t * http_expires
Expires.
Definition http.h:349
http_proxy_authorization_t * http_proxy_authorization
Proxy-Authorization.
Definition http.h:362
http_vary_t * http_vary
Vary.
Definition http.h:372
http_authorization_t * http_authorization
Authorization.
Definition http.h:342
http_accept_encoding_t * http_accept_encoding
Accept-Encoding.
Definition http.h:337
http_request_t * http_request
Request line
Definition http.h:331
http_expect_t * http_expect
Expect.
Definition http.h:348
http_last_modified_t * http_last_modified
Last-Modified.
Definition http.h:357
http_te_t * http_te
TE.
Definition http.h:367
http_if_match_t * http_if_match
If-Match.
Definition http.h:352
http_age_t * http_age
Age.
Definition http.h:343
http_if_none_match_t * http_if_none_match
If-None-Match.
Definition http.h:354
http_if_range_t * http_if_range
If-Range.
Definition http.h:355
void * http_user
Application data.
Definition http.h:326
http_separator_t * http_separator
Separator between message and payload.
Definition http.h:392
http_content_type_t * http_content_type
Content-Type.
Definition http.h:388
msg_pub_t * http_next
Dummy pointer to next part.
Definition http.h:325
http_from_t * http_from
From.
Definition http.h:350
http_transfer_encoding_t * http_transfer_encoding
Transfer-Encoding.
Definition http.h:369
http_date_t * http_date
Date.
Definition http.h:346
http_trailer_t * http_trailer
Trailer.
Definition http.h:368
http_location_t * http_location
Location.
Definition http.h:358
http_connection_t * http_connection
Connection.
Definition http.h:345
http_if_modified_since_t * http_if_modified_since
If-Modified-Since.
Definition http.h:353
http_www_authenticate_t * http_www_authenticate
WWW-Authenticate.
Definition http.h:375
HTTP status line.
Definition http.h:189
TE.
Definition http.h:273
msg_param_t const * te_params
List of parameters.
Definition http.h:277
http_te_t * te_next
Link to next t-coding.
Definition http.h:275
char const * te_extension
Transfer-Extension.
Definition http.h:276
msg_common_t te_common[1]
Common fragment info.
Definition http.h:274
char const * te_q
Q-value.
Definition http.h:278
Via.
Definition http.h:282
Union representing any HTTP header.
Definition http.h:403

Sofia-SIP 1.12.11devel - Copyright (C) 2006 Nokia Corporation. All rights reserved. Licensed under the terms of the GNU Lesser General Public License.