Imported Upstream version 1.0.0
[platform/upstream/nghttp2.git] / doc / nghttp2_hd_deflate_new.rst
1
2 nghttp2_hd_deflate_new
3 ======================
4
5 Synopsis
6 --------
7
8 *#include <nghttp2/nghttp2.h>*
9
10 .. function:: int nghttp2_hd_deflate_new(nghttp2_hd_deflater **deflater_ptr, size_t deflate_hd_table_bufsize_max)
11
12     
13     Initializes *\*deflater_ptr* for deflating name/values pairs.
14     
15     The *deflate_hd_table_bufsize_max* is the upper bound of header
16     table size the deflater will use.
17     
18     If this function fails, *\*deflater_ptr* is left untouched.
19     
20     This function returns 0 if it succeeds, or one of the following
21     negative error codes:
22     
23     :macro:`NGHTTP2_ERR_NOMEM`
24         Out of memory.