classgrpc_1_1_server_builder.html 19 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  2. <html xmlns="http://www.w3.org/1999/xhtml">
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  5. <meta http-equiv="X-UA-Compatible" content="IE=9"/>
  6. <meta name="generator" content="Doxygen 1.8.6"/>
  7. <title>GRPC C++: grpc::ServerBuilder Class Reference</title>
  8. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  9. <script type="text/javascript" src="jquery.js"></script>
  10. <script type="text/javascript" src="dynsections.js"></script>
  11. <link href="search/search.css" rel="stylesheet" type="text/css"/>
  12. <script type="text/javascript" src="search/search.js"></script>
  13. <script type="text/javascript">
  14. $(document).ready(function() { searchBox.OnSelectItem(0); });
  15. </script>
  16. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  17. </head>
  18. <body>
  19. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  20. <div id="titlearea">
  21. <table cellspacing="0" cellpadding="0">
  22. <tbody>
  23. <tr style="height: 56px;">
  24. <td style="padding-left: 0.5em;">
  25. <div id="projectname">GRPC C++
  26. &#160;<span id="projectnumber">0.10.0.0</span>
  27. </div>
  28. </td>
  29. </tr>
  30. </tbody>
  31. </table>
  32. </div>
  33. <!-- end header part -->
  34. <!-- Generated by Doxygen 1.8.6 -->
  35. <script type="text/javascript">
  36. var searchBox = new SearchBox("searchBox", "search",false,'Search');
  37. </script>
  38. <div id="navrow1" class="tabs">
  39. <ul class="tablist">
  40. <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  41. <li><a href="namespaces.html"><span>Namespaces</span></a></li>
  42. <li class="current"><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
  43. <li><a href="files.html"><span>Files</span></a></li>
  44. <li>
  45. <div id="MSearchBox" class="MSearchBoxInactive">
  46. <span class="left">
  47. <img id="MSearchSelect" src="search/mag_sel.png"
  48. onmouseover="return searchBox.OnSearchSelectShow()"
  49. onmouseout="return searchBox.OnSearchSelectHide()"
  50. alt=""/>
  51. <input type="text" id="MSearchField" value="Search" accesskey="S"
  52. onfocus="searchBox.OnSearchFieldFocus(true)"
  53. onblur="searchBox.OnSearchFieldFocus(false)"
  54. onkeyup="searchBox.OnSearchFieldChange(event)"/>
  55. </span><span class="right">
  56. <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
  57. </span>
  58. </div>
  59. </li>
  60. </ul>
  61. </div>
  62. <div id="navrow2" class="tabs2">
  63. <ul class="tablist">
  64. <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
  65. <li><a href="classes.html"><span>Data&#160;Structure&#160;Index</span></a></li>
  66. <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
  67. <li><a href="functions.html"><span>Data&#160;Fields</span></a></li>
  68. </ul>
  69. </div>
  70. <!-- window showing the filter options -->
  71. <div id="MSearchSelectWindow"
  72. onmouseover="return searchBox.OnSearchSelectShow()"
  73. onmouseout="return searchBox.OnSearchSelectHide()"
  74. onkeydown="return searchBox.OnSearchSelectKey(event)">
  75. <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>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark">&#160;</span>Macros</a></div>
  76. <!-- iframe showing the search results (closed by default) -->
  77. <div id="MSearchResultsWindow">
  78. <iframe src="javascript:void(0)" frameborder="0"
  79. name="MSearchResults" id="MSearchResults">
  80. </iframe>
  81. </div>
  82. <div id="nav-path" class="navpath">
  83. <ul>
  84. <li class="navelem"><a class="el" href="namespacegrpc.html">grpc</a></li><li class="navelem"><a class="el" href="classgrpc_1_1_server_builder.html">ServerBuilder</a></li> </ul>
  85. </div>
  86. </div><!-- top -->
  87. <div class="header">
  88. <div class="summary">
  89. <a href="#nested-classes">Data Structures</a> &#124;
  90. <a href="#pub-methods">Public Member Functions</a> </div>
  91. <div class="headertitle">
  92. <div class="title">grpc::ServerBuilder Class Reference</div> </div>
  93. </div><!--header-->
  94. <div class="contents">
  95. <p><code>#include &lt;<a class="el" href="server__builder_8h_source.html">server_builder.h</a>&gt;</code></p>
  96. <table class="memberdecls">
  97. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  98. Public Member Functions</h2></td></tr>
  99. <tr class="memitem:a208346e343cd01351492f0cace59b242"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_builder.html#a208346e343cd01351492f0cace59b242">ServerBuilder</a> ()</td></tr>
  100. <tr class="separator:a208346e343cd01351492f0cace59b242"><td class="memSeparator" colspan="2">&#160;</td></tr>
  101. <tr class="memitem:a40f39b2ac8224a91c426b0e75bbb3c66"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_builder.html#a40f39b2ac8224a91c426b0e75bbb3c66">RegisterService</a> (<a class="el" href="classgrpc_1_1_synchronous_service.html">SynchronousService</a> *service)</td></tr>
  102. <tr class="separator:a40f39b2ac8224a91c426b0e75bbb3c66"><td class="memSeparator" colspan="2">&#160;</td></tr>
  103. <tr class="memitem:a2da69a943b10839d6993f9b292aaf578"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_builder.html#a2da69a943b10839d6993f9b292aaf578">RegisterAsyncService</a> (<a class="el" href="classgrpc_1_1_asynchronous_service.html">AsynchronousService</a> *service)</td></tr>
  104. <tr class="separator:a2da69a943b10839d6993f9b292aaf578"><td class="memSeparator" colspan="2">&#160;</td></tr>
  105. <tr class="memitem:ac62b0aa4c0448907e02d15386d58ef86"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_builder.html#ac62b0aa4c0448907e02d15386d58ef86">RegisterAsyncGenericService</a> (<a class="el" href="classgrpc_1_1_async_generic_service.html">AsyncGenericService</a> *service)</td></tr>
  106. <tr class="separator:ac62b0aa4c0448907e02d15386d58ef86"><td class="memSeparator" colspan="2">&#160;</td></tr>
  107. <tr class="memitem:ad961d91042fe44aa38fa3e1d57120861"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_builder.html#ad961d91042fe44aa38fa3e1d57120861">RegisterService</a> (const <a class="el" href="namespacegrpc.html#ab04a87625da3bf85cdaf5e7856b00203">grpc::string</a> &amp;host, <a class="el" href="classgrpc_1_1_synchronous_service.html">SynchronousService</a> *service)</td></tr>
  108. <tr class="separator:ad961d91042fe44aa38fa3e1d57120861"><td class="memSeparator" colspan="2">&#160;</td></tr>
  109. <tr class="memitem:a2107596214baf71230f4f270dec1d064"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_builder.html#a2107596214baf71230f4f270dec1d064">RegisterAsyncService</a> (const <a class="el" href="namespacegrpc.html#ab04a87625da3bf85cdaf5e7856b00203">grpc::string</a> &amp;host, <a class="el" href="classgrpc_1_1_asynchronous_service.html">AsynchronousService</a> *service)</td></tr>
  110. <tr class="separator:a2107596214baf71230f4f270dec1d064"><td class="memSeparator" colspan="2">&#160;</td></tr>
  111. <tr class="memitem:ae1e6314004fba16607b883b8cc81f5c9"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_builder.html#ae1e6314004fba16607b883b8cc81f5c9">SetMaxMessageSize</a> (int max_message_size)</td></tr>
  112. <tr class="separator:ae1e6314004fba16607b883b8cc81f5c9"><td class="memSeparator" colspan="2">&#160;</td></tr>
  113. <tr class="memitem:a256e035e62b43cd79137abf7c066902a"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_builder.html#a256e035e62b43cd79137abf7c066902a">AddListeningPort</a> (const <a class="el" href="namespacegrpc.html#ab04a87625da3bf85cdaf5e7856b00203">grpc::string</a> &amp;addr, std::shared_ptr&lt; <a class="el" href="classgrpc_1_1_server_credentials.html">ServerCredentials</a> &gt; creds, int *selected_port=nullptr)</td></tr>
  114. <tr class="separator:a256e035e62b43cd79137abf7c066902a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  115. <tr class="memitem:aea5dd313149029114c60571e5ee8b4cd"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_builder.html#aea5dd313149029114c60571e5ee8b4cd">SetThreadPool</a> (<a class="el" href="classgrpc_1_1_thread_pool_interface.html">ThreadPoolInterface</a> *thread_pool)</td></tr>
  116. <tr class="separator:aea5dd313149029114c60571e5ee8b4cd"><td class="memSeparator" colspan="2">&#160;</td></tr>
  117. <tr class="memitem:accbbd95080ca974e84fa1d4cb2ea9518"><td class="memItemLeft" align="right" valign="top">std::unique_ptr<br class="typebreak"/>
  118. &lt; <a class="el" href="classgrpc_1_1_server_completion_queue.html">ServerCompletionQueue</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_builder.html#accbbd95080ca974e84fa1d4cb2ea9518">AddCompletionQueue</a> ()</td></tr>
  119. <tr class="separator:accbbd95080ca974e84fa1d4cb2ea9518"><td class="memSeparator" colspan="2">&#160;</td></tr>
  120. <tr class="memitem:af284cd39b185043e8e92405c1ae0f310"><td class="memItemLeft" align="right" valign="top">std::unique_ptr&lt; <a class="el" href="classgrpc_1_1_server.html">Server</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_builder.html#af284cd39b185043e8e92405c1ae0f310">BuildAndStart</a> ()</td></tr>
  121. <tr class="separator:af284cd39b185043e8e92405c1ae0f310"><td class="memSeparator" colspan="2">&#160;</td></tr>
  122. </table>
  123. <h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
  124. <a class="anchor" id="a208346e343cd01351492f0cace59b242"></a>
  125. <div class="memitem">
  126. <div class="memproto">
  127. <table class="memname">
  128. <tr>
  129. <td class="memname">grpc::ServerBuilder::ServerBuilder </td>
  130. <td>(</td>
  131. <td class="paramname"></td><td>)</td>
  132. <td></td>
  133. </tr>
  134. </table>
  135. </div><div class="memdoc">
  136. </div>
  137. </div>
  138. <h2 class="groupheader">Member Function Documentation</h2>
  139. <a class="anchor" id="accbbd95080ca974e84fa1d4cb2ea9518"></a>
  140. <div class="memitem">
  141. <div class="memproto">
  142. <table class="memname">
  143. <tr>
  144. <td class="memname">std::unique_ptr&lt;<a class="el" href="classgrpc_1_1_server_completion_queue.html">ServerCompletionQueue</a>&gt; grpc::ServerBuilder::AddCompletionQueue </td>
  145. <td>(</td>
  146. <td class="paramname"></td><td>)</td>
  147. <td></td>
  148. </tr>
  149. </table>
  150. </div><div class="memdoc">
  151. </div>
  152. </div>
  153. <a class="anchor" id="a256e035e62b43cd79137abf7c066902a"></a>
  154. <div class="memitem">
  155. <div class="memproto">
  156. <table class="memname">
  157. <tr>
  158. <td class="memname">void grpc::ServerBuilder::AddListeningPort </td>
  159. <td>(</td>
  160. <td class="paramtype">const <a class="el" href="namespacegrpc.html#ab04a87625da3bf85cdaf5e7856b00203">grpc::string</a> &amp;&#160;</td>
  161. <td class="paramname"><em>addr</em>, </td>
  162. </tr>
  163. <tr>
  164. <td class="paramkey"></td>
  165. <td></td>
  166. <td class="paramtype">std::shared_ptr&lt; <a class="el" href="classgrpc_1_1_server_credentials.html">ServerCredentials</a> &gt;&#160;</td>
  167. <td class="paramname"><em>creds</em>, </td>
  168. </tr>
  169. <tr>
  170. <td class="paramkey"></td>
  171. <td></td>
  172. <td class="paramtype">int *&#160;</td>
  173. <td class="paramname"><em>selected_port</em> = <code>nullptr</code>&#160;</td>
  174. </tr>
  175. <tr>
  176. <td></td>
  177. <td>)</td>
  178. <td></td><td></td>
  179. </tr>
  180. </table>
  181. </div><div class="memdoc">
  182. </div>
  183. </div>
  184. <a class="anchor" id="af284cd39b185043e8e92405c1ae0f310"></a>
  185. <div class="memitem">
  186. <div class="memproto">
  187. <table class="memname">
  188. <tr>
  189. <td class="memname">std::unique_ptr&lt;<a class="el" href="classgrpc_1_1_server.html">Server</a>&gt; grpc::ServerBuilder::BuildAndStart </td>
  190. <td>(</td>
  191. <td class="paramname"></td><td>)</td>
  192. <td></td>
  193. </tr>
  194. </table>
  195. </div><div class="memdoc">
  196. </div>
  197. </div>
  198. <a class="anchor" id="ac62b0aa4c0448907e02d15386d58ef86"></a>
  199. <div class="memitem">
  200. <div class="memproto">
  201. <table class="memname">
  202. <tr>
  203. <td class="memname">void grpc::ServerBuilder::RegisterAsyncGenericService </td>
  204. <td>(</td>
  205. <td class="paramtype"><a class="el" href="classgrpc_1_1_async_generic_service.html">AsyncGenericService</a> *&#160;</td>
  206. <td class="paramname"><em>service</em></td><td>)</td>
  207. <td></td>
  208. </tr>
  209. </table>
  210. </div><div class="memdoc">
  211. </div>
  212. </div>
  213. <a class="anchor" id="a2da69a943b10839d6993f9b292aaf578"></a>
  214. <div class="memitem">
  215. <div class="memproto">
  216. <table class="memname">
  217. <tr>
  218. <td class="memname">void grpc::ServerBuilder::RegisterAsyncService </td>
  219. <td>(</td>
  220. <td class="paramtype"><a class="el" href="classgrpc_1_1_asynchronous_service.html">AsynchronousService</a> *&#160;</td>
  221. <td class="paramname"><em>service</em></td><td>)</td>
  222. <td></td>
  223. </tr>
  224. </table>
  225. </div><div class="memdoc">
  226. </div>
  227. </div>
  228. <a class="anchor" id="a2107596214baf71230f4f270dec1d064"></a>
  229. <div class="memitem">
  230. <div class="memproto">
  231. <table class="memname">
  232. <tr>
  233. <td class="memname">void grpc::ServerBuilder::RegisterAsyncService </td>
  234. <td>(</td>
  235. <td class="paramtype">const <a class="el" href="namespacegrpc.html#ab04a87625da3bf85cdaf5e7856b00203">grpc::string</a> &amp;&#160;</td>
  236. <td class="paramname"><em>host</em>, </td>
  237. </tr>
  238. <tr>
  239. <td class="paramkey"></td>
  240. <td></td>
  241. <td class="paramtype"><a class="el" href="classgrpc_1_1_asynchronous_service.html">AsynchronousService</a> *&#160;</td>
  242. <td class="paramname"><em>service</em>&#160;</td>
  243. </tr>
  244. <tr>
  245. <td></td>
  246. <td>)</td>
  247. <td></td><td></td>
  248. </tr>
  249. </table>
  250. </div><div class="memdoc">
  251. </div>
  252. </div>
  253. <a class="anchor" id="a40f39b2ac8224a91c426b0e75bbb3c66"></a>
  254. <div class="memitem">
  255. <div class="memproto">
  256. <table class="memname">
  257. <tr>
  258. <td class="memname">void grpc::ServerBuilder::RegisterService </td>
  259. <td>(</td>
  260. <td class="paramtype"><a class="el" href="classgrpc_1_1_synchronous_service.html">SynchronousService</a> *&#160;</td>
  261. <td class="paramname"><em>service</em></td><td>)</td>
  262. <td></td>
  263. </tr>
  264. </table>
  265. </div><div class="memdoc">
  266. </div>
  267. </div>
  268. <a class="anchor" id="ad961d91042fe44aa38fa3e1d57120861"></a>
  269. <div class="memitem">
  270. <div class="memproto">
  271. <table class="memname">
  272. <tr>
  273. <td class="memname">void grpc::ServerBuilder::RegisterService </td>
  274. <td>(</td>
  275. <td class="paramtype">const <a class="el" href="namespacegrpc.html#ab04a87625da3bf85cdaf5e7856b00203">grpc::string</a> &amp;&#160;</td>
  276. <td class="paramname"><em>host</em>, </td>
  277. </tr>
  278. <tr>
  279. <td class="paramkey"></td>
  280. <td></td>
  281. <td class="paramtype"><a class="el" href="classgrpc_1_1_synchronous_service.html">SynchronousService</a> *&#160;</td>
  282. <td class="paramname"><em>service</em>&#160;</td>
  283. </tr>
  284. <tr>
  285. <td></td>
  286. <td>)</td>
  287. <td></td><td></td>
  288. </tr>
  289. </table>
  290. </div><div class="memdoc">
  291. </div>
  292. </div>
  293. <a class="anchor" id="ae1e6314004fba16607b883b8cc81f5c9"></a>
  294. <div class="memitem">
  295. <div class="memproto">
  296. <table class="mlabels">
  297. <tr>
  298. <td class="mlabels-left">
  299. <table class="memname">
  300. <tr>
  301. <td class="memname">void grpc::ServerBuilder::SetMaxMessageSize </td>
  302. <td>(</td>
  303. <td class="paramtype">int&#160;</td>
  304. <td class="paramname"><em>max_message_size</em></td><td>)</td>
  305. <td></td>
  306. </tr>
  307. </table>
  308. </td>
  309. <td class="mlabels-right">
  310. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  311. </tr>
  312. </table>
  313. </div><div class="memdoc">
  314. </div>
  315. </div>
  316. <a class="anchor" id="aea5dd313149029114c60571e5ee8b4cd"></a>
  317. <div class="memitem">
  318. <div class="memproto">
  319. <table class="memname">
  320. <tr>
  321. <td class="memname">void grpc::ServerBuilder::SetThreadPool </td>
  322. <td>(</td>
  323. <td class="paramtype"><a class="el" href="classgrpc_1_1_thread_pool_interface.html">ThreadPoolInterface</a> *&#160;</td>
  324. <td class="paramname"><em>thread_pool</em></td><td>)</td>
  325. <td></td>
  326. </tr>
  327. </table>
  328. </div><div class="memdoc">
  329. </div>
  330. </div>
  331. <hr/>The documentation for this class was generated from the following file:<ul>
  332. <li>include/grpc++/<a class="el" href="server__builder_8h_source.html">server_builder.h</a></li>
  333. </ul>
  334. </div><!-- contents -->
  335. <!-- start footer part -->
  336. <hr class="footer"/><address class="footer"><small>
  337. Generated on Wed Aug 5 2015 08:17:06 for GRPC C++ by &#160;<a href="http://www.doxygen.org/index.html">
  338. <img class="footer" src="doxygen.png" alt="doxygen"/>
  339. </a> 1.8.6
  340. </small></address>
  341. </body>
  342. </html>