| <!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/tcp_server.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 |
|  <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_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">tcp_server.h</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| <a href="tcp__server_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> <span class="comment">/*</span></div> |
| <div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"> *</span></div> |
| <div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> * Copyright 2015, Google Inc.</span></div> |
| <div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> * All rights reserved.</span></div> |
| <div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> *</span></div> |
| <div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <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> <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> <span class="comment"> * met:</span></div> |
| <div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> *</span></div> |
| <div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <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> <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> <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> <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> <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> <span class="comment"> * distribution.</span></div> |
| <div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <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> <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> <span class="comment"> * this software without specific prior written permission.</span></div> |
| <div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment"> *</span></div> |
| <div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <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> <span class="comment"> * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT</span></div> |
| <div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <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> <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> <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> <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> <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> <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> <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> <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> <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> <span class="comment"> *</span></div> |
| <div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="comment"> */</span></div> |
| <div class="line"><a name="l00033"></a><span class="lineno"> 33</span> </div> |
| <div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="preprocessor">#ifndef GRPC_INTERNAL_CORE_IOMGR_TCP_SERVER_H</span></div> |
| <div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="preprocessor"></span><span class="preprocessor">#define GRPC_INTERNAL_CORE_IOMGR_TCP_SERVER_H</span></div> |
| <div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="preprocessor"></span></div> |
| <div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="preprocessor">#include "<a class="code" href="endpoint_8h.html">src/core/iomgr/endpoint.h</a>"</span></div> |
| <div class="line"><a name="l00038"></a><span class="lineno"> 38</span> </div> |
| <div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="comment">/* Forward decl of grpc_tcp_server */</span></div> |
| <div class="line"><a name="l00040"></a><span class="lineno"><a class="line" href="tcp__server_8h.html#a441eeedb58bf1fe1b656292b3c919e6d"> 40</a></span> <span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="tcp__server_8h.html#a441eeedb58bf1fe1b656292b3c919e6d">grpc_tcp_server</a> <a class="code" href="tcp__server_8h.html#a441eeedb58bf1fe1b656292b3c919e6d">grpc_tcp_server</a>;</div> |
| <div class="line"><a name="l00041"></a><span class="lineno"> 41</span> </div> |
| <div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="comment">/* New server callback: tcp is the newly connected tcp connection */</span></div> |
| <div class="line"><a name="l00043"></a><span class="lineno"><a class="line" href="tcp__server_8h.html#a78c33e7fded0e0a871be12e9f6c9a4c9"> 43</a></span> <span class="keyword">typedef</span> void (*<a class="code" href="tcp__server_8h.html#a78c33e7fded0e0a871be12e9f6c9a4c9">grpc_tcp_server_cb</a>)(<span class="keywordtype">void</span> *<a class="code" href="cmdline_8c.html#af240efb36795b416de0779ad5d5159e4">arg</a>, <a class="code" href="structgrpc__endpoint.html">grpc_endpoint</a> *ep);</div> |
| <div class="line"><a name="l00044"></a><span class="lineno"> 44</span> </div> |
| <div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="comment">/* Create a server, initially not bound to any ports */</span></div> |
| <div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <a class="code" href="tcp__server_8h.html#a441eeedb58bf1fe1b656292b3c919e6d">grpc_tcp_server</a> *<a class="code" href="tcp__server_8h.html#a9acd9c36ef686dd76283b1a92954aff0">grpc_tcp_server_create</a>(<span class="keywordtype">void</span>);</div> |
| <div class="line"><a name="l00047"></a><span class="lineno"> 47</span> </div> |
| <div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <span class="comment">/* Start listening to bound ports */</span></div> |
| <div class="line"><a name="l00049"></a><span class="lineno"> 49</span> <span class="keywordtype">void</span> <a class="code" href="tcp__server_8h.html#a552695c278adc52ba5433da5c57d5bd7">grpc_tcp_server_start</a>(<a class="code" href="tcp__server_8h.html#a441eeedb58bf1fe1b656292b3c919e6d">grpc_tcp_server</a> *server, <a class="code" href="structgrpc__pollset.html">grpc_pollset</a> **pollsets,</div> |
| <div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  <span class="keywordtype">size_t</span> pollset_count, <a class="code" href="tcp__server_8h.html#a78c33e7fded0e0a871be12e9f6c9a4c9">grpc_tcp_server_cb</a> cb,</div> |
| <div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  <span class="keywordtype">void</span> *cb_arg);</div> |
| <div class="line"><a name="l00052"></a><span class="lineno"> 52</span> </div> |
| <div class="line"><a name="l00053"></a><span class="lineno"> 53</span> <span class="comment">/* Add a port to the server, returning port number on success, or negative</span></div> |
| <div class="line"><a name="l00054"></a><span class="lineno"> 54</span> <span class="comment"> on failure.</span></div> |
| <div class="line"><a name="l00055"></a><span class="lineno"> 55</span> <span class="comment"></span></div> |
| <div class="line"><a name="l00056"></a><span class="lineno"> 56</span> <span class="comment"> The :: and 0.0.0.0 wildcard addresses are treated identically, accepting</span></div> |
| <div class="line"><a name="l00057"></a><span class="lineno"> 57</span> <span class="comment"> both IPv4 and IPv6 connections, but :: is the preferred style. This usually</span></div> |
| <div class="line"><a name="l00058"></a><span class="lineno"> 58</span> <span class="comment"> creates one socket, but possibly two on systems which support IPv6,</span></div> |
| <div class="line"><a name="l00059"></a><span class="lineno"> 59</span> <span class="comment"> but not dualstack sockets.</span></div> |
| <div class="line"><a name="l00060"></a><span class="lineno"> 60</span> <span class="comment"></span></div> |
| <div class="line"><a name="l00061"></a><span class="lineno"> 61</span> <span class="comment"> For raw access to the underlying sockets, see grpc_tcp_server_get_fd(). */</span></div> |
| <div class="line"><a name="l00062"></a><span class="lineno"> 62</span> <span class="comment">/* TODO(ctiller): deprecate this, and make grpc_tcp_server_add_ports to handle</span></div> |
| <div class="line"><a name="l00063"></a><span class="lineno"> 63</span> <span class="comment"> all of the multiple socket port matching logic in one place */</span></div> |
| <div class="line"><a name="l00064"></a><span class="lineno"> 64</span> <span class="keywordtype">int</span> <a class="code" href="tcp__server_8h.html#a59a2b20ad1fc958839512edd26a598ae">grpc_tcp_server_add_port</a>(<a class="code" href="tcp__server_8h.html#a441eeedb58bf1fe1b656292b3c919e6d">grpc_tcp_server</a> *s, <span class="keyword">const</span> <span class="keywordtype">void</span> *addr,</div> |
| <div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  <span class="keywordtype">int</span> addr_len);</div> |
| <div class="line"><a name="l00066"></a><span class="lineno"> 66</span> </div> |
| <div class="line"><a name="l00067"></a><span class="lineno"> 67</span> <span class="comment">/* Returns the file descriptor of the Nth listening socket on this server,</span></div> |
| <div class="line"><a name="l00068"></a><span class="lineno"> 68</span> <span class="comment"> or -1 if the index is out of bounds.</span></div> |
| <div class="line"><a name="l00069"></a><span class="lineno"> 69</span> <span class="comment"></span></div> |
| <div class="line"><a name="l00070"></a><span class="lineno"> 70</span> <span class="comment"> The file descriptor remains owned by the server, and will be cleaned</span></div> |
| <div class="line"><a name="l00071"></a><span class="lineno"> 71</span> <span class="comment"> up when grpc_tcp_server_destroy is called. */</span></div> |
| <div class="line"><a name="l00072"></a><span class="lineno"> 72</span> <span class="keywordtype">int</span> <a class="code" href="tcp__server_8h.html#afd39e961ac244633e016980551ac7ed3">grpc_tcp_server_get_fd</a>(<a class="code" href="tcp__server_8h.html#a441eeedb58bf1fe1b656292b3c919e6d">grpc_tcp_server</a> *s, <span class="keywordtype">unsigned</span> index);</div> |
| <div class="line"><a name="l00073"></a><span class="lineno"> 73</span> </div> |
| <div class="line"><a name="l00074"></a><span class="lineno"> 74</span> <span class="keywordtype">void</span> <a class="code" href="tcp__server_8h.html#a4c674f461e0b92ebd6bb358eac04b772">grpc_tcp_server_destroy</a>(<a class="code" href="tcp__server_8h.html#a441eeedb58bf1fe1b656292b3c919e6d">grpc_tcp_server</a> *server,</div> |
| <div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  <span class="keywordtype">void</span> (*shutdown_done)(<span class="keywordtype">void</span> *shutdown_done_arg),</div> |
| <div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  <span class="keywordtype">void</span> *shutdown_done_arg);</div> |
| <div class="line"><a name="l00077"></a><span class="lineno"> 77</span> </div> |
| <div class="line"><a name="l00078"></a><span class="lineno"> 78</span> <span class="preprocessor">#endif </span><span class="comment">/* GRPC_INTERNAL_CORE_IOMGR_TCP_SERVER_H */</span><span class="preprocessor"></span></div> |
| <div class="ttc" id="tcp__server_8h_html_a4c674f461e0b92ebd6bb358eac04b772"><div class="ttname"><a href="tcp__server_8h.html#a4c674f461e0b92ebd6bb358eac04b772">grpc_tcp_server_destroy</a></div><div class="ttdeci">void grpc_tcp_server_destroy(grpc_tcp_server *server, void(*shutdown_done)(void *shutdown_done_arg), void *shutdown_done_arg)</div></div> |
| <div class="ttc" id="tcp__server_8h_html_a9acd9c36ef686dd76283b1a92954aff0"><div class="ttname"><a href="tcp__server_8h.html#a9acd9c36ef686dd76283b1a92954aff0">grpc_tcp_server_create</a></div><div class="ttdeci">grpc_tcp_server * grpc_tcp_server_create(void)</div></div> |
| <div class="ttc" id="structgrpc__pollset_html"><div class="ttname"><a href="structgrpc__pollset.html">grpc_pollset</a></div><div class="ttdef"><b>Definition:</b> pollset_posix.h:48</div></div> |
| <div class="ttc" id="tcp__server_8h_html_a78c33e7fded0e0a871be12e9f6c9a4c9"><div class="ttname"><a href="tcp__server_8h.html#a78c33e7fded0e0a871be12e9f6c9a4c9">grpc_tcp_server_cb</a></div><div class="ttdeci">void(* grpc_tcp_server_cb)(void *arg, grpc_endpoint *ep)</div><div class="ttdef"><b>Definition:</b> tcp_server.h:43</div></div> |
| <div class="ttc" id="tcp__server_8h_html_a552695c278adc52ba5433da5c57d5bd7"><div class="ttname"><a href="tcp__server_8h.html#a552695c278adc52ba5433da5c57d5bd7">grpc_tcp_server_start</a></div><div class="ttdeci">void grpc_tcp_server_start(grpc_tcp_server *server, grpc_pollset **pollsets, size_t pollset_count, grpc_tcp_server_cb cb, void *cb_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__endpoint_html"><div class="ttname"><a href="structgrpc__endpoint.html">grpc_endpoint</a></div><div class="ttdef"><b>Definition:</b> endpoint.h:108</div></div> |
| <div class="ttc" id="endpoint_8h_html"><div class="ttname"><a href="endpoint_8h.html">endpoint.h</a></div></div> |
| <div class="ttc" id="tcp__server_8h_html_a441eeedb58bf1fe1b656292b3c919e6d"><div class="ttname"><a href="tcp__server_8h.html#a441eeedb58bf1fe1b656292b3c919e6d">grpc_tcp_server</a></div><div class="ttdeci">struct grpc_tcp_server grpc_tcp_server</div><div class="ttdef"><b>Definition:</b> tcp_server.h:40</div></div> |
| <div class="ttc" id="tcp__server_8h_html_afd39e961ac244633e016980551ac7ed3"><div class="ttname"><a href="tcp__server_8h.html#afd39e961ac244633e016980551ac7ed3">grpc_tcp_server_get_fd</a></div><div class="ttdeci">int grpc_tcp_server_get_fd(grpc_tcp_server *s, unsigned index)</div></div> |
| <div class="ttc" id="tcp__server_8h_html_a59a2b20ad1fc958839512edd26a598ae"><div class="ttname"><a href="tcp__server_8h.html#a59a2b20ad1fc958839512edd26a598ae">grpc_tcp_server_add_port</a></div><div class="ttdeci">int grpc_tcp_server_add_port(grpc_tcp_server *s, const void *addr, int addr_len)</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  <a href="http://www.doxygen.org/index.html"> |
| <img class="footer" src="doxygen.png" alt="doxygen"/> |
| </a> 1.8.6 |
| </small></address> |
| </body> |
| </html> |