- add flush() to HttpDeflateStream and HttpInflateStream
[m6w6/ext-http] / php_http_encoding_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_ENCODING_API_H
16 #define PHP_HTTP_ENCODING_API_H
17
18 #define http_encoding_dechunk(e, el, d, dl) _http_encoding_dechunk((e), (el), (d), (dl) TSRMLS_CC)
19 PHP_HTTP_API const char *_http_encoding_dechunk(const char *encoded, size_t encoded_len, char **decoded, size_t *decoded_len TSRMLS_DC);
20
21 #define http_encoding_response_start(cl) _http_encoding_response_start((cl) TSRMLS_CC)
22 PHP_HTTP_API int _http_encoding_response_start(size_t content_length TSRMLS_DC);
23
24 #ifdef HTTP_HAVE_ZLIB
25
26 extern PHP_MINIT_FUNCTION(http_encoding);
27 extern PHP_RINIT_FUNCTION(http_encoding);
28 extern PHP_RSHUTDOWN_FUNCTION(http_encoding);
29
30 /* 100% compression should be fairly good */
31 #define HTTP_ENCODING_MAXTRY 100
32 /* safe padding */
33 #define HTTP_ENCODING_SAFPAD 28
34 /* add 1% extra space in case we need to encode widely differing (binary) data */
35 #define HTTP_ENCODING_BUFLEN(l) (l + (l / 100) + HTTP_ENCODING_SAFPAD)
36
37 typedef enum {
38 HTTP_ENCODING_NONE,
39 HTTP_ENCODING_GZIP,
40 HTTP_ENCODING_DEFLATE,
41 } http_encoding_type;
42
43 #define HTTP_DEFLATE_LEVEL_DEF 0x00000000
44 #define HTTP_DEFLATE_LEVEL_MIN 0x00000001
45 #define HTTP_DEFLATE_LEVEL_MAX 0x00000002
46 #define HTTP_DEFLATE_TYPE_ZLIB 0x00000000
47 #define HTTP_DEFLATE_TYPE_GZIP 0x00000010
48 #define HTTP_DEFLATE_TYPE_RAW 0x00000020
49 #define HTTP_DEFLATE_STRATEGY_DEF 0x00000000
50 #define HTTP_DEFLATE_STRATEGY_FILT 0x00000100
51 #define HTTP_DEFLATE_STRATEGY_HUFF 0x00000200
52 #define HTTP_DEFLATE_STRATEGY_RLE 0x00000300
53 #define HTTP_DEFLATE_STRATEGY_FIXED 0x00000400
54
55 #define HTTP_INFLATE_TYPE_ZLIB 0x00000000
56 #define HTTP_INFLATE_TYPE_GZIP 0x00000000
57 #define HTTP_INFLATE_TYPE_RAW 0x00000001
58
59 #define HTTP_ENCODING_STREAM_PERSISTENT 0x01000000
60
61 typedef struct {
62 z_stream stream;
63 int flags;
64 void *storage;
65 } http_encoding_stream;
66
67 #define http_encoding_deflate(f, d, dl, r, rl) _http_encoding_deflate((f), (d), (dl), (r), (rl) ZEND_FILE_LINE_CC ZEND_FILE_LINE_EMPTY_CC TSRMLS_CC)
68 PHP_HTTP_API STATUS _http_encoding_deflate(int flags, const char *data, size_t data_len, char **encoded, size_t *encoded_len ZEND_FILE_LINE_DC ZEND_FILE_LINE_ORIG_DC TSRMLS_DC);
69 #define http_encoding_inflate(d, dl, r, rl) _http_encoding_inflate((d), (dl), (r), (rl) ZEND_FILE_LINE_CC ZEND_FILE_LINE_EMPTY_CC TSRMLS_CC)
70 PHP_HTTP_API STATUS _http_encoding_inflate(const char *data, size_t data_len, char **decoded, size_t *decoded_len ZEND_FILE_LINE_DC ZEND_FILE_LINE_ORIG_DC TSRMLS_DC);
71
72 #define http_encoding_deflate_stream_init(s, f) _http_encoding_deflate_stream_init((s), (f) ZEND_FILE_LINE_CC ZEND_FILE_LINE_EMPTY_CC TSRMLS_CC)
73 PHP_HTTP_API http_encoding_stream *_http_encoding_deflate_stream_init(http_encoding_stream *s, int flags ZEND_FILE_LINE_DC ZEND_FILE_LINE_ORIG_DC TSRMLS_DC);
74 #define http_encoding_deflate_stream_update(s, d, dl, e, el) _http_encoding_deflate_stream_update((s), (d), (dl), (e), (el) ZEND_FILE_LINE_CC ZEND_FILE_LINE_EMPTY_CC TSRMLS_CC)
75 PHP_HTTP_API STATUS _http_encoding_deflate_stream_update(http_encoding_stream *s, const char *data, size_t data_len, char **encoded, size_t *encoded_len ZEND_FILE_LINE_DC ZEND_FILE_LINE_ORIG_DC TSRMLS_DC);
76 #define http_encoding_deflate_stream_flush(s, e, el) _http_encoding_deflate_stream_flush((s), (e), (el) ZEND_FILE_LINE_CC ZEND_FILE_LINE_EMPTY_CC TSRMLS_CC)
77 PHP_HTTP_API STATUS _http_encoding_deflate_stream_flush(http_encoding_stream *s, char **encoded, size_t *encoded_len ZEND_FILE_LINE_DC ZEND_FILE_LINE_ORIG_DC TSRMLS_DC);
78 #define http_encoding_deflate_stream_finish(s, e, el) _http_encoding_deflate_stream_finish((s), (e), (el) ZEND_FILE_LINE_CC ZEND_FILE_LINE_EMPTY_CC TSRMLS_CC)
79 PHP_HTTP_API STATUS _http_encoding_deflate_stream_finish(http_encoding_stream *s, char **encoded, size_t *encoded_len ZEND_FILE_LINE_DC ZEND_FILE_LINE_ORIG_DC TSRMLS_DC);
80 #define http_encoding_deflate_stream_dtor(s) _http_encoding_deflate_stream_dtor((s) TSRMLS_CC)
81 PHP_HTTP_API void _http_encoding_deflate_stream_dtor(http_encoding_stream *s TSRMLS_DC);
82 #define http_encoding_deflate_stream_free(s) _http_encoding_deflate_stream_free((s) TSRMLS_CC)
83 PHP_HTTP_API void _http_encoding_deflate_stream_free(http_encoding_stream **s TSRMLS_DC);
84
85 #define http_encoding_inflate_stream_init(s, f) _http_encoding_inflate_stream_init((s), (f) ZEND_FILE_LINE_CC ZEND_FILE_LINE_EMPTY_CC TSRMLS_CC)
86 PHP_HTTP_API http_encoding_stream *_http_encoding_inflate_stream_init(http_encoding_stream *s, int flags ZEND_FILE_LINE_DC ZEND_FILE_LINE_ORIG_DC TSRMLS_DC);
87 #define http_encoding_inflate_stream_update(s, d, dl, e, el) _http_encoding_inflate_stream_update((s), (d), (dl), (e), (el) ZEND_FILE_LINE_CC ZEND_FILE_LINE_EMPTY_CC TSRMLS_CC)
88 PHP_HTTP_API STATUS _http_encoding_inflate_stream_update(http_encoding_stream *s, const char *data, size_t data_len, char **decoded, size_t *decoded_len ZEND_FILE_LINE_DC ZEND_FILE_LINE_ORIG_DC TSRMLS_DC);
89 #define http_encoding_inflate_stream_flush(s, d, dl) _http_encoding_inflate_stream_flush((s), (d), (dl) ZEND_FILE_LINE_CC ZEND_FILE_LINE_EMPTY_CC TSRMLS_CC)
90 PHP_HTTP_API STATUS _http_encoding_inflate_stream_flush(http_encoding_stream *s, char **decoded, size_t *decoded_len ZEND_FILE_LINE_DC ZEND_FILE_LINE_ORIG_DC TSRMLS_DC);
91 #define http_encoding_inflate_stream_finish(s, e, el) _http_encoding_inflate_stream_finish((s), (e), (el) ZEND_FILE_LINE_CC ZEND_FILE_LINE_EMPTY_CC TSRMLS_CC)
92 PHP_HTTP_API STATUS _http_encoding_inflate_stream_finish(http_encoding_stream *s, char **decoded, size_t *decoded_len ZEND_FILE_LINE_DC ZEND_FILE_LINE_ORIG_DC TSRMLS_DC);
93 #define http_encoding_inflate_stream_dtor(s) _http_encoding_inflate_stream_dtor((s) TSRMLS_CC)
94 PHP_HTTP_API void _http_encoding_inflate_stream_dtor(http_encoding_stream *s TSRMLS_DC);
95 #define http_encoding_inflate_stream_free(s) _http_encoding_inflate_stream_free((s) TSRMLS_CC)
96 PHP_HTTP_API void _http_encoding_inflate_stream_free(http_encoding_stream **s TSRMLS_DC);
97
98 #define http_ob_deflatehandler(o, ol, h, hl, m) _http_ob_deflatehandler((o), (ol), (h), (hl), (m) TSRMLS_CC)
99 void _http_ob_deflatehandler(char *, uint, char **, uint *, int TSRMLS_DC);
100
101 #define http_ob_inflatehandler(o, ol, h, hl, m) _http_ob_inflatehandler((o), (ol), (h), (hl), (m) TSRMLS_CC)
102 void _http_ob_inflatehandler(char *, uint, char **, uint *, int TSRMLS_DC);
103 #endif /* HTTP_HAVE_ZLIB */
104
105 #endif
106
107 /*
108 * Local variables:
109 * tab-width: 4
110 * c-basic-offset: 4
111 * End:
112 * vim600: noet sw=4 ts=4 fdm=marker
113 * vim<600: noet sw=4 ts=4
114 */