libs/beast/doc/html/beast/ref/boost__beast__zlib__deflate_stream/params.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>zlib::deflate_stream::params</title>
   5 <link rel="stylesheet" href="../../../../../../../doc/src/boostbook.css" type="text/css">
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
   7 <link rel="home" href="../../../index.html" title="Chapter&#160;1.&#160;Boost.Beast">
   8 <link rel="up" href="../boost__beast__zlib__deflate_stream.html" title="zlib::deflate_stream">
   9 <link rel="prev" href="deflate_stream.html" title="zlib::deflate_stream::deflate_stream">
  10 <link rel="next" href="pending.html" title="zlib::deflate_stream::pending">
  11 </head>
  12 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
  13 <table cellpadding="2" width="100%"><tr>
  14 <td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../boost.png"></td>
  15 <td align="center"><a href="../../../../../../../index.html">Home</a></td>
  16 <td align="center"><a href="../../../../../../../libs/libraries.htm">Libraries</a></td>
  17 <td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
  18 <td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
  19 <td align="center"><a href="../../../../../../../more/index.htm">More</a></td>
  20 </tr></table>
  21 <hr>
  22 <div class="spirit-nav">
  23 <a accesskey="p" href="deflate_stream.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../boost__beast__zlib__deflate_stream.html"><img src="../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="pending.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
  24 </div>
  25 <div class="section">
  26 <div class="titlepage"><div><div><h5 class="title">
  27 <a name="beast.ref.boost__beast__zlib__deflate_stream.params"></a><a class="link" href="params.html" title="zlib::deflate_stream::params">zlib::deflate_stream::params</a>
  28 </h5></div></div></div>
  29 <p>
  30           <a class="indexterm" name="idm45873468795696"></a>
  31 Update the compression level and strategy.
  32         </p>
  33 <h6>
  34 <a name="beast.ref.boost__beast__zlib__deflate_stream.params.h0"></a>
  35           <span class="phrase"><a name="beast.ref.boost__beast__zlib__deflate_stream.params.synopsis"></a></span><a class="link" href="params.html#beast.ref.boost__beast__zlib__deflate_stream.params.synopsis">Synopsis</a>
  36         </h6>
  37 <pre class="programlisting"><span class="keyword">void</span>
  38 <span class="identifier">params</span><span class="special">(</span>
  39     <span class="identifier">z_params</span><span class="special">&amp;</span> <span class="identifier">zs</span><span class="special">,</span>
  40     <span class="keyword">int</span> <span class="identifier">level</span><span class="special">,</span>
  41     <span class="identifier">Strategy</span> <span class="identifier">strategy</span><span class="special">,</span>
  42     <span class="identifier">error_code</span><span class="special">&amp;</span> <span class="identifier">ec</span><span class="special">);</span>
  43 </pre>
  44 <h6>
  45 <a name="beast.ref.boost__beast__zlib__deflate_stream.params.h1"></a>
  46           <span class="phrase"><a name="beast.ref.boost__beast__zlib__deflate_stream.params.description"></a></span><a class="link" href="params.html#beast.ref.boost__beast__zlib__deflate_stream.params.description">Description</a>
  47         </h6>
  48 <p>
  49           This function dynamically updates the compression level and compression
  50           strategy. The interpretation of level and strategy is as in <a class="link" href="reset.html" title="zlib::deflate_stream::reset"><code class="computeroutput"><span class="identifier">zlib</span><span class="special">::</span><span class="identifier">deflate_stream</span><span class="special">::</span><span class="identifier">reset</span></code></a>. This can be used to switch
  51           between compression and straight copy of the input data, or to switch to
  52           a different kind of input data requiring a different strategy. If the compression
  53           level is changed, the input available so far is compressed with the old
  54           level (and may be flushed); the new level will take effect only at the
  55           next call of <a class="link" href="write.html" title="zlib::deflate_stream::write"><code class="computeroutput"><span class="identifier">zlib</span><span class="special">::</span><span class="identifier">deflate_stream</span><span class="special">::</span><span class="identifier">write</span></code></a>. Before the call of <code class="computeroutput"><span class="identifier">params</span></code>, the stream state must be set
  56           as for a call of <a class="link" href="write.html" title="zlib::deflate_stream::write"><code class="computeroutput"><span class="identifier">zlib</span><span class="special">::</span><span class="identifier">deflate_stream</span><span class="special">::</span><span class="identifier">write</span></code></a>, since the currently available
  57           input may have to be compressed and flushed. In particular, <code class="computeroutput"><span class="identifier">zs</span><span class="special">.</span><span class="identifier">avail_out</span></code>
  58           must be non-zero.
  59         </p>
  60 <h6>
  61 <a name="beast.ref.boost__beast__zlib__deflate_stream.params.h2"></a>
  62           <span class="phrase"><a name="beast.ref.boost__beast__zlib__deflate_stream.params.return_value"></a></span><a class="link" href="params.html#beast.ref.boost__beast__zlib__deflate_stream.params.return_value">Return
  63           Value</a>
  64         </h6>
  65 <p>
  66           <code class="computeroutput"><span class="identifier">Z_OK</span></code> if success, <code class="computeroutput"><span class="identifier">Z_STREAM_ERROR</span></code> if the source stream state
  67           was inconsistent or if a parameter was invalid, <code class="computeroutput"><span class="identifier">error</span><span class="special">::</span><span class="identifier">need_buffers</span></code>
  68           if <code class="computeroutput"><span class="identifier">zs</span><span class="special">.</span><span class="identifier">avail_out</span></code> was zero.
  69         </p>
  70 </div>
  71 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
  72 <td align="left"></td>
  73 <td align="right"><div class="copyright-footer">Copyright &#169; 2016-2019 Vinnie
  74       Falco<p>
  75         Distributed under the Boost Software License, Version 1.0. (See accompanying
  76         file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)
  77       </p>
  78 </div></td>
  79 </tr></table>
  80 <hr>
  81 <div class="spirit-nav">
  82 <a accesskey="p" href="deflate_stream.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../boost__beast__zlib__deflate_stream.html"><img src="../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="pending.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
  83 </div>
  84 </body>
  85 </html>