diff options
author | Craig Tiller <ctiller@google.com> | 2015-08-05 08:18:21 -0700 |
---|---|---|
committer | Craig Tiller <ctiller@google.com> | 2015-08-05 08:18:21 -0700 |
commit | 68f4e0f6abc6bb99ff334542d5b5003edc3e651e (patch) | |
tree | 320e1f4aa189f06af9dbccce9f709c9c36c3bb6c /doc/ref/core.internal/html/cmdline_8c.html | |
parent | 3bbacf1b5ece50a8f9a945c88e2f81d3f8594e47 (diff) |
Initial Doxygen import for core, c++
Diffstat (limited to 'doc/ref/core.internal/html/cmdline_8c.html')
-rw-r--r-- | doc/ref/core.internal/html/cmdline_8c.html | 434 |
1 files changed, 434 insertions, 0 deletions
diff --git a/doc/ref/core.internal/html/cmdline_8c.html b/doc/ref/core.internal/html/cmdline_8c.html new file mode 100644 index 0000000000..bee6a608fa --- /dev/null +++ b/doc/ref/core.internal/html/cmdline_8c.html @@ -0,0 +1,434 @@ +<!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/support/cmdline.c File Reference</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_9410f15740cc8f8ab312fa27ab494b45.html">support</a></li> </ul> +</div> +</div><!-- top --> +<div class="header"> + <div class="summary"> +<a href="#nested-classes">Data Structures</a> | +<a href="#typedef-members">Typedefs</a> | +<a href="#enum-members">Enumerations</a> | +<a href="#func-members">Functions</a> </div> + <div class="headertitle"> +<div class="title">cmdline.c File Reference</div> </div> +</div><!--header--> +<div class="contents"> +<div class="textblock"><code>#include <<a class="el" href="cmdline_8h_source.html">grpc/support/cmdline.h</a>></code><br/> +<code>#include <limits.h></code><br/> +<code>#include <stdio.h></code><br/> +<code>#include <<a class="el" href="string_8h_source.html">string.h</a>></code><br/> +<code>#include <<a class="el" href="alloc_8h_source.html">grpc/support/alloc.h</a>></code><br/> +<code>#include <<a class="el" href="log_8h_source.html">grpc/support/log.h</a>></code><br/> +<code>#include <<a class="el" href="string__util_8h_source.html">grpc/support/string_util.h</a>></code><br/> +</div><table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a> +Data Structures</h2></td></tr> +<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structarg.html">arg</a></td></tr> +<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structgpr__cmdline.html">gpr_cmdline</a></td></tr> +<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> +</table><table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a> +Typedefs</h2></td></tr> +<tr class="memitem:af240efb36795b416de0779ad5d5159e4"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="structarg.html">arg</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="cmdline_8c.html#af240efb36795b416de0779ad5d5159e4">arg</a></td></tr> +<tr class="separator:af240efb36795b416de0779ad5d5159e4"><td class="memSeparator" colspan="2"> </td></tr> +</table><table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a> +Enumerations</h2></td></tr> +<tr class="memitem:a55073e9737969efda87471594edd95d4"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="cmdline_8c.html#a55073e9737969efda87471594edd95d4">argtype</a> { <a class="el" href="cmdline_8c.html#a55073e9737969efda87471594edd95d4a620547b20bcf630ba7f4d727fdb22521">ARGTYPE_INT</a>, +<a class="el" href="cmdline_8c.html#a55073e9737969efda87471594edd95d4ad141b51bee7ccb14e0c83871f0e3ee0d">ARGTYPE_BOOL</a>, +<a class="el" href="cmdline_8c.html#a55073e9737969efda87471594edd95d4a50a996a2423b2fd5397a14b362fa23ab">ARGTYPE_STRING</a> + }</td></tr> +<tr class="separator:a55073e9737969efda87471594edd95d4"><td class="memSeparator" colspan="2"> </td></tr> +</table><table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a> +Functions</h2></td></tr> +<tr class="memitem:a608f6fbc4edfb4d2c18e3c0660fd8773"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structgpr__cmdline.html">gpr_cmdline</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="cmdline_8c.html#a608f6fbc4edfb4d2c18e3c0660fd8773">gpr_cmdline_create</a> (const char *description)</td></tr> +<tr class="separator:a608f6fbc4edfb4d2c18e3c0660fd8773"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a018f826ce313b02d2773ef97b8df5f98"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="cmdline_8c.html#a018f826ce313b02d2773ef97b8df5f98">gpr_cmdline_destroy</a> (<a class="el" href="structgpr__cmdline.html">gpr_cmdline</a> *cl)</td></tr> +<tr class="separator:a018f826ce313b02d2773ef97b8df5f98"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a0fc8cd330751e9876e8635189a1bc10f"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="cmdline_8c.html#a0fc8cd330751e9876e8635189a1bc10f">gpr_cmdline_add_int</a> (<a class="el" href="structgpr__cmdline.html">gpr_cmdline</a> *cl, const char *name, const char *help, int *<a class="el" href="hpack__table_8c.html#a8556878012feffc9e0beb86cd78f424d">value</a>)</td></tr> +<tr class="separator:a0fc8cd330751e9876e8635189a1bc10f"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ac5ecfdfc605896c29df846b1e268045e"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="cmdline_8c.html#ac5ecfdfc605896c29df846b1e268045e">gpr_cmdline_add_flag</a> (<a class="el" href="structgpr__cmdline.html">gpr_cmdline</a> *cl, const char *name, const char *help, int *<a class="el" href="hpack__table_8c.html#a8556878012feffc9e0beb86cd78f424d">value</a>)</td></tr> +<tr class="separator:ac5ecfdfc605896c29df846b1e268045e"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a34568676c089f3284dc8f7d8d706b1d3"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="cmdline_8c.html#a34568676c089f3284dc8f7d8d706b1d3">gpr_cmdline_add_string</a> (<a class="el" href="structgpr__cmdline.html">gpr_cmdline</a> *cl, const char *name, const char *help, char **<a class="el" href="hpack__table_8c.html#a8556878012feffc9e0beb86cd78f424d">value</a>)</td></tr> +<tr class="separator:a34568676c089f3284dc8f7d8d706b1d3"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:afcf023a5eb082034a650a0f0177d1fe9"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="cmdline_8c.html#afcf023a5eb082034a650a0f0177d1fe9">gpr_cmdline_on_extra_arg</a> (<a class="el" href="structgpr__cmdline.html">gpr_cmdline</a> *cl, const char *name, const char *help, void(*on_extra_arg)(void *user_data, const char *<a class="el" href="structarg.html">arg</a>), void *user_data)</td></tr> +<tr class="separator:afcf023a5eb082034a650a0f0177d1fe9"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a4eac81d047bdc6e679079309bf60f030"><td class="memItemLeft" align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="cmdline_8c.html#a4eac81d047bdc6e679079309bf60f030">gpr_cmdline_usage_string</a> (<a class="el" href="structgpr__cmdline.html">gpr_cmdline</a> *cl, const char *argv0)</td></tr> +<tr class="separator:a4eac81d047bdc6e679079309bf60f030"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a34b66021bbbb9f6a6e8a60c0ae34f8a4"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="cmdline_8c.html#a34b66021bbbb9f6a6e8a60c0ae34f8a4">gpr_cmdline_parse</a> (<a class="el" href="structgpr__cmdline.html">gpr_cmdline</a> *cl, int argc, char **argv)</td></tr> +<tr class="separator:a34b66021bbbb9f6a6e8a60c0ae34f8a4"><td class="memSeparator" colspan="2"> </td></tr> +</table> +<h2 class="groupheader">Typedef Documentation</h2> +<a class="anchor" id="af240efb36795b416de0779ad5d5159e4"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">typedef struct <a class="el" href="structarg.html">arg</a> <a class="el" href="structarg.html">arg</a></td> + </tr> + </table> +</div><div class="memdoc"> + +</div> +</div> +<h2 class="groupheader">Enumeration Type Documentation</h2> +<a class="anchor" id="a55073e9737969efda87471594edd95d4"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">enum <a class="el" href="cmdline_8c.html#a55073e9737969efda87471594edd95d4">argtype</a></td> + </tr> + </table> +</div><div class="memdoc"> +<table class="fieldtable"> +<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><em><a class="anchor" id="a55073e9737969efda87471594edd95d4a620547b20bcf630ba7f4d727fdb22521"></a>ARGTYPE_INT</em> </td><td class="fielddoc"> +</td></tr> +<tr><td class="fieldname"><em><a class="anchor" id="a55073e9737969efda87471594edd95d4ad141b51bee7ccb14e0c83871f0e3ee0d"></a>ARGTYPE_BOOL</em> </td><td class="fielddoc"> +</td></tr> +<tr><td class="fieldname"><em><a class="anchor" id="a55073e9737969efda87471594edd95d4a50a996a2423b2fd5397a14b362fa23ab"></a>ARGTYPE_STRING</em> </td><td class="fielddoc"> +</td></tr> +</table> + +</div> +</div> +<h2 class="groupheader">Function Documentation</h2> +<a class="anchor" id="ac5ecfdfc605896c29df846b1e268045e"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void gpr_cmdline_add_flag </td> + <td>(</td> + <td class="paramtype"><a class="el" href="structgpr__cmdline.html">gpr_cmdline</a> * </td> + <td class="paramname"><em>cl</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const char * </td> + <td class="paramname"><em>name</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const char * </td> + <td class="paramname"><em>help</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int * </td> + <td class="paramname"><em>value</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +</div> +</div> +<a class="anchor" id="a0fc8cd330751e9876e8635189a1bc10f"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void gpr_cmdline_add_int </td> + <td>(</td> + <td class="paramtype"><a class="el" href="structgpr__cmdline.html">gpr_cmdline</a> * </td> + <td class="paramname"><em>cl</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const char * </td> + <td class="paramname"><em>name</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const char * </td> + <td class="paramname"><em>help</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int * </td> + <td class="paramname"><em>value</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +</div> +</div> +<a class="anchor" id="a34568676c089f3284dc8f7d8d706b1d3"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void gpr_cmdline_add_string </td> + <td>(</td> + <td class="paramtype"><a class="el" href="structgpr__cmdline.html">gpr_cmdline</a> * </td> + <td class="paramname"><em>cl</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const char * </td> + <td class="paramname"><em>name</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const char * </td> + <td class="paramname"><em>help</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">char ** </td> + <td class="paramname"><em>value</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +</div> +</div> +<a class="anchor" id="a608f6fbc4edfb4d2c18e3c0660fd8773"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="structgpr__cmdline.html">gpr_cmdline</a>* gpr_cmdline_create </td> + <td>(</td> + <td class="paramtype">const char * </td> + <td class="paramname"><em>description</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +</div> +</div> +<a class="anchor" id="a018f826ce313b02d2773ef97b8df5f98"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void gpr_cmdline_destroy </td> + <td>(</td> + <td class="paramtype"><a class="el" href="structgpr__cmdline.html">gpr_cmdline</a> * </td> + <td class="paramname"><em>cl</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +</div> +</div> +<a class="anchor" id="afcf023a5eb082034a650a0f0177d1fe9"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void gpr_cmdline_on_extra_arg </td> + <td>(</td> + <td class="paramtype"><a class="el" href="structgpr__cmdline.html">gpr_cmdline</a> * </td> + <td class="paramname"><em>cl</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const char * </td> + <td class="paramname"><em>name</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const char * </td> + <td class="paramname"><em>help</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">void(*)(void *user_data, const char *<a class="el" href="structarg.html">arg</a>) </td> + <td class="paramname"><em>on_extra_arg</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">void * </td> + <td class="paramname"><em>user_data</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +</div> +</div> +<a class="anchor" id="a34b66021bbbb9f6a6e8a60c0ae34f8a4"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void gpr_cmdline_parse </td> + <td>(</td> + <td class="paramtype"><a class="el" href="structgpr__cmdline.html">gpr_cmdline</a> * </td> + <td class="paramname"><em>cl</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int </td> + <td class="paramname"><em>argc</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">char ** </td> + <td class="paramname"><em>argv</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +</div> +</div> +<a class="anchor" id="a4eac81d047bdc6e679079309bf60f030"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">char* gpr_cmdline_usage_string </td> + <td>(</td> + <td class="paramtype"><a class="el" href="structgpr__cmdline.html">gpr_cmdline</a> * </td> + <td class="paramname"><em>cl</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const char * </td> + <td class="paramname"><em>argv0</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +</div> +</div> +</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> |