1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
|
<!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.c 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.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 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_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.c File Reference</div> </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><code>#include <<a class="el" href="grpc_8h_source.html">grpc/grpc.h</a>></code><br/>
<code>#include "<a class="el" href="channel__args_8h_source.html">src/core/channel/channel_args.h</a>"</code><br/>
<code>#include "<a class="el" href="string_8h_source.html">src/core/support/string.h</a>"</code><br/>
<code>#include <<a class="el" href="alloc_8h_source.html">grpc/support/alloc.h</a>></code><br/>
<code>#include <<a class="el" href="string__util_8h_source.html">grpc/support/string_util.h</a>></code><br/>
<code>#include <<a class="el" href="useful_8h_source.html">grpc/support/useful.h</a>></code><br/>
</div><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></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> * </td><td class="memItemRight" valign="bottom"><a class="el" href="channel__args_8c.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"> </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"> </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> * </td><td class="memItemRight" valign="bottom"><a class="el" href="channel__args_8c.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"> </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> * </td><td class="memItemRight" valign="bottom"><a class="el" href="channel__args_8c.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"> </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"> </td></tr>
<tr class="memitem:ad7467ddcad8160325b79b8d3a627c42e"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="channel__args_8c.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"> </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"> </td></tr>
<tr class="memitem:a918e3c374d10937b1cf1a7bec45e96c0"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="channel__args_8c.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"> </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"> </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> </td><td class="memItemRight" valign="bottom"><a class="el" href="channel__args_8c.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"> </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"> </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> * </td><td class="memItemRight" valign="bottom"><a class="el" href="channel__args_8c.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"> </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"> </td></tr>
<tr class="memitem:a67f5dbb8f06f061bd2baf420f7e0a953"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structgrpc__channel__args.html">grpc_channel_args</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="channel__args_8c.html#a67f5dbb8f06f061bd2baf420f7e0a953">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 state)</td></tr>
<tr class="memdesc:a67f5dbb8f06f061bd2baf420f7e0a953"><td class="mdescLeft"> </td><td class="mdescRight">Sets the support for the given compression algorithm. <a href="#a67f5dbb8f06f061bd2baf420f7e0a953">More...</a><br/></td></tr>
<tr class="separator:a67f5dbb8f06f061bd2baf420f7e0a953"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a409bef86bb07d68e5d63e222cb8be2c9"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="channel__args_8c.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"> </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"> </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> * </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="a67f5dbb8f06f061bd2baf420f7e0a953"></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> ** </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> </td>
<td class="paramname"><em>algorithm</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>enabled</em> </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> * </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> * </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> * </td>
<td class="paramname"><em>to_add</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>num_to_add</em> </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> * </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> * </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> * </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> * </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> * </td>
<td class="paramname"><em>b</em> </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> * </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> </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>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  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.6
</small></address>
</body>
</html>
|
