- FOREACH macros now require a HashPosition argument
[m6w6/ext-http] / php_http_message_api.h
1 /*
2 +--------------------------------------------------------------------+
3 | PECL :: http |
4 +--------------------------------------------------------------------+
5 | Redistribution and use in source and binary forms, with or without |
6 | modification, are permitted provided that the conditions mentioned |
7 | in the accompanying LICENSE file are met. |
8 +--------------------------------------------------------------------+
9 | Copyright (c) 2004-2005, Michael Wallner <mike@php.net> |
10 +--------------------------------------------------------------------+
11 */
12
13 /* $Id$ */
14
15 #ifndef PHP_HTTP_MESSAGE_API_H
16 #define PHP_HTTP_MESSAGE_API_H
17
18 #include "php_http_info_api.h"
19 #include "phpstr/phpstr.h"
20
21 typedef enum {
22 HTTP_MSG_NONE = 0,
23 HTTP_MSG_REQUEST = IS_HTTP_REQUEST,
24 HTTP_MSG_RESPONSE = IS_HTTP_RESPONSE,
25 } http_message_type;
26
27 typedef struct _http_message http_message;
28
29 struct _http_message {
30 phpstr body;
31 HashTable hdrs;
32 http_message_type type;
33 struct http_info http;
34 http_message *parent;
35 };
36
37 /* required minimum length of an HTTP message "HTTP/1.1" */
38 #define HTTP_MSG_MIN_SIZE 8
39
40 /* shorthand for type checks */
41 #define HTTP_MSG_TYPE(TYPE, msg) ((msg) && ((msg)->type == HTTP_MSG_ ##TYPE))
42
43 #define http_message_new() _http_message_init_ex(NULL, 0)
44 #define http_message_init(m) _http_message_init_ex((m), 0)
45 #define http_message_init_ex(m, t) _http_message_init_ex((m), (t))
46 PHP_HTTP_API http_message *_http_message_init_ex(http_message *m, http_message_type t);
47
48 #define http_message_set_type(m, t) _http_message_set_type((m), (t))
49 PHP_HTTP_API void _http_message_set_type(http_message *m, http_message_type t);
50
51 #define http_message_header(m, h) _http_message_header_ex((m), (h), sizeof(h))
52 #define http_message_header_ex _http_message_header_ex
53 static inline zval *_http_message_header_ex(http_message *msg, char *key_str, size_t key_len)
54 {
55 zval **header;
56 if (SUCCESS == zend_hash_find(&msg->hdrs, key_str, key_len, (void **) &header)) {
57 return *header;
58 }
59 return NULL;
60 }
61
62 #define http_message_parse(m, l) http_message_parse_ex(NULL, (m), (l))
63 #define http_message_parse_ex(h, m, l) _http_message_parse_ex((h), (m), (l) TSRMLS_CC)
64 PHP_HTTP_API http_message *_http_message_parse_ex(http_message *msg, const char *message, size_t length TSRMLS_DC);
65
66 #define http_message_tostring(m, s, l) _http_message_tostring((m), (s), (l))
67 PHP_HTTP_API void _http_message_tostring(http_message *msg, char **string, size_t *length);
68
69 #define http_message_serialize(m, s, l) _http_message_serialize((m), (s), (l))
70 PHP_HTTP_API void _http_message_serialize(http_message *message, char **string, size_t *length);
71
72 #define http_message_tostruct_recursive(m, s) _http_message_tostruct_recursive((m), (s) TSRMLS_CC)
73 PHP_HTTP_API void _http_message_tostruct_recursive(http_message *msg, zval *strct TSRMLS_DC);
74
75 #define http_message_send(m) _http_message_send((m) TSRMLS_CC)
76 PHP_HTTP_API STATUS _http_message_send(http_message *message TSRMLS_DC);
77
78 #define http_message_dup(m) _http_message_dup((m) TSRMLS_CC)
79 PHP_HTTP_API http_message *_http_message_dup(http_message *msg TSRMLS_DC);
80
81 #define http_message_dtor(m) _http_message_dtor((m))
82 PHP_HTTP_API void _http_message_dtor(http_message *message);
83
84 #define http_message_free(m) _http_message_free((m))
85 PHP_HTTP_API void _http_message_free(http_message **message);
86
87 #endif
88
89 /*
90 * Local variables:
91 * tab-width: 4
92 * c-basic-offset: 4
93 * End:
94 * vim600: noet sw=4 ts=4 fdm=marker
95 * vim<600: noet sw=4 ts=4
96 */
97