structgrpc__arg.html 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235
  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.11"/>
  7. <title>GRPC C++: 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/searchdata.js"></script>
  13. <script type="text/javascript" src="search/search.js"></script>
  14. <script type="text/javascript">
  15. $(document).ready(function() { init_search(); });
  16. </script>
  17. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  18. </head>
  19. <body>
  20. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  21. <div id="titlearea">
  22. <table cellspacing="0" cellpadding="0">
  23. <tbody>
  24. <tr style="height: 56px;">
  25. <td id="projectalign" style="padding-left: 0.5em;">
  26. <div id="projectname">GRPC C++
  27. &#160;<span id="projectnumber">1.0.0</span>
  28. </div>
  29. </td>
  30. </tr>
  31. </tbody>
  32. </table>
  33. </div>
  34. <!-- end header part -->
  35. <!-- Generated by Doxygen 1.8.11 -->
  36. <script type="text/javascript">
  37. var searchBox = new SearchBox("searchBox", "search",false,'Search');
  38. </script>
  39. <div id="navrow1" class="tabs">
  40. <ul class="tablist">
  41. <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  42. <li><a href="modules.html"><span>Modules</span></a></li>
  43. <li><a href="namespaces.html"><span>Namespaces</span></a></li>
  44. <li class="current"><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
  45. <li><a href="files.html"><span>Files</span></a></li>
  46. <li>
  47. <div id="MSearchBox" class="MSearchBoxInactive">
  48. <span class="left">
  49. <img id="MSearchSelect" src="search/mag_sel.png"
  50. onmouseover="return searchBox.OnSearchSelectShow()"
  51. onmouseout="return searchBox.OnSearchSelectHide()"
  52. alt=""/>
  53. <input type="text" id="MSearchField" value="Search" accesskey="S"
  54. onfocus="searchBox.OnSearchFieldFocus(true)"
  55. onblur="searchBox.OnSearchFieldFocus(false)"
  56. onkeyup="searchBox.OnSearchFieldChange(event)"/>
  57. </span><span class="right">
  58. <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
  59. </span>
  60. </div>
  61. </li>
  62. </ul>
  63. </div>
  64. <div id="navrow2" class="tabs2">
  65. <ul class="tablist">
  66. <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
  67. <li><a href="classes.html"><span>Data&#160;Structure&#160;Index</span></a></li>
  68. <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
  69. <li><a href="functions.html"><span>Data&#160;Fields</span></a></li>
  70. </ul>
  71. </div>
  72. <!-- window showing the filter options -->
  73. <div id="MSearchSelectWindow"
  74. onmouseover="return searchBox.OnSearchSelectShow()"
  75. onmouseout="return searchBox.OnSearchSelectHide()"
  76. onkeydown="return searchBox.OnSearchSelectKey(event)">
  77. </div>
  78. <!-- iframe showing the search results (closed by default) -->
  79. <div id="MSearchResultsWindow">
  80. <iframe src="javascript:void(0)" frameborder="0"
  81. name="MSearchResults" id="MSearchResults">
  82. </iframe>
  83. </div>
  84. </div><!-- top -->
  85. <div class="header">
  86. <div class="summary">
  87. <a href="#pub-attribs">Data Fields</a> </div>
  88. <div class="headertitle">
  89. <div class="title">grpc_arg Struct Reference</div> </div>
  90. </div><!--header-->
  91. <div class="contents">
  92. <p>A single argument...
  93. <a href="structgrpc__arg.html#details">More...</a></p>
  94. <p><code>#include &lt;<a class="el" href="grpc__types_8h_source.html">grpc_types.h</a>&gt;</code></p>
  95. <table class="memberdecls">
  96. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
  97. Data Fields</h2></td></tr>
  98. <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>
  99. <tr class="separator:aa26f2d3c4b1649c9eb061d24a8c10fd4"><td class="memSeparator" colspan="2">&#160;</td></tr>
  100. <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>
  101. <tr class="separator:aeb230fbd50daacfe654abc3500a44968"><td class="memSeparator" colspan="2">&#160;</td></tr>
  102. <tr class="memitem:a24f52b4ab8f9c326de13659a7a7d15e6"><td class="memItemLeft" >union {</td></tr>
  103. <tr class="memitem:a12895ad4a3193eb906cdb969a911607a"><td class="memItemLeft" >&#160;&#160;&#160;char *&#160;&#160;&#160;<a class="el" href="structgrpc__arg.html#a05bc3701718db73608ef3598480e8fa8">string</a></td></tr>
  104. <tr class="separator:a12895ad4a3193eb906cdb969a911607a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  105. <tr class="memitem:a66bbdd4a8c4d63b58fba8136772ce0b5"><td class="memItemLeft" >&#160;&#160;&#160;int&#160;&#160;&#160;<a class="el" href="structgrpc__arg.html#a6871bfca9c52e7f56abbd71c81d97554">integer</a></td></tr>
  106. <tr class="separator:a66bbdd4a8c4d63b58fba8136772ce0b5"><td class="memSeparator" colspan="2">&#160;</td></tr>
  107. <tr class="memitem:a69307b2bd26fdf47f80f63d119d69e3b"><td class="memItemLeft" >&#160;&#160;&#160;struct {</td></tr>
  108. <tr class="memitem:af619dcace5f311dd725e58d2f0829ca5"><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>
  109. <tr class="separator:af619dcace5f311dd725e58d2f0829ca5"><td class="memSeparator" colspan="2">&#160;</td></tr>
  110. <tr class="memitem:aacad879e36dcf107379219480243eec7"><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>
  111. <tr class="separator:aacad879e36dcf107379219480243eec7"><td class="memSeparator" colspan="2">&#160;</td></tr>
  112. <tr class="memitem:a69307b2bd26fdf47f80f63d119d69e3b"><td class="memItemLeft" valign="top">&#160;&#160;&#160;}&#160;&#160;&#160;<a class="el" href="structgrpc__arg.html#a5bb3637ab40d6dd3adc1f867d55eea64">pointer</a></td></tr>
  113. <tr class="separator:a69307b2bd26fdf47f80f63d119d69e3b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  114. <tr class="memitem:a24f52b4ab8f9c326de13659a7a7d15e6"><td class="memItemLeft" valign="top">}&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structgrpc__arg.html#a24f52b4ab8f9c326de13659a7a7d15e6">value</a></td></tr>
  115. <tr class="separator:a24f52b4ab8f9c326de13659a7a7d15e6"><td class="memSeparator" colspan="2">&#160;</td></tr>
  116. </table>
  117. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  118. <div class="textblock"><p>A single argument... </p>
  119. <p>each argument has a key and a value</p>
  120. <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>
  121. <p>GRPC core library keys are prefixed by grpc.</p>
  122. <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>
  123. </div><h2 class="groupheader">Field Documentation</h2>
  124. <a class="anchor" id="a6871bfca9c52e7f56abbd71c81d97554"></a>
  125. <div class="memitem">
  126. <div class="memproto">
  127. <table class="memname">
  128. <tr>
  129. <td class="memname">int grpc_arg::integer</td>
  130. </tr>
  131. </table>
  132. </div><div class="memdoc">
  133. </div>
  134. </div>
  135. <a class="anchor" id="aeb230fbd50daacfe654abc3500a44968"></a>
  136. <div class="memitem">
  137. <div class="memproto">
  138. <table class="memname">
  139. <tr>
  140. <td class="memname">char* grpc_arg::key</td>
  141. </tr>
  142. </table>
  143. </div><div class="memdoc">
  144. </div>
  145. </div>
  146. <a class="anchor" id="aab5d11432a11b03a53e5d959d9a5328d"></a>
  147. <div class="memitem">
  148. <div class="memproto">
  149. <table class="memname">
  150. <tr>
  151. <td class="memname">void* grpc_arg::p</td>
  152. </tr>
  153. </table>
  154. </div><div class="memdoc">
  155. </div>
  156. </div>
  157. <a class="anchor" id="a5bb3637ab40d6dd3adc1f867d55eea64"></a>
  158. <div class="memitem">
  159. <div class="memproto">
  160. <table class="memname">
  161. <tr>
  162. <td class="memname">struct { ... } grpc_arg::pointer</td>
  163. </tr>
  164. </table>
  165. </div><div class="memdoc">
  166. </div>
  167. </div>
  168. <a class="anchor" id="a05bc3701718db73608ef3598480e8fa8"></a>
  169. <div class="memitem">
  170. <div class="memproto">
  171. <table class="memname">
  172. <tr>
  173. <td class="memname">char* grpc_arg::string</td>
  174. </tr>
  175. </table>
  176. </div><div class="memdoc">
  177. </div>
  178. </div>
  179. <a class="anchor" id="aa26f2d3c4b1649c9eb061d24a8c10fd4"></a>
  180. <div class="memitem">
  181. <div class="memproto">
  182. <table class="memname">
  183. <tr>
  184. <td class="memname"><a class="el" href="grpc__types_8h.html#a0b06eae05e70404aedbceaebce6de593">grpc_arg_type</a> grpc_arg::type</td>
  185. </tr>
  186. </table>
  187. </div><div class="memdoc">
  188. </div>
  189. </div>
  190. <a class="anchor" id="a24f52b4ab8f9c326de13659a7a7d15e6"></a>
  191. <div class="memitem">
  192. <div class="memproto">
  193. <table class="memname">
  194. <tr>
  195. <td class="memname">union { ... } grpc_arg::value</td>
  196. </tr>
  197. </table>
  198. </div><div class="memdoc">
  199. </div>
  200. </div>
  201. <a class="anchor" id="ac7a5ce7474a9d144aa42ed39fbe63fb7"></a>
  202. <div class="memitem">
  203. <div class="memproto">
  204. <table class="memname">
  205. <tr>
  206. <td class="memname">const <a class="el" href="structgrpc__arg__pointer__vtable.html">grpc_arg_pointer_vtable</a>* grpc_arg::vtable</td>
  207. </tr>
  208. </table>
  209. </div><div class="memdoc">
  210. </div>
  211. </div>
  212. <hr/>The documentation for this struct was generated from the following file:<ul>
  213. <li>include/grpc/impl/codegen/<a class="el" href="grpc__types_8h_source.html">grpc_types.h</a></li>
  214. </ul>
  215. </div><!-- contents -->
  216. <!-- start footer part -->
  217. <hr class="footer"/><address class="footer"><small>
  218. Generated on Thu Aug 18 2016 21:34:58 for GRPC C++ by &#160;<a href="http://www.doxygen.org/index.html">
  219. <img class="footer" src="doxygen.png" alt="doxygen"/>
  220. </a> 1.8.11
  221. </small></address>
  222. </body>
  223. </html>