structgrpc__arg.html 7.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149
  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.13"/>
  7. <meta name="viewport" content="width=device-width, initial-scale=1"/>
  8. <title>GRPC Core: grpc_arg Struct Reference</title>
  9. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  10. <script type="text/javascript" src="jquery.js"></script>
  11. <script type="text/javascript" src="dynsections.js"></script>
  12. <link href="search/search.css" rel="stylesheet" type="text/css"/>
  13. <script type="text/javascript" src="search/searchdata.js"></script>
  14. <script type="text/javascript" src="search/search.js"></script>
  15. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  16. </head>
  17. <body>
  18. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  19. <div id="titlearea">
  20. <table cellspacing="0" cellpadding="0">
  21. <tbody>
  22. <tr style="height: 56px;">
  23. <td id="projectalign" style="padding-left: 0.5em;">
  24. <div id="projectname">GRPC Core
  25. &#160;<span id="projectnumber">6.0.0</span>
  26. </div>
  27. </td>
  28. </tr>
  29. </tbody>
  30. </table>
  31. </div>
  32. <!-- end header part -->
  33. <!-- Generated by Doxygen 1.8.13 -->
  34. <script type="text/javascript">
  35. var searchBox = new SearchBox("searchBox", "search",false,'Search');
  36. </script>
  37. <script type="text/javascript" src="menudata.js"></script>
  38. <script type="text/javascript" src="menu.js"></script>
  39. <script type="text/javascript">
  40. $(function() {
  41. initMenu('',true,false,'search.php','Search');
  42. $(document).ready(function() { init_search(); });
  43. });
  44. </script>
  45. <div id="main-nav"></div>
  46. <!-- window showing the filter options -->
  47. <div id="MSearchSelectWindow"
  48. onmouseover="return searchBox.OnSearchSelectShow()"
  49. onmouseout="return searchBox.OnSearchSelectHide()"
  50. onkeydown="return searchBox.OnSearchSelectKey(event)">
  51. </div>
  52. <!-- iframe showing the search results (closed by default) -->
  53. <div id="MSearchResultsWindow">
  54. <iframe src="javascript:void(0)" frameborder="0"
  55. name="MSearchResults" id="MSearchResults">
  56. </iframe>
  57. </div>
  58. </div><!-- top -->
  59. <div class="header">
  60. <div class="summary">
  61. <a href="#nested-classes">Data Structures</a> &#124;
  62. <a href="#pub-attribs">Data Fields</a> </div>
  63. <div class="headertitle">
  64. <div class="title">grpc_arg Struct Reference</div> </div>
  65. </div><!--header-->
  66. <div class="contents">
  67. <p>A single argument...
  68. <a href="structgrpc__arg.html#details">More...</a></p>
  69. <p><code>#include &lt;<a class="el" href="grpc__types_8h_source.html">grpc_types.h</a>&gt;</code></p>
  70. <table class="memberdecls">
  71. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
  72. Data Structures</h2></td></tr>
  73. <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">union &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="uniongrpc__arg_1_1grpc__arg__value.html">grpc_arg_value</a></td></tr>
  74. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  75. </table><table class="memberdecls">
  76. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
  77. Data Fields</h2></td></tr>
  78. <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>
  79. <tr class="separator:aa26f2d3c4b1649c9eb061d24a8c10fd4"><td class="memSeparator" colspan="2">&#160;</td></tr>
  80. <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>
  81. <tr class="separator:aeb230fbd50daacfe654abc3500a44968"><td class="memSeparator" colspan="2">&#160;</td></tr>
  82. <tr class="memitem:a4d44ed25e671818dc69fdb03796ad065"><td class="memItemLeft" align="right" valign="top">union <a class="el" href="uniongrpc__arg_1_1grpc__arg__value.html">grpc_arg::grpc_arg_value</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structgrpc__arg.html#a4d44ed25e671818dc69fdb03796ad065">value</a></td></tr>
  83. <tr class="separator:a4d44ed25e671818dc69fdb03796ad065"><td class="memSeparator" colspan="2">&#160;</td></tr>
  84. </table>
  85. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  86. <div class="textblock"><p>A single argument... </p>
  87. <p>each argument has a key and a value</p>
  88. <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>
  89. <p>GRPC core library keys are prefixed by grpc.</p>
  90. <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>
  91. </div><h2 class="groupheader">Field Documentation</h2>
  92. <a id="aeb230fbd50daacfe654abc3500a44968"></a>
  93. <h2 class="memtitle"><span class="permalink"><a href="#aeb230fbd50daacfe654abc3500a44968">&#9670;&nbsp;</a></span>key</h2>
  94. <div class="memitem">
  95. <div class="memproto">
  96. <table class="memname">
  97. <tr>
  98. <td class="memname">char* grpc_arg::key</td>
  99. </tr>
  100. </table>
  101. </div><div class="memdoc">
  102. </div>
  103. </div>
  104. <a id="aa26f2d3c4b1649c9eb061d24a8c10fd4"></a>
  105. <h2 class="memtitle"><span class="permalink"><a href="#aa26f2d3c4b1649c9eb061d24a8c10fd4">&#9670;&nbsp;</a></span>type</h2>
  106. <div class="memitem">
  107. <div class="memproto">
  108. <table class="memname">
  109. <tr>
  110. <td class="memname"><a class="el" href="grpc__types_8h.html#a0b06eae05e70404aedbceaebce6de593">grpc_arg_type</a> grpc_arg::type</td>
  111. </tr>
  112. </table>
  113. </div><div class="memdoc">
  114. </div>
  115. </div>
  116. <a id="a4d44ed25e671818dc69fdb03796ad065"></a>
  117. <h2 class="memtitle"><span class="permalink"><a href="#a4d44ed25e671818dc69fdb03796ad065">&#9670;&nbsp;</a></span>value</h2>
  118. <div class="memitem">
  119. <div class="memproto">
  120. <table class="memname">
  121. <tr>
  122. <td class="memname">union <a class="el" href="uniongrpc__arg_1_1grpc__arg__value.html">grpc_arg::grpc_arg_value</a> grpc_arg::value</td>
  123. </tr>
  124. </table>
  125. </div><div class="memdoc">
  126. </div>
  127. </div>
  128. <hr/>The documentation for this struct was generated from the following file:<ul>
  129. <li>include/grpc/impl/codegen/<a class="el" href="grpc__types_8h_source.html">grpc_types.h</a></li>
  130. </ul>
  131. </div><!-- contents -->
  132. <!-- start footer part -->
  133. <hr class="footer"/><address class="footer"><small>
  134. Generated on Fri Apr 13 2018 15:03:52 for GRPC Core by &#160;<a href="http://www.doxygen.org/index.html">
  135. <img class="footer" src="doxygen.png" alt="doxygen"/>
  136. </a> 1.8.13
  137. </small></address>
  138. </body>
  139. </html>