| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
| <html xmlns="http://www.w3.org/1999/xhtml"> |
| <head> |
| <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> |
| <meta http-equiv="X-UA-Compatible" content="IE=9"/> |
| <meta name="generator" content="Doxygen 1.8.6"/> |
| <title>GRPC Core: include/grpc/compression.h File Reference</title> |
| <link href="tabs.css" rel="stylesheet" type="text/css"/> |
| <script type="text/javascript" src="jquery.js"></script> |
| <script type="text/javascript" src="dynsections.js"></script> |
| <link href="search/search.css" rel="stylesheet" type="text/css"/> |
| <script type="text/javascript" src="search/search.js"></script> |
| <script type="text/javascript"> |
| $(document).ready(function() { searchBox.OnSelectItem(0); }); |
| </script> |
| <link href="doxygen.css" rel="stylesheet" type="text/css" /> |
| </head> |
| <body> |
| <div id="top"><!-- do not remove this div, it is closed by doxygen! --> |
| <div id="titlearea"> |
| <table cellspacing="0" cellpadding="0"> |
| <tbody> |
| <tr style="height: 56px;"> |
| <td style="padding-left: 0.5em;"> |
| <div id="projectname">GRPC Core |
|  <span id="projectnumber">0.10.0.0</span> |
| </div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <!-- end header part --> |
| <!-- Generated by Doxygen 1.8.6 --> |
| <script type="text/javascript"> |
| var searchBox = new SearchBox("searchBox", "search",false,'Search'); |
| </script> |
| <div id="navrow1" class="tabs"> |
| <ul class="tablist"> |
| <li><a href="index.html"><span>Main Page</span></a></li> |
| <li><a href="annotated.html"><span>Data Structures</span></a></li> |
| <li class="current"><a href="files.html"><span>Files</span></a></li> |
| <li> |
| <div id="MSearchBox" class="MSearchBoxInactive"> |
| <span class="left"> |
| <img id="MSearchSelect" src="search/mag_sel.png" |
| onmouseover="return searchBox.OnSearchSelectShow()" |
| onmouseout="return searchBox.OnSearchSelectHide()" |
| alt=""/> |
| <input type="text" id="MSearchField" value="Search" accesskey="S" |
| onfocus="searchBox.OnSearchFieldFocus(true)" |
| onblur="searchBox.OnSearchFieldFocus(false)" |
| onkeyup="searchBox.OnSearchFieldChange(event)"/> |
| </span><span class="right"> |
| <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a> |
| </span> |
| </div> |
| </li> |
| </ul> |
| </div> |
| <div id="navrow2" class="tabs2"> |
| <ul class="tablist"> |
| <li><a href="files.html"><span>File List</span></a></li> |
| <li><a href="globals.html"><span>Globals</span></a></li> |
| </ul> |
| </div> |
| <!-- window showing the filter options --> |
| <div id="MSearchSelectWindow" |
| onmouseover="return searchBox.OnSearchSelectShow()" |
| onmouseout="return searchBox.OnSearchSelectHide()" |
| onkeydown="return searchBox.OnSearchSelectKey(event)"> |
| <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Pages</a></div> |
| |
| <!-- iframe showing the search results (closed by default) --> |
| <div id="MSearchResultsWindow"> |
| <iframe src="javascript:void(0)" frameborder="0" |
| name="MSearchResults" id="MSearchResults"> |
| </iframe> |
| </div> |
| |
| <div id="nav-path" class="navpath"> |
| <ul> |
| <li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_9d7a14d6d9adcbe4c35dbdb88d867e2e.html">grpc</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="summary"> |
| <a href="#define-members">Macros</a> | |
| <a href="#enum-members">Enumerations</a> | |
| <a href="#func-members">Functions</a> </div> |
| <div class="headertitle"> |
| <div class="title">compression.h File Reference</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p><a href="compression_8h_source.html">Go to the source code of this file.</a></p> |
| <table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a> |
| Macros</h2></td></tr> |
| <tr class="memitem:a9340488e193921e62bb1f240f9016a9b"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="compression_8h.html#a9340488e193921e62bb1f240f9016a9b">GRPC_COMPRESSION_ALGORITHM_ARG</a>   "grpc.compression_algorithm"</td></tr> |
| <tr class="memdesc:a9340488e193921e62bb1f240f9016a9b"><td class="mdescLeft"> </td><td class="mdescRight">To be used in channel arguments. <a href="#a9340488e193921e62bb1f240f9016a9b">More...</a><br/></td></tr> |
| <tr class="separator:a9340488e193921e62bb1f240f9016a9b"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a> |
| Enumerations</h2></td></tr> |
| <tr class="memitem:ab9de0f68bfb1ef8ed09bd00643db14c9"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="compression_8h.html#ab9de0f68bfb1ef8ed09bd00643db14c9">grpc_compression_algorithm</a> { <a class="el" href="compression_8h.html#ab9de0f68bfb1ef8ed09bd00643db14c9a3135cac7e854adb16358c53e97df9cd8">GRPC_COMPRESS_NONE</a> = 0, |
| <a class="el" href="compression_8h.html#ab9de0f68bfb1ef8ed09bd00643db14c9a50de256d5abe80daff7e1372e29dd913">GRPC_COMPRESS_DEFLATE</a>, |
| <a class="el" href="compression_8h.html#ab9de0f68bfb1ef8ed09bd00643db14c9a5a134ced82d8682b55b99b8e9386555e">GRPC_COMPRESS_GZIP</a>, |
| <a class="el" href="compression_8h.html#ab9de0f68bfb1ef8ed09bd00643db14c9a94d7fc0a8e4a05546d462d53c2b53b8d">GRPC_COMPRESS_ALGORITHMS_COUNT</a> |
| }</td></tr> |
| <tr class="separator:ab9de0f68bfb1ef8ed09bd00643db14c9"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a14a79ed6b5ebd7e1dda7c2684f499cc7"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="compression_8h.html#a14a79ed6b5ebd7e1dda7c2684f499cc7">grpc_compression_level</a> { <br/> |
|   <a class="el" href="compression_8h.html#a14a79ed6b5ebd7e1dda7c2684f499cc7ab67efe04f58b0939b963e51a5b8f772c">GRPC_COMPRESS_LEVEL_NONE</a> = 0, |
| <a class="el" href="compression_8h.html#a14a79ed6b5ebd7e1dda7c2684f499cc7afd436e21be4f897ca939b3b4d9a44673">GRPC_COMPRESS_LEVEL_LOW</a>, |
| <a class="el" href="compression_8h.html#a14a79ed6b5ebd7e1dda7c2684f499cc7a4319a32cdd0b59a7ecc977f8612214ce">GRPC_COMPRESS_LEVEL_MED</a>, |
| <a class="el" href="compression_8h.html#a14a79ed6b5ebd7e1dda7c2684f499cc7a501a0cf15300a90c09a3d8b4f7f43d22">GRPC_COMPRESS_LEVEL_HIGH</a>, |
| <br/> |
|   <a class="el" href="compression_8h.html#a14a79ed6b5ebd7e1dda7c2684f499cc7a893b24fb0986e61ebda069c713b8bd43">GRPC_COMPRESS_LEVEL_COUNT</a> |
| <br/> |
| }</td></tr> |
| <tr class="separator:a14a79ed6b5ebd7e1dda7c2684f499cc7"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a> |
| Functions</h2></td></tr> |
| <tr class="memitem:a996f65ae42d05dd7ef9da9c6d6586397"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="compression_8h.html#a996f65ae42d05dd7ef9da9c6d6586397">grpc_compression_algorithm_parse</a> (const char *name, <a class="el" href="compression_8h.html#ab9de0f68bfb1ef8ed09bd00643db14c9">grpc_compression_algorithm</a> *algorithm)</td></tr> |
| <tr class="memdesc:a996f65ae42d05dd7ef9da9c6d6586397"><td class="mdescLeft"> </td><td class="mdescRight">Parses <em>name</em> as a grpc_compression_algorithm instance, updating <em>algorithm</em>. <a href="#a996f65ae42d05dd7ef9da9c6d6586397">More...</a><br/></td></tr> |
| <tr class="separator:a996f65ae42d05dd7ef9da9c6d6586397"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:adce0341ab8fd560dc39e9e96daf7cb14"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="compression_8h.html#adce0341ab8fd560dc39e9e96daf7cb14">grpc_compression_algorithm_name</a> (<a class="el" href="compression_8h.html#ab9de0f68bfb1ef8ed09bd00643db14c9">grpc_compression_algorithm</a> algorithm, char **name)</td></tr> |
| <tr class="memdesc:adce0341ab8fd560dc39e9e96daf7cb14"><td class="mdescLeft"> </td><td class="mdescRight">Updates <em>name</em> with the encoding name corresponding to a valid <em>algorithm</em>. <a href="#adce0341ab8fd560dc39e9e96daf7cb14">More...</a><br/></td></tr> |
| <tr class="separator:adce0341ab8fd560dc39e9e96daf7cb14"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ace80040d9c2a916ddd4d2f2d2ec44dba"><td class="memItemLeft" align="right" valign="top"><a class="el" href="compression_8h.html#a14a79ed6b5ebd7e1dda7c2684f499cc7">grpc_compression_level</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="compression_8h.html#ace80040d9c2a916ddd4d2f2d2ec44dba">grpc_compression_level_for_algorithm</a> (<a class="el" href="compression_8h.html#ab9de0f68bfb1ef8ed09bd00643db14c9">grpc_compression_algorithm</a> algorithm)</td></tr> |
| <tr class="memdesc:ace80040d9c2a916ddd4d2f2d2ec44dba"><td class="mdescLeft"> </td><td class="mdescRight">Returns the compression level corresponding to <em>algorithm</em>. <a href="#ace80040d9c2a916ddd4d2f2d2ec44dba">More...</a><br/></td></tr> |
| <tr class="separator:ace80040d9c2a916ddd4d2f2d2ec44dba"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a382cce802b53a6f85deb706caf1dccd6"><td class="memItemLeft" align="right" valign="top"><a class="el" href="compression_8h.html#ab9de0f68bfb1ef8ed09bd00643db14c9">grpc_compression_algorithm</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="compression_8h.html#a382cce802b53a6f85deb706caf1dccd6">grpc_compression_algorithm_for_level</a> (<a class="el" href="compression_8h.html#a14a79ed6b5ebd7e1dda7c2684f499cc7">grpc_compression_level</a> level)</td></tr> |
| <tr class="memdesc:a382cce802b53a6f85deb706caf1dccd6"><td class="mdescLeft"> </td><td class="mdescRight">Returns the compression algorithm corresponding to <em>level</em>. <a href="#a382cce802b53a6f85deb706caf1dccd6">More...</a><br/></td></tr> |
| <tr class="separator:a382cce802b53a6f85deb706caf1dccd6"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <h2 class="groupheader">Macro Definition Documentation</h2> |
| <a class="anchor" id="a9340488e193921e62bb1f240f9016a9b"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">#define GRPC_COMPRESSION_ALGORITHM_ARG   "grpc.compression_algorithm"</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>To be used in channel arguments. </p> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Enumeration Type Documentation</h2> |
| <a class="anchor" id="ab9de0f68bfb1ef8ed09bd00643db14c9"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">enum <a class="el" href="compression_8h.html#ab9de0f68bfb1ef8ed09bd00643db14c9">grpc_compression_algorithm</a></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <table class="fieldtable"> |
| <tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><em><a class="anchor" id="ab9de0f68bfb1ef8ed09bd00643db14c9a3135cac7e854adb16358c53e97df9cd8"></a>GRPC_COMPRESS_NONE</em> </td><td class="fielddoc"> |
| </td></tr> |
| <tr><td class="fieldname"><em><a class="anchor" id="ab9de0f68bfb1ef8ed09bd00643db14c9a50de256d5abe80daff7e1372e29dd913"></a>GRPC_COMPRESS_DEFLATE</em> </td><td class="fielddoc"> |
| </td></tr> |
| <tr><td class="fieldname"><em><a class="anchor" id="ab9de0f68bfb1ef8ed09bd00643db14c9a5a134ced82d8682b55b99b8e9386555e"></a>GRPC_COMPRESS_GZIP</em> </td><td class="fielddoc"> |
| </td></tr> |
| <tr><td class="fieldname"><em><a class="anchor" id="ab9de0f68bfb1ef8ed09bd00643db14c9a94d7fc0a8e4a05546d462d53c2b53b8d"></a>GRPC_COMPRESS_ALGORITHMS_COUNT</em> </td><td class="fielddoc"> |
| </td></tr> |
| </table> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a14a79ed6b5ebd7e1dda7c2684f499cc7"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">enum <a class="el" href="compression_8h.html#a14a79ed6b5ebd7e1dda7c2684f499cc7">grpc_compression_level</a></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <table class="fieldtable"> |
| <tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><em><a class="anchor" id="a14a79ed6b5ebd7e1dda7c2684f499cc7ab67efe04f58b0939b963e51a5b8f772c"></a>GRPC_COMPRESS_LEVEL_NONE</em> </td><td class="fielddoc"> |
| </td></tr> |
| <tr><td class="fieldname"><em><a class="anchor" id="a14a79ed6b5ebd7e1dda7c2684f499cc7afd436e21be4f897ca939b3b4d9a44673"></a>GRPC_COMPRESS_LEVEL_LOW</em> </td><td class="fielddoc"> |
| </td></tr> |
| <tr><td class="fieldname"><em><a class="anchor" id="a14a79ed6b5ebd7e1dda7c2684f499cc7a4319a32cdd0b59a7ecc977f8612214ce"></a>GRPC_COMPRESS_LEVEL_MED</em> </td><td class="fielddoc"> |
| </td></tr> |
| <tr><td class="fieldname"><em><a class="anchor" id="a14a79ed6b5ebd7e1dda7c2684f499cc7a501a0cf15300a90c09a3d8b4f7f43d22"></a>GRPC_COMPRESS_LEVEL_HIGH</em> </td><td class="fielddoc"> |
| </td></tr> |
| <tr><td class="fieldname"><em><a class="anchor" id="a14a79ed6b5ebd7e1dda7c2684f499cc7a893b24fb0986e61ebda069c713b8bd43"></a>GRPC_COMPRESS_LEVEL_COUNT</em> </td><td class="fielddoc"> |
| </td></tr> |
| </table> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Function Documentation</h2> |
| <a class="anchor" id="a382cce802b53a6f85deb706caf1dccd6"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="compression_8h.html#ab9de0f68bfb1ef8ed09bd00643db14c9">grpc_compression_algorithm</a> grpc_compression_algorithm_for_level </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="compression_8h.html#a14a79ed6b5ebd7e1dda7c2684f499cc7">grpc_compression_level</a> </td> |
| <td class="paramname"><em>level</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Returns the compression algorithm corresponding to <em>level</em>. </p> |
| <p>It abort()s for unknown levels . </p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="adce0341ab8fd560dc39e9e96daf7cb14"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">int grpc_compression_algorithm_name </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="compression_8h.html#ab9de0f68bfb1ef8ed09bd00643db14c9">grpc_compression_algorithm</a> </td> |
| <td class="paramname"><em>algorithm</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">char ** </td> |
| <td class="paramname"><em>name</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Updates <em>name</em> with the encoding name corresponding to a valid <em>algorithm</em>. </p> |
| <p>Returns 1 upon success, 0 otherwise. </p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a996f65ae42d05dd7ef9da9c6d6586397"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">int grpc_compression_algorithm_parse </td> |
| <td>(</td> |
| <td class="paramtype">const char * </td> |
| <td class="paramname"><em>name</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"><a class="el" href="compression_8h.html#ab9de0f68bfb1ef8ed09bd00643db14c9">grpc_compression_algorithm</a> * </td> |
| <td class="paramname"><em>algorithm</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Parses <em>name</em> as a grpc_compression_algorithm instance, updating <em>algorithm</em>. </p> |
| <p>Returns 1 upon success, 0 otherwise. </p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="ace80040d9c2a916ddd4d2f2d2ec44dba"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="compression_8h.html#a14a79ed6b5ebd7e1dda7c2684f499cc7">grpc_compression_level</a> grpc_compression_level_for_algorithm </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="compression_8h.html#ab9de0f68bfb1ef8ed09bd00643db14c9">grpc_compression_algorithm</a> </td> |
| <td class="paramname"><em>algorithm</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Returns the compression level corresponding to <em>algorithm</em>. </p> |
| <p>It abort()s for unknown algorithms. </p> |
| |
| </div> |
| </div> |
| </div><!-- contents --> |
| <!-- start footer part --> |
| <hr class="footer"/><address class="footer"><small> |
| Generated on Wed Aug 5 2015 08:17:05 for GRPC Core by  <a href="http://www.doxygen.org/index.html"> |
| <img class="footer" src="doxygen.png" alt="doxygen"/> |
| </a> 1.8.6 |
| </small></address> |
| </body> |
| </html> |