ensure options are applied before the headers are set
[m6w6/ext-http] / php_http_message.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-2014, Michael Wallner <mike@php.net> |
10 +--------------------------------------------------------------------+
11 */
12
13 #ifndef PHP_HTTP_MESSAGE_H
14 #define PHP_HTTP_MESSAGE_H
15
16 #include "php_http_message_body.h"
17
18 /* required minimum length of an HTTP message "HTTP/1.1" */
19 #define PHP_HTTP_MESSAGE_MIN_SIZE 8
20 #define PHP_HTTP_MESSAGE_TYPE(TYPE, msg) ((msg) && ((msg)->type == PHP_HTTP_ ##TYPE))
21
22 typedef php_http_info_type_t php_http_message_type_t;
23 typedef struct php_http_message php_http_message_t;
24
25 struct php_http_message {
26 PHP_HTTP_INFO_IMPL(http, type)
27 HashTable hdrs;
28 php_http_message_body_t *body;
29 php_http_message_t *parent;
30 void *opaque;
31 #ifdef ZTS
32 void ***ts;
33 #endif
34 };
35
36 PHP_HTTP_API zend_bool php_http_message_info_callback(php_http_message_t **message, HashTable **headers, php_http_info_t *info TSRMLS_DC);
37
38 PHP_HTTP_API php_http_message_t *php_http_message_init(php_http_message_t *m, php_http_message_type_t t, php_http_message_body_t *body TSRMLS_DC);
39 PHP_HTTP_API php_http_message_t *php_http_message_init_env(php_http_message_t *m, php_http_message_type_t t TSRMLS_DC);
40 PHP_HTTP_API php_http_message_t *php_http_message_copy(php_http_message_t *from, php_http_message_t *to);
41 PHP_HTTP_API php_http_message_t *php_http_message_copy_ex(php_http_message_t *from, php_http_message_t *to, zend_bool parents);
42 PHP_HTTP_API void php_http_message_dtor(php_http_message_t *message);
43 PHP_HTTP_API void php_http_message_free(php_http_message_t **message);
44
45 PHP_HTTP_API void php_http_message_set_type(php_http_message_t *m, php_http_message_type_t t);
46 PHP_HTTP_API void php_http_message_set_info(php_http_message_t *message, php_http_info_t *info);
47
48 PHP_HTTP_API void php_http_message_update_headers(php_http_message_t *msg);
49
50 PHP_HTTP_API zval *php_http_message_header(php_http_message_t *msg, const char *key_str, size_t key_len, int join);
51 PHP_HTTP_API zend_bool php_http_message_is_multipart(php_http_message_t *msg, char **boundary);
52
53 PHP_HTTP_API void php_http_message_to_string(php_http_message_t *msg, char **string, size_t *length);
54 PHP_HTTP_API void php_http_message_to_struct(php_http_message_t *msg, zval *strct);
55 PHP_HTTP_API void php_http_message_to_callback(php_http_message_t *msg, php_http_pass_callback_t cb, void *cb_arg);
56
57 PHP_HTTP_API void php_http_message_serialize(php_http_message_t *message, char **string, size_t *length);
58 PHP_HTTP_API php_http_message_t *php_http_message_reverse(php_http_message_t *msg);
59 PHP_HTTP_API php_http_message_t *php_http_message_zip(php_http_message_t *one, php_http_message_t *two);
60
61 #define php_http_message_count(c, m) \
62 { \
63 php_http_message_t *__tmp_msg = (m); \
64 for (c = 0; __tmp_msg; __tmp_msg = __tmp_msg->parent, ++(c)); \
65 }
66
67 PHP_HTTP_API php_http_message_t *php_http_message_parse(php_http_message_t *msg, const char *str, size_t len, zend_bool greedy TSRMLS_DC);
68
69 typedef struct php_http_message_object {
70 zend_object zo;
71 zend_object_value zv;
72 php_http_message_t *message;
73 struct php_http_message_object *parent;
74 php_http_message_body_object_t *body;
75 zval *iterator;
76 } php_http_message_object_t;
77
78 PHP_HTTP_API zend_class_entry *php_http_message_class_entry;
79
80 PHP_MINIT_FUNCTION(http_message);
81 PHP_MSHUTDOWN_FUNCTION(http_message);
82
83 void php_http_message_object_prepend(zval *this_ptr, zval *prepend, zend_bool top /* = 1 */ TSRMLS_DC);
84 void php_http_message_object_reverse(zval *this_ptr, zval *return_value TSRMLS_DC);
85 STATUS php_http_message_object_set_body(php_http_message_object_t *obj, zval *zbody TSRMLS_DC);
86 STATUS php_http_message_object_init_body_object(php_http_message_object_t *obj);
87
88 zend_object_value php_http_message_object_new(zend_class_entry *ce TSRMLS_DC);
89 zend_object_value php_http_message_object_new_ex(zend_class_entry *ce, php_http_message_t *msg, php_http_message_object_t **ptr TSRMLS_DC);
90 zend_object_value php_http_message_object_clone(zval *object TSRMLS_DC);
91 void php_http_message_object_free(void *object TSRMLS_DC);
92
93 #endif
94
95 /*
96 * Local variables:
97 * tab-width: 4
98 * c-basic-offset: 4
99 * End:
100 * vim600: noet sw=4 ts=4 fdm=marker
101 * vim<600: noet sw=4 ts=4
102 */
103