blob: f111850bca6b702cce0b06e6d9e0e6e6cb4a1eb9 [file] [log] [blame]
<!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/iomgr/resolve_address.h Source File</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.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&#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_3f1a464cbd6442b4d6b6ee306c9b0460.html">iomgr</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">resolve_address.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="resolve__address_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="comment">/*</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment"> * Copyright 2015, Google Inc.</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="comment"> * All rights reserved.</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="comment"> * Redistribution and use in source and binary forms, with or without</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="comment"> * modification, are permitted provided that the following conditions are</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="comment"> * met:</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="comment"> * * Redistributions of source code must retain the above copyright</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="comment"> * notice, this list of conditions and the following disclaimer.</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="comment"> * * Redistributions in binary form must reproduce the above</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="comment"> * copyright notice, this list of conditions and the following disclaimer</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="comment"> * in the documentation and/or other materials provided with the</span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="comment"> * distribution.</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="comment"> * * Neither the name of Google Inc. nor the names of its</span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;<span class="comment"> * contributors may be used to endorse or promote products derived from</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;<span class="comment"> * this software without specific prior written permission.</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;<span class="comment"> * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS</span></div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;<span class="comment"> * &quot;AS IS&quot; AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT</span></div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;<span class="comment"> * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR</span></div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;<span class="comment"> * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT</span></div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;<span class="comment"> * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,</span></div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;<span class="comment"> * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT</span></div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;<span class="comment"> * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,</span></div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160;<span class="comment"> * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY</span></div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;<span class="comment"> * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT</span></div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160;<span class="comment"> * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE</span></div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160;<span class="comment"> * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.</span></div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160;</div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160;<span class="preprocessor">#ifndef GRPC_INTERNAL_CORE_IOMGR_RESOLVE_ADDRESS_H</span></div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160;<span class="preprocessor"></span><span class="preprocessor">#define GRPC_INTERNAL_CORE_IOMGR_RESOLVE_ADDRESS_H</span></div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160;<span class="preprocessor"></span></div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160;<span class="preprocessor">#include &lt;stddef.h&gt;</span></div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160;</div>
<div class="line"><a name="l00039"></a><span class="lineno"><a class="line" href="resolve__address_8h.html#aa9cd304afa2c2f9757531c4b2a8168b6"> 39</a></span>&#160;<span class="preprocessor">#define GRPC_MAX_SOCKADDR_SIZE 128</span></div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160;<span class="preprocessor"></span></div>
<div class="line"><a name="l00041"></a><span class="lineno"><a class="line" href="structgrpc__resolved__address.html"> 41</a></span>&#160;<span class="keyword">typedef</span> <span class="keyword">struct </span>{</div>
<div class="line"><a name="l00042"></a><span class="lineno"><a class="line" href="structgrpc__resolved__address.html#a664035b0fc073c4a49f5e7c1cc765c9d"> 42</a></span>&#160; <span class="keywordtype">char</span> addr[<a class="code" href="resolve__address_8h.html#aa9cd304afa2c2f9757531c4b2a8168b6">GRPC_MAX_SOCKADDR_SIZE</a>];</div>
<div class="line"><a name="l00043"></a><span class="lineno"><a class="line" href="structgrpc__resolved__address.html#ad4f8c294fc0bf15ea680a153d100cc56"> 43</a></span>&#160; <span class="keywordtype">int</span> <a class="code" href="structgrpc__resolved__address.html#ad4f8c294fc0bf15ea680a153d100cc56">len</a>;</div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160;} <a class="code" href="structgrpc__resolved__address.html">grpc_resolved_address</a>;</div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160;</div>
<div class="line"><a name="l00046"></a><span class="lineno"><a class="line" href="structgrpc__resolved__addresses.html"> 46</a></span>&#160;<span class="keyword">typedef</span> <span class="keyword">struct </span>{</div>
<div class="line"><a name="l00047"></a><span class="lineno"><a class="line" href="structgrpc__resolved__addresses.html#a5bad86b3646502cd70807ff2000f6af8"> 47</a></span>&#160; <span class="keywordtype">size_t</span> <a class="code" href="structgrpc__resolved__addresses.html#a5bad86b3646502cd70807ff2000f6af8">naddrs</a>;</div>
<div class="line"><a name="l00048"></a><span class="lineno"><a class="line" href="structgrpc__resolved__addresses.html#afdf4d95430fcf478a164c665d71e913c"> 48</a></span>&#160; <a class="code" href="structgrpc__resolved__address.html">grpc_resolved_address</a> *<a class="code" href="structgrpc__resolved__addresses.html#afdf4d95430fcf478a164c665d71e913c">addrs</a>;</div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160;} <a class="code" href="structgrpc__resolved__addresses.html">grpc_resolved_addresses</a>;</div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160;</div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160;<span class="comment">/* Async result callback:</span></div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160;<span class="comment"> On success: addresses is the result, and the callee must call</span></div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160;<span class="comment"> grpc_resolved_addresses_destroy when it&#39;s done with them</span></div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160;<span class="comment"> On failure: addresses is NULL */</span></div>
<div class="line"><a name="l00055"></a><span class="lineno"><a class="line" href="resolve__address_8h.html#acac9db416b80e9bc82bbd0e1408cc3e0"> 55</a></span>&#160;<span class="keyword">typedef</span> void (*<a class="code" href="resolve__address_8h.html#acac9db416b80e9bc82bbd0e1408cc3e0">grpc_resolve_cb</a>)(<span class="keywordtype">void</span> *<a class="code" href="cmdline_8c.html#af240efb36795b416de0779ad5d5159e4">arg</a>, <a class="code" href="structgrpc__resolved__addresses.html">grpc_resolved_addresses</a> *addresses);</div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160;<span class="comment">/* Asynchronously resolve addr. Use default_port if a port isn&#39;t designated</span></div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160;<span class="comment"> in addr, otherwise use the port in addr. */</span></div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160;<span class="comment">/* TODO(ctiller): add a timeout here */</span></div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160;<span class="keywordtype">void</span> <a class="code" href="resolve__address_8h.html#ad97dcf547d9b690a9a7de340a84391ea">grpc_resolve_address</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *addr, <span class="keyword">const</span> <span class="keywordtype">char</span> *default_port,</div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160; <a class="code" href="resolve__address_8h.html#acac9db416b80e9bc82bbd0e1408cc3e0">grpc_resolve_cb</a> cb, <span class="keywordtype">void</span> *<a class="code" href="structarg.html">arg</a>);</div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160;<span class="comment">/* Destroy resolved addresses */</span></div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160;<span class="keywordtype">void</span> <a class="code" href="resolve__address_8h.html#affdc0f6f10389f1a19db7a5edb527b7c">grpc_resolved_addresses_destroy</a>(<a class="code" href="structgrpc__resolved__addresses.html">grpc_resolved_addresses</a> *addresses);</div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160;</div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160;<span class="comment">/* Resolve addr in a blocking fashion. Returns NULL on failure. On success,</span></div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160;<span class="comment"> result must be freed with grpc_resolved_addresses_destroy. */</span></div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160;<a class="code" href="structgrpc__resolved__addresses.html">grpc_resolved_addresses</a> *<a class="code" href="resolve__address_8h.html#a92567a2b60cddf219f240a07212fff7c">grpc_blocking_resolve_address</a>(</div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160; <span class="keyword">const</span> <span class="keywordtype">char</span> *addr, <span class="keyword">const</span> <span class="keywordtype">char</span> *default_port);</div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160;</div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160;<span class="preprocessor">#endif </span><span class="comment">/* GRPC_INTERNAL_CORE_IOMGR_RESOLVE_ADDRESS_H */</span><span class="preprocessor"></span></div>
<div class="ttc" id="resolve__address_8h_html_a92567a2b60cddf219f240a07212fff7c"><div class="ttname"><a href="resolve__address_8h.html#a92567a2b60cddf219f240a07212fff7c">grpc_blocking_resolve_address</a></div><div class="ttdeci">grpc_resolved_addresses * grpc_blocking_resolve_address(const char *addr, const char *default_port)</div></div>
<div class="ttc" id="structgrpc__resolved__address_html"><div class="ttname"><a href="structgrpc__resolved__address.html">grpc_resolved_address</a></div><div class="ttdef"><b>Definition:</b> resolve_address.h:41</div></div>
<div class="ttc" id="resolve__address_8h_html_acac9db416b80e9bc82bbd0e1408cc3e0"><div class="ttname"><a href="resolve__address_8h.html#acac9db416b80e9bc82bbd0e1408cc3e0">grpc_resolve_cb</a></div><div class="ttdeci">void(* grpc_resolve_cb)(void *arg, grpc_resolved_addresses *addresses)</div><div class="ttdef"><b>Definition:</b> resolve_address.h:55</div></div>
<div class="ttc" id="structgrpc__resolved__addresses_html"><div class="ttname"><a href="structgrpc__resolved__addresses.html">grpc_resolved_addresses</a></div><div class="ttdef"><b>Definition:</b> resolve_address.h:46</div></div>
<div class="ttc" id="structarg_html"><div class="ttname"><a href="structarg.html">arg</a></div><div class="ttdef"><b>Definition:</b> cmdline.c:47</div></div>
<div class="ttc" id="structgrpc__resolved__addresses_html_afdf4d95430fcf478a164c665d71e913c"><div class="ttname"><a href="structgrpc__resolved__addresses.html#afdf4d95430fcf478a164c665d71e913c">grpc_resolved_addresses::addrs</a></div><div class="ttdeci">grpc_resolved_address * addrs</div><div class="ttdef"><b>Definition:</b> resolve_address.h:48</div></div>
<div class="ttc" id="structgrpc__resolved__address_html_ad4f8c294fc0bf15ea680a153d100cc56"><div class="ttname"><a href="structgrpc__resolved__address.html#ad4f8c294fc0bf15ea680a153d100cc56">grpc_resolved_address::len</a></div><div class="ttdeci">int len</div><div class="ttdef"><b>Definition:</b> resolve_address.h:43</div></div>
<div class="ttc" id="resolve__address_8h_html_ad97dcf547d9b690a9a7de340a84391ea"><div class="ttname"><a href="resolve__address_8h.html#ad97dcf547d9b690a9a7de340a84391ea">grpc_resolve_address</a></div><div class="ttdeci">void grpc_resolve_address(const char *addr, const char *default_port, grpc_resolve_cb cb, void *arg)</div></div>
<div class="ttc" id="cmdline_8c_html_af240efb36795b416de0779ad5d5159e4"><div class="ttname"><a href="cmdline_8c.html#af240efb36795b416de0779ad5d5159e4">arg</a></div><div class="ttdeci">struct arg arg</div></div>
<div class="ttc" id="structgrpc__resolved__addresses_html_a5bad86b3646502cd70807ff2000f6af8"><div class="ttname"><a href="structgrpc__resolved__addresses.html#a5bad86b3646502cd70807ff2000f6af8">grpc_resolved_addresses::naddrs</a></div><div class="ttdeci">size_t naddrs</div><div class="ttdef"><b>Definition:</b> resolve_address.h:47</div></div>
<div class="ttc" id="resolve__address_8h_html_aa9cd304afa2c2f9757531c4b2a8168b6"><div class="ttname"><a href="resolve__address_8h.html#aa9cd304afa2c2f9757531c4b2a8168b6">GRPC_MAX_SOCKADDR_SIZE</a></div><div class="ttdeci">#define GRPC_MAX_SOCKADDR_SIZE</div><div class="ttdef"><b>Definition:</b> resolve_address.h:39</div></div>
<div class="ttc" id="resolve__address_8h_html_affdc0f6f10389f1a19db7a5edb527b7c"><div class="ttname"><a href="resolve__address_8h.html#affdc0f6f10389f1a19db7a5edb527b7c">grpc_resolved_addresses_destroy</a></div><div class="ttdeci">void grpc_resolved_addresses_destroy(grpc_resolved_addresses *addresses)</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Wed Aug 5 2015 08:17:07 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>