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
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
|
<!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/client_config/resolver.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.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_d6c86f4345f838817939dd561d8a016c.html">client_config</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Data Structures</a> |
<a href="#define-members">Macros</a> |
<a href="#typedef-members">Typedefs</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">resolver.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><code>#include "<a class="el" href="client__config_8h_source.html">src/core/client_config/client_config.h</a>"</code><br/>
<code>#include "<a class="el" href="iomgr_8h_source.html">src/core/iomgr/iomgr.h</a>"</code><br/>
<code>#include "<a class="el" href="sockaddr_8h_source.html">src/core/iomgr/sockaddr.h</a>"</code><br/>
</div>
<p><a href="resolver_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="nested-classes"></a>
Data Structures</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structgrpc__resolver.html">grpc_resolver</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="structgrpc__resolver.html" title="grpc_resolver provides grpc_client_config objects to grpc_channel objects ">grpc_resolver</a> provides <a class="el" href="structgrpc__client__config.html">grpc_client_config</a> objects to <a class="el" href="structgrpc__channel.html">grpc_channel</a> objects <a href="structgrpc__resolver.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structgrpc__resolver__vtable.html">grpc_resolver_vtable</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:a98d15570db72446a0c175bc3ad316db9"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="resolver_8h.html#a98d15570db72446a0c175bc3ad316db9">GRPC_RESOLVER_REF</a>(p, r)   <a class="el" href="resolver_8c.html#a364d687b496e862cd5830d3aed899f4f">grpc_resolver_ref</a>((p))</td></tr>
<tr class="separator:a98d15570db72446a0c175bc3ad316db9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a54ccbaf14bf8c38ad785e95d705bfe4d"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="resolver_8h.html#a54ccbaf14bf8c38ad785e95d705bfe4d">GRPC_RESOLVER_UNREF</a>(p, r)   <a class="el" href="resolver_8c.html#a22b971b1770b476c3791f3f7bd370fd9">grpc_resolver_unref</a>((p))</td></tr>
<tr class="separator:a54ccbaf14bf8c38ad785e95d705bfe4d"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:ab98013b9b8e8c28771dc39013667f2b3"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="structgrpc__resolver.html">grpc_resolver</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="resolver_8h.html#ab98013b9b8e8c28771dc39013667f2b3">grpc_resolver</a></td></tr>
<tr class="separator:ab98013b9b8e8c28771dc39013667f2b3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa9af03422b3cea75b4dae7725beab911"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="structgrpc__resolver__vtable.html">grpc_resolver_vtable</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="resolver_8h.html#aa9af03422b3cea75b4dae7725beab911">grpc_resolver_vtable</a></td></tr>
<tr class="separator:aa9af03422b3cea75b4dae7725beab911"><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:aae02c9a384f3f2c2b598f56014caa211"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="resolver_8h.html#aae02c9a384f3f2c2b598f56014caa211">grpc_resolver_ref</a> (<a class="el" href="structgrpc__resolver.html">grpc_resolver</a> *policy)</td></tr>
<tr class="separator:aae02c9a384f3f2c2b598f56014caa211"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a198c3f1a1ef2d6f40680436a2fcaa11d"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="resolver_8h.html#a198c3f1a1ef2d6f40680436a2fcaa11d">grpc_resolver_unref</a> (<a class="el" href="structgrpc__resolver.html">grpc_resolver</a> *policy)</td></tr>
<tr class="separator:a198c3f1a1ef2d6f40680436a2fcaa11d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac806a2edf4f2073529eec1319db9fde4"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="resolver_8h.html#ac806a2edf4f2073529eec1319db9fde4">grpc_resolver_init</a> (<a class="el" href="structgrpc__resolver.html">grpc_resolver</a> *resolver, const <a class="el" href="structgrpc__resolver__vtable.html">grpc_resolver_vtable</a> *vtable)</td></tr>
<tr class="separator:ac806a2edf4f2073529eec1319db9fde4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae7b200016c3489c0bb3de525198b435b"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="resolver_8h.html#ae7b200016c3489c0bb3de525198b435b">grpc_resolver_shutdown</a> (<a class="el" href="structgrpc__resolver.html">grpc_resolver</a> *resolver)</td></tr>
<tr class="separator:ae7b200016c3489c0bb3de525198b435b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a118536c3b62613e957e10ce9cb602e6e"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="resolver_8h.html#a118536c3b62613e957e10ce9cb602e6e">grpc_resolver_channel_saw_error</a> (<a class="el" href="structgrpc__resolver.html">grpc_resolver</a> *resolver, struct sockaddr *failing_address, int failing_address_len)</td></tr>
<tr class="memdesc:a118536c3b62613e957e10ce9cb602e6e"><td class="mdescLeft"> </td><td class="mdescRight">Notification that the channel has seen an error on some address. <a href="#a118536c3b62613e957e10ce9cb602e6e">More...</a><br/></td></tr>
<tr class="separator:a118536c3b62613e957e10ce9cb602e6e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac5ef07f9efdd2a39f2239207cc060729"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="resolver_8h.html#ac5ef07f9efdd2a39f2239207cc060729">grpc_resolver_next</a> (<a class="el" href="structgrpc__resolver.html">grpc_resolver</a> *resolver, <a class="el" href="structgrpc__client__config.html">grpc_client_config</a> **target_config, <a class="el" href="structgrpc__iomgr__closure.html">grpc_iomgr_closure</a> *on_complete)</td></tr>
<tr class="memdesc:ac5ef07f9efdd2a39f2239207cc060729"><td class="mdescLeft"> </td><td class="mdescRight">Get the next client config. <a href="#ac5ef07f9efdd2a39f2239207cc060729">More...</a><br/></td></tr>
<tr class="separator:ac5ef07f9efdd2a39f2239207cc060729"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a class="anchor" id="a98d15570db72446a0c175bc3ad316db9"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define GRPC_RESOLVER_REF</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">p, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname">r </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td>   <a class="el" href="resolver_8c.html#a364d687b496e862cd5830d3aed899f4f">grpc_resolver_ref</a>((p))</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a54ccbaf14bf8c38ad785e95d705bfe4d"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define GRPC_RESOLVER_UNREF</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">p, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname">r </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td>   <a class="el" href="resolver_8c.html#a22b971b1770b476c3791f3f7bd370fd9">grpc_resolver_unref</a>((p))</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Typedef Documentation</h2>
<a class="anchor" id="ab98013b9b8e8c28771dc39013667f2b3"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct <a class="el" href="structgrpc__resolver.html">grpc_resolver</a> <a class="el" href="structgrpc__resolver.html">grpc_resolver</a></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="aa9af03422b3cea75b4dae7725beab911"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct <a class="el" href="structgrpc__resolver__vtable.html">grpc_resolver_vtable</a> <a class="el" href="structgrpc__resolver__vtable.html">grpc_resolver_vtable</a></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="a118536c3b62613e957e10ce9cb602e6e"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void grpc_resolver_channel_saw_error </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structgrpc__resolver.html">grpc_resolver</a> * </td>
<td class="paramname"><em>resolver</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">struct sockaddr * </td>
<td class="paramname"><em>failing_address</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>failing_address_len</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Notification that the channel has seen an error on some address. </p>
<p>Can be used as a hint that re-resolution is desirable soon. </p>
</div>
</div>
<a class="anchor" id="ac806a2edf4f2073529eec1319db9fde4"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void grpc_resolver_init </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structgrpc__resolver.html">grpc_resolver</a> * </td>
<td class="paramname"><em>resolver</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="structgrpc__resolver__vtable.html">grpc_resolver_vtable</a> * </td>
<td class="paramname"><em>vtable</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="ac5ef07f9efdd2a39f2239207cc060729"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void grpc_resolver_next </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structgrpc__resolver.html">grpc_resolver</a> * </td>
<td class="paramname"><em>resolver</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structgrpc__client__config.html">grpc_client_config</a> ** </td>
<td class="paramname"><em>target_config</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structgrpc__iomgr__closure.html">grpc_iomgr_closure</a> * </td>
<td class="paramname"><em>on_complete</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the next client config. </p>
<p>Called by the channel to fetch a new configuration. Expected to set *target_config with a new configuration, and then schedule on_complete for execution.</p>
<p>If resolution is fatally broken, set *target_config to NULL and schedule on_complete. </p>
</div>
</div>
<a class="anchor" id="aae02c9a384f3f2c2b598f56014caa211"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void grpc_resolver_ref </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structgrpc__resolver.html">grpc_resolver</a> * </td>
<td class="paramname"><em>policy</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="ae7b200016c3489c0bb3de525198b435b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void grpc_resolver_shutdown </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structgrpc__resolver.html">grpc_resolver</a> * </td>
<td class="paramname"><em>resolver</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a198c3f1a1ef2d6f40680436a2fcaa11d"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void grpc_resolver_unref </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structgrpc__resolver.html">grpc_resolver</a> * </td>
<td class="paramname"><em>policy</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</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>
|
