carto
/
grpc


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354
							<!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: src/core/channel/channel_args.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
   &#160;<span id="projectnumber">0.11.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&#160;Page</span></a></li>
      <li><a href="annotated.html"><span>Data&#160;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&#160;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">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</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_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_aebb8dcc11953d78e620bbef0b9e2183.html">core</a></li><li class="navelem"><a class="el" href="dir_8aa15e76222df75340b2e23e43efb3e2.html">channel</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">channel_args.h File Reference</div>  </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><code>#include &lt;<a class="el" href="compression_8h_source.html">grpc/compression.h</a>&gt;</code><br/>
<code>#include &lt;<a class="el" href="grpc_8h_source.html">grpc/grpc.h</a>&gt;</code><br/>
</div>
<p><a href="channel__args_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="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:aea7141804d69de11c1470197ad87b45d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structgrpc__channel__args.html">grpc_channel_args</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="channel__args_8h.html#aea7141804d69de11c1470197ad87b45d">grpc_channel_args_copy</a> (const <a class="el" href="structgrpc__channel__args.html">grpc_channel_args</a> *src)</td></tr>
<tr class="separator:aea7141804d69de11c1470197ad87b45d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ace4130d42d359c697a99d4ed7a7e54c3"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structgrpc__channel__args.html">grpc_channel_args</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="channel__args_8h.html#ace4130d42d359c697a99d4ed7a7e54c3">grpc_channel_args_copy_and_add</a> (const <a class="el" href="structgrpc__channel__args.html">grpc_channel_args</a> *src, const <a class="el" href="structgrpc__arg.html">grpc_arg</a> *to_add, size_t num_to_add)</td></tr>
<tr class="memdesc:ace4130d42d359c697a99d4ed7a7e54c3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Copy some arguments and add the to_add parameter in the end.  <a href="#ace4130d42d359c697a99d4ed7a7e54c3">More...</a><br/></td></tr>
<tr class="separator:ace4130d42d359c697a99d4ed7a7e54c3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa098be5f086aefff83a52e202d11a39a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structgrpc__channel__args.html">grpc_channel_args</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="channel__args_8h.html#aa098be5f086aefff83a52e202d11a39a">grpc_channel_args_merge</a> (const <a class="el" href="structgrpc__channel__args.html">grpc_channel_args</a> *a, const <a class="el" href="structgrpc__channel__args.html">grpc_channel_args</a> *b)</td></tr>
<tr class="memdesc:aa098be5f086aefff83a52e202d11a39a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Copy args from a then args from b into a new channel args.  <a href="#aa098be5f086aefff83a52e202d11a39a">More...</a><br/></td></tr>
<tr class="separator:aa098be5f086aefff83a52e202d11a39a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad7467ddcad8160325b79b8d3a627c42e"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="channel__args_8h.html#ad7467ddcad8160325b79b8d3a627c42e">grpc_channel_args_destroy</a> (<a class="el" href="structgrpc__channel__args.html">grpc_channel_args</a> *a)</td></tr>
<tr class="memdesc:ad7467ddcad8160325b79b8d3a627c42e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destroy arguments created by grpc_channel_args_copy.  <a href="#ad7467ddcad8160325b79b8d3a627c42e">More...</a><br/></td></tr>
<tr class="separator:ad7467ddcad8160325b79b8d3a627c42e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a918e3c374d10937b1cf1a7bec45e96c0"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="channel__args_8h.html#a918e3c374d10937b1cf1a7bec45e96c0">grpc_channel_args_is_census_enabled</a> (const <a class="el" href="structgrpc__channel__args.html">grpc_channel_args</a> *a)</td></tr>
<tr class="memdesc:a918e3c374d10937b1cf1a7bec45e96c0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reads census_enabled settings from channel args.  <a href="#a918e3c374d10937b1cf1a7bec45e96c0">More...</a><br/></td></tr>
<tr class="separator:a918e3c374d10937b1cf1a7bec45e96c0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab6073e21bee62a87f891a10d5bb4a3bb"><td class="memItemLeft" align="right" valign="top"><a class="el" href="compression_8h.html#ab9de0f68bfb1ef8ed09bd00643db14c9">grpc_compression_algorithm</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="channel__args_8h.html#ab6073e21bee62a87f891a10d5bb4a3bb">grpc_channel_args_get_compression_algorithm</a> (const <a class="el" href="structgrpc__channel__args.html">grpc_channel_args</a> *a)</td></tr>
<tr class="memdesc:ab6073e21bee62a87f891a10d5bb4a3bb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the compression algorithm set in <em>a</em>.  <a href="#ab6073e21bee62a87f891a10d5bb4a3bb">More...</a><br/></td></tr>
<tr class="separator:ab6073e21bee62a87f891a10d5bb4a3bb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1666cde2d23a797e95cf09e3c26e7f70"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structgrpc__channel__args.html">grpc_channel_args</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="channel__args_8h.html#a1666cde2d23a797e95cf09e3c26e7f70">grpc_channel_args_set_compression_algorithm</a> (<a class="el" href="structgrpc__channel__args.html">grpc_channel_args</a> *a, <a class="el" href="compression_8h.html#ab9de0f68bfb1ef8ed09bd00643db14c9">grpc_compression_algorithm</a> algorithm)</td></tr>
<tr class="memdesc:a1666cde2d23a797e95cf09e3c26e7f70"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns a channel arg instance with compression enabled.  <a href="#a1666cde2d23a797e95cf09e3c26e7f70">More...</a><br/></td></tr>
<tr class="separator:a1666cde2d23a797e95cf09e3c26e7f70"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a042300d8789405a6ca4668796989a041"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structgrpc__channel__args.html">grpc_channel_args</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="channel__args_8h.html#a042300d8789405a6ca4668796989a041">grpc_channel_args_compression_algorithm_set_state</a> (<a class="el" href="structgrpc__channel__args.html">grpc_channel_args</a> **a, <a class="el" href="compression_8h.html#ab9de0f68bfb1ef8ed09bd00643db14c9">grpc_compression_algorithm</a> algorithm, int enabled)</td></tr>
<tr class="memdesc:a042300d8789405a6ca4668796989a041"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets the support for the given compression algorithm.  <a href="#a042300d8789405a6ca4668796989a041">More...</a><br/></td></tr>
<tr class="separator:a042300d8789405a6ca4668796989a041"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a409bef86bb07d68e5d63e222cb8be2c9"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="channel__args_8h.html#a409bef86bb07d68e5d63e222cb8be2c9">grpc_channel_args_compression_algorithm_get_states</a> (const <a class="el" href="structgrpc__channel__args.html">grpc_channel_args</a> *a)</td></tr>
<tr class="memdesc:a409bef86bb07d68e5d63e222cb8be2c9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the bitset representing the support state (true for enabled, false for disabled) for compression algorithms.  <a href="#a409bef86bb07d68e5d63e222cb8be2c9">More...</a><br/></td></tr>
<tr class="separator:a409bef86bb07d68e5d63e222cb8be2c9"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="a409bef86bb07d68e5d63e222cb8be2c9"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int grpc_channel_args_compression_algorithm_get_states </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="structgrpc__channel__args.html">grpc_channel_args</a> *&#160;</td>
          <td class="paramname"><em>a</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Returns the bitset representing the support state (true for enabled, false for disabled) for compression algorithms. </p>
<p>The i-th bit of the returned bitset corresponds to the i-th entry in the grpc_compression_algorithm enum. </p>

</div>
</div>
<a class="anchor" id="a042300d8789405a6ca4668796989a041"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="structgrpc__channel__args.html">grpc_channel_args</a>* grpc_channel_args_compression_algorithm_set_state </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structgrpc__channel__args.html">grpc_channel_args</a> **&#160;</td>
          <td class="paramname"><em>a</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>&#160;</td>
          <td class="paramname"><em>algorithm</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>enabled</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Sets the support for the given compression algorithm. </p>
<p>By default, all compression algorithms are enabled. It's an error to disable an algorithm set by grpc_channel_args_set_compression_algorithm.</p>
<p>Returns an instance will the updated algorithm states. The <em>a</em> pointer is modified to point to the returned instance (which may be different from the input value of <em>a</em>). </p>

</div>
</div>
<a class="anchor" id="aea7141804d69de11c1470197ad87b45d"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="structgrpc__channel__args.html">grpc_channel_args</a>* grpc_channel_args_copy </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="structgrpc__channel__args.html">grpc_channel_args</a> *&#160;</td>
          <td class="paramname"><em>src</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<a class="anchor" id="ace4130d42d359c697a99d4ed7a7e54c3"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="structgrpc__channel__args.html">grpc_channel_args</a>* grpc_channel_args_copy_and_add </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="structgrpc__channel__args.html">grpc_channel_args</a> *&#160;</td>
          <td class="paramname"><em>src</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="structgrpc__arg.html">grpc_arg</a> *&#160;</td>
          <td class="paramname"><em>to_add</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">size_t&#160;</td>
          <td class="paramname"><em>num_to_add</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Copy some arguments and add the to_add parameter in the end. </p>
<p>If to_add is NULL, it is equivalent to call grpc_channel_args_copy. </p>

</div>
</div>
<a class="anchor" id="ad7467ddcad8160325b79b8d3a627c42e"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void grpc_channel_args_destroy </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structgrpc__channel__args.html">grpc_channel_args</a> *&#160;</td>
          <td class="paramname"><em>a</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Destroy arguments created by grpc_channel_args_copy. </p>

</div>
</div>
<a class="anchor" id="ab6073e21bee62a87f891a10d5bb4a3bb"></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_channel_args_get_compression_algorithm </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="structgrpc__channel__args.html">grpc_channel_args</a> *&#160;</td>
          <td class="paramname"><em>a</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Returns the compression algorithm set in <em>a</em>. </p>

</div>
</div>
<a class="anchor" id="a918e3c374d10937b1cf1a7bec45e96c0"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int grpc_channel_args_is_census_enabled </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="structgrpc__channel__args.html">grpc_channel_args</a> *&#160;</td>
          <td class="paramname"><em>a</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Reads census_enabled settings from channel args. </p>
<p>Returns 1 if census_enabled is specified in channel args, otherwise returns 0. </p>

</div>
</div>
<a class="anchor" id="aa098be5f086aefff83a52e202d11a39a"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="structgrpc__channel__args.html">grpc_channel_args</a>* grpc_channel_args_merge </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="structgrpc__channel__args.html">grpc_channel_args</a> *&#160;</td>
          <td class="paramname"><em>a</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="structgrpc__channel__args.html">grpc_channel_args</a> *&#160;</td>
          <td class="paramname"><em>b</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Copy args from a then args from b into a new channel args. </p>

</div>
</div>
<a class="anchor" id="a1666cde2d23a797e95cf09e3c26e7f70"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="structgrpc__channel__args.html">grpc_channel_args</a>* grpc_channel_args_set_compression_algorithm </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structgrpc__channel__args.html">grpc_channel_args</a> *&#160;</td>
          <td class="paramname"><em>a</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>&#160;</td>
          <td class="paramname"><em>algorithm</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Returns a channel arg instance with compression enabled. </p>
<p>If <em>a</em> is non-NULL, its args are copied. N.B. GRPC_COMPRESS_NONE disables compression for the channel. </p>

</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Thu Sep 3 2015 09:44:13 for GRPC Core by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.6
</small></address>
</body>
</html>