- implement more of those useful allocation relays
[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
20 typedef enum {
21 HTTP_MSG_NONE = 0,
22 HTTP_MSG_REQUEST = IS_HTTP_REQUEST,
23 HTTP_MSG_RESPONSE = IS_HTTP_RESPONSE,
24 } http_message_type;
25
26 typedef struct _http_message http_message;
27
28 struct _http_message {
29 phpstr body;
30 HashTable hdrs;
31 http_message_type type;
32 struct http_info http;
33 http_message *parent;
34 };
35
36 /* required minimum length of an HTTP message "HTTP/1.1" */
37 #define HTTP_MSG_MIN_SIZE 8
38
39 /* shorthand for type checks */
40 #define HTTP_MSG_TYPE(TYPE, msg) ((msg) && ((msg)->type == HTTP_MSG_ ##TYPE))
41
42 #define http_message_new() http_message_init_ex(NULL, 0)
43 #define http_message_init(m) http_message_init_ex((m), 0)
44 #define http_message_init_ex(m, t) _http_message_init_ex((m), (t) ZEND_FILE_LINE_CC ZEND_FILE_LINE_EMPTY_CC)
45 PHP_HTTP_API http_message *_http_message_init_ex(http_message *m, http_message_type t ZEND_FILE_LINE_DC ZEND_FILE_LINE_ORIG_DC);
46
47 #define http_message_set_type(m, t) _http_message_set_type((m), (t))
48 PHP_HTTP_API void _http_message_set_type(http_message *m, http_message_type t);
49
50 #define http_message_header(m, h) _http_message_header_ex((m), (h), sizeof(h))
51 #define http_message_header_ex _http_message_header_ex
52 static inline zval *_http_message_header_ex(http_message *msg, char *key_str, size_t key_len)
53 {
54 zval **header;
55 if (SUCCESS == zend_hash_find(&msg->hdrs, key_str, key_len, (void **) &header)) {
56 return *header;
57 }
58 return NULL;
59 }
60
61 #define http_message_parse(m, l) http_message_parse_ex(NULL, (m), (l))
62 #define http_message_parse_ex(h, m, l) _http_message_parse_ex((h), (m), (l) ZEND_FILE_LINE_CC ZEND_FILE_LINE_EMPTY_CC TSRMLS_CC)
63 PHP_HTTP_API http_message *_http_message_parse_ex(http_message *msg, const char *message, size_t length ZEND_FILE_LINE_DC ZEND_FILE_LINE_ORIG_DC TSRMLS_DC);
64
65 #define http_message_tostring(m, s, l) _http_message_tostring((m), (s), (l))
66 PHP_HTTP_API void _http_message_tostring(http_message *msg, char **string, size_t *length);
67
68 #define http_message_serialize(m, s, l) _http_message_serialize((m), (s), (l))
69 PHP_HTTP_API void _http_message_serialize(http_message *message, char **string, size_t *length);
70
71 #define http_message_tostruct_recursive(m, s) _http_message_tostruct_recursive((m), (s) TSRMLS_CC)
72 PHP_HTTP_API void _http_message_tostruct_recursive(http_message *msg, zval *strct TSRMLS_DC);
73
74 #define http_message_send(m) _http_message_send((m) TSRMLS_CC)
75 PHP_HTTP_API STATUS _http_message_send(http_message *message TSRMLS_DC);
76
77 #define http_message_dup(m) _http_message_dup((m) TSRMLS_CC)
78 PHP_HTTP_API http_message *_http_message_dup(http_message *msg TSRMLS_DC);
79
80 #define http_message_dtor(m) _http_message_dtor((m))
81 PHP_HTTP_API void _http_message_dtor(http_message *message);
82
83 #define http_message_free(m) _http_message_free((m))
84 PHP_HTTP_API void _http_message_free(http_message **message);
85
86 #endif
87
88 /*
89 * Local variables:
90 * tab-width: 4
91 * c-basic-offset: 4
92 * End:
93 * vim600: noet sw=4 ts=4 fdm=marker
94 * vim<600: noet sw=4 ts=4
95 */
96