structgrpc__arg.html 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231
  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 Core: grpc_arg Struct 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 Core
  26. &#160;<span id="projectnumber">0.13.1-pre1</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 class="current"><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
  42. <li><a href="files.html"><span>Files</span></a></li>
  43. <li>
  44. <div id="MSearchBox" class="MSearchBoxInactive">
  45. <span class="left">
  46. <img id="MSearchSelect" src="search/mag_sel.png"
  47. onmouseover="return searchBox.OnSearchSelectShow()"
  48. onmouseout="return searchBox.OnSearchSelectHide()"
  49. alt=""/>
  50. <input type="text" id="MSearchField" value="Search" accesskey="S"
  51. onfocus="searchBox.OnSearchFieldFocus(true)"
  52. onblur="searchBox.OnSearchFieldFocus(false)"
  53. onkeyup="searchBox.OnSearchFieldChange(event)"/>
  54. </span><span class="right">
  55. <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
  56. </span>
  57. </div>
  58. </li>
  59. </ul>
  60. </div>
  61. <div id="navrow2" class="tabs2">
  62. <ul class="tablist">
  63. <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
  64. <li><a href="classes.html"><span>Data&#160;Structure&#160;Index</span></a></li>
  65. <li><a href="functions.html"><span>Data&#160;Fields</span></a></li>
  66. </ul>
  67. </div>
  68. <!-- window showing the filter options -->
  69. <div id="MSearchSelectWindow"
  70. onmouseover="return searchBox.OnSearchSelectShow()"
  71. onmouseout="return searchBox.OnSearchSelectHide()"
  72. onkeydown="return searchBox.OnSearchSelectKey(event)">
  73. <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>
  74. <!-- iframe showing the search results (closed by default) -->
  75. <div id="MSearchResultsWindow">
  76. <iframe src="javascript:void(0)" frameborder="0"
  77. name="MSearchResults" id="MSearchResults">
  78. </iframe>
  79. </div>
  80. </div><!-- top -->
  81. <div class="header">
  82. <div class="summary">
  83. <a href="#pub-attribs">Data Fields</a> </div>
  84. <div class="headertitle">
  85. <div class="title">grpc_arg Struct Reference</div> </div>
  86. </div><!--header-->
  87. <div class="contents">
  88. <p>A single argument...
  89. <a href="structgrpc__arg.html#details">More...</a></p>
  90. <p><code>#include &lt;<a class="el" href="grpc__types_8h_source.html">grpc_types.h</a>&gt;</code></p>
  91. <table class="memberdecls">
  92. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
  93. Data Fields</h2></td></tr>
  94. <tr class="memitem:aa26f2d3c4b1649c9eb061d24a8c10fd4"><td class="memItemLeft" align="right" valign="top"><a class="el" href="grpc__types_8h.html#a0b06eae05e70404aedbceaebce6de593">grpc_arg_type</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structgrpc__arg.html#aa26f2d3c4b1649c9eb061d24a8c10fd4">type</a></td></tr>
  95. <tr class="separator:aa26f2d3c4b1649c9eb061d24a8c10fd4"><td class="memSeparator" colspan="2">&#160;</td></tr>
  96. <tr class="memitem:aeb230fbd50daacfe654abc3500a44968"><td class="memItemLeft" align="right" valign="top">char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structgrpc__arg.html#aeb230fbd50daacfe654abc3500a44968">key</a></td></tr>
  97. <tr class="separator:aeb230fbd50daacfe654abc3500a44968"><td class="memSeparator" colspan="2">&#160;</td></tr>
  98. <tr class="memitem:ad2be4ee606c82fc084af1661d30f6f7f"><td class="memItemLeft" >union {</td></tr>
  99. <tr class="memitem:ae54d20350dbf96bfd131ddd04dc47831"><td class="memItemLeft" >&#160;&#160;&#160;char *&#160;&#160;&#160;<a class="el" href="structgrpc__arg.html#a05bc3701718db73608ef3598480e8fa8">string</a></td></tr>
  100. <tr class="separator:ae54d20350dbf96bfd131ddd04dc47831"><td class="memSeparator" colspan="2">&#160;</td></tr>
  101. <tr class="memitem:aa3059ab9a295b741b3be65b3a290281b"><td class="memItemLeft" >&#160;&#160;&#160;int&#160;&#160;&#160;<a class="el" href="structgrpc__arg.html#a6871bfca9c52e7f56abbd71c81d97554">integer</a></td></tr>
  102. <tr class="separator:aa3059ab9a295b741b3be65b3a290281b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  103. <tr class="memitem:a13eb7d610b7e4cb4b7f04802dc62bb15"><td class="memItemLeft" >&#160;&#160;&#160;struct {</td></tr>
  104. <tr class="memitem:a952787b29101f56c76e0263cd9fb5262"><td class="memItemLeft" >&#160;&#160;&#160;&#160;&#160;&#160;void *&#160;&#160;&#160;<a class="el" href="structgrpc__arg.html#aab5d11432a11b03a53e5d959d9a5328d">p</a></td></tr>
  105. <tr class="separator:a952787b29101f56c76e0263cd9fb5262"><td class="memSeparator" colspan="2">&#160;</td></tr>
  106. <tr class="memitem:a05105a88f080b9fee6c07984d099464a"><td class="memItemLeft" >&#160;&#160;&#160;&#160;&#160;&#160;const <a class="el" href="structgrpc__arg__pointer__vtable.html">grpc_arg_pointer_vtable</a> *&#160;&#160;&#160;<a class="el" href="structgrpc__arg.html#ac7a5ce7474a9d144aa42ed39fbe63fb7">vtable</a></td></tr>
  107. <tr class="separator:a05105a88f080b9fee6c07984d099464a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  108. <tr class="memitem:a13eb7d610b7e4cb4b7f04802dc62bb15"><td class="memItemLeft" valign="top">&#160;&#160;&#160;}&#160;&#160;&#160;<a class="el" href="structgrpc__arg.html#a85b5bbfbdec09ae46cff15628096137a">pointer</a></td></tr>
  109. <tr class="separator:a13eb7d610b7e4cb4b7f04802dc62bb15"><td class="memSeparator" colspan="2">&#160;</td></tr>
  110. <tr class="memitem:ad2be4ee606c82fc084af1661d30f6f7f"><td class="memItemLeft" valign="top">}&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structgrpc__arg.html#ad2be4ee606c82fc084af1661d30f6f7f">value</a></td></tr>
  111. <tr class="separator:ad2be4ee606c82fc084af1661d30f6f7f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  112. </table>
  113. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  114. <div class="textblock"><p>A single argument... </p>
  115. <p>each argument has a key and a value</p>
  116. <p>A note on naming keys: Keys are namespaced into groups, usually grouped by library, and are keys for module XYZ are named XYZ.key1, XYZ.key2, etc. Module names must be restricted to the regex [A-Za-z][_A-Za-z0-9]{,15}. Key names must be restricted to the regex [A-Za-z][_A-Za-z0-9]{,47}.</p>
  117. <p>GRPC core library keys are prefixed by grpc.</p>
  118. <p>Library authors are strongly encouraged to #define symbolic constants for their keys so that it's possible to change them in the future. </p>
  119. </div><h2 class="groupheader">Field Documentation</h2>
  120. <a class="anchor" id="a6871bfca9c52e7f56abbd71c81d97554"></a>
  121. <div class="memitem">
  122. <div class="memproto">
  123. <table class="memname">
  124. <tr>
  125. <td class="memname">int grpc_arg::integer</td>
  126. </tr>
  127. </table>
  128. </div><div class="memdoc">
  129. </div>
  130. </div>
  131. <a class="anchor" id="aeb230fbd50daacfe654abc3500a44968"></a>
  132. <div class="memitem">
  133. <div class="memproto">
  134. <table class="memname">
  135. <tr>
  136. <td class="memname">char* grpc_arg::key</td>
  137. </tr>
  138. </table>
  139. </div><div class="memdoc">
  140. </div>
  141. </div>
  142. <a class="anchor" id="aab5d11432a11b03a53e5d959d9a5328d"></a>
  143. <div class="memitem">
  144. <div class="memproto">
  145. <table class="memname">
  146. <tr>
  147. <td class="memname">void* grpc_arg::p</td>
  148. </tr>
  149. </table>
  150. </div><div class="memdoc">
  151. </div>
  152. </div>
  153. <a class="anchor" id="a85b5bbfbdec09ae46cff15628096137a"></a>
  154. <div class="memitem">
  155. <div class="memproto">
  156. <table class="memname">
  157. <tr>
  158. <td class="memname">struct { ... } grpc_arg::pointer</td>
  159. </tr>
  160. </table>
  161. </div><div class="memdoc">
  162. </div>
  163. </div>
  164. <a class="anchor" id="a05bc3701718db73608ef3598480e8fa8"></a>
  165. <div class="memitem">
  166. <div class="memproto">
  167. <table class="memname">
  168. <tr>
  169. <td class="memname">char* grpc_arg::string</td>
  170. </tr>
  171. </table>
  172. </div><div class="memdoc">
  173. </div>
  174. </div>
  175. <a class="anchor" id="aa26f2d3c4b1649c9eb061d24a8c10fd4"></a>
  176. <div class="memitem">
  177. <div class="memproto">
  178. <table class="memname">
  179. <tr>
  180. <td class="memname"><a class="el" href="grpc__types_8h.html#a0b06eae05e70404aedbceaebce6de593">grpc_arg_type</a> grpc_arg::type</td>
  181. </tr>
  182. </table>
  183. </div><div class="memdoc">
  184. </div>
  185. </div>
  186. <a class="anchor" id="ad2be4ee606c82fc084af1661d30f6f7f"></a>
  187. <div class="memitem">
  188. <div class="memproto">
  189. <table class="memname">
  190. <tr>
  191. <td class="memname">union { ... } grpc_arg::value</td>
  192. </tr>
  193. </table>
  194. </div><div class="memdoc">
  195. </div>
  196. </div>
  197. <a class="anchor" id="ac7a5ce7474a9d144aa42ed39fbe63fb7"></a>
  198. <div class="memitem">
  199. <div class="memproto">
  200. <table class="memname">
  201. <tr>
  202. <td class="memname">const <a class="el" href="structgrpc__arg__pointer__vtable.html">grpc_arg_pointer_vtable</a>* grpc_arg::vtable</td>
  203. </tr>
  204. </table>
  205. </div><div class="memdoc">
  206. </div>
  207. </div>
  208. <hr/>The documentation for this struct was generated from the following file:<ul>
  209. <li>include/grpc/impl/codegen/<a class="el" href="grpc__types_8h_source.html">grpc_types.h</a></li>
  210. </ul>
  211. </div><!-- contents -->
  212. <!-- start footer part -->
  213. <hr class="footer"/><address class="footer"><small>
  214. Generated on Tue Mar 8 2016 15:59:02 for GRPC Core by &#160;<a href="http://www.doxygen.org/index.html">
  215. <img class="footer" src="doxygen.png" alt="doxygen"/>
  216. </a> 1.8.6
  217. </small></address>
  218. </body>
  219. </html>