<!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"/>
<title>libnl: Command Line Interface API</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="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
</script>
<link href="libnl.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">libnl
 <span id="projectnumber">3.2.21</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.1.1 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
</ul>
</div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('group__cli.html','');});
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#groups">Modules</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">Command Line Interface API</div> </div>
</div><!--header-->
<div class="contents">
<p>These modules provide an interface for text based applications.
<a href="#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2><a name="groups"></a>
Modules</h2></td></tr>
<tr class="memitem:group__cli__addr"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__cli__addr.html">Addresses</a></td></tr>
<tr class="memitem:group__cli__cls"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__cli__cls.html">Classifiers</a></td></tr>
<tr class="memitem:group__cli__ct"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__cli__ct.html">Connection Tracking</a></td></tr>
<tr class="memitem:group__cli__exp"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__cli__exp.html">Expectation Tracking</a></td></tr>
<tr class="memitem:group__cli__link"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__cli__link.html">Links</a></td></tr>
<tr class="memitem:group__cli__neigh"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__cli__neigh.html">Neighbour</a></td></tr>
<tr class="memitem:group__cli__qdisc"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__cli__qdisc.html">Queueing Disciplines</a></td></tr>
<tr class="memitem:group__cli__route"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__cli__route.html">Routing</a></td></tr>
<tr class="memitem:group__cli__rule"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__cli__rule.html">Routing Rules</a></td></tr>
<tr class="memitem:group__cli__class"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__cli__class.html">Traffic Classes</a></td></tr>
<tr class="memitem:group__cli__tc"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__cli__tc.html">Traffic Control</a></td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:gaab66b72df11e32668df817475683b139"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__cli.html#gaab66b72df11e32668df817475683b139">nl_cli_parse_u32</a> (const char *arg)</td></tr>
<tr class="memdesc:gaab66b72df11e32668df817475683b139"><td class="mdescLeft"> </td><td class="mdescRight">Parse a text based 32 bit unsigned integer argument. <a href="#gaab66b72df11e32668df817475683b139"></a><br/></td></tr>
<tr class="memitem:ga8ac450e42c3807a5e8e4403f41a0c017"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga8ac450e42c3807a5e8e4403f41a0c017"></a>
void </td><td class="memItemRight" valign="bottom"><b>nl_cli_print_version</b> (void)</td></tr>
<tr class="memitem:ga6eb1ac48798f073c336d918eaa88e34c"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__cli.html#ga6eb1ac48798f073c336d918eaa88e34c">nl_cli_fatal</a> (int err, const char *fmt,...)</td></tr>
<tr class="memdesc:ga6eb1ac48798f073c336d918eaa88e34c"><td class="mdescLeft"> </td><td class="mdescRight">Print error message and quit application. <a href="#ga6eb1ac48798f073c336d918eaa88e34c"></a><br/></td></tr>
<tr class="memitem:ga7cc0c17c044c893b12994b2f0e09d3b5"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga7cc0c17c044c893b12994b2f0e09d3b5"></a>
int </td><td class="memItemRight" valign="bottom"><b>nl_cli_connect</b> (struct nl_sock *sk, int protocol)</td></tr>
<tr class="memitem:gacaea36b31b138a576fa933db998a4ae2"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gacaea36b31b138a576fa933db998a4ae2"></a>
struct nl_sock * </td><td class="memItemRight" valign="bottom"><b>nl_cli_alloc_socket</b> (void)</td></tr>
<tr class="memitem:ga4f943f1d4717a0ef4b6c065a7b3a25a3"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga4f943f1d4717a0ef4b6c065a7b3a25a3"></a>
struct nl_addr * </td><td class="memItemRight" valign="bottom"><b>nl_cli_addr_parse</b> (const char *str, int family)</td></tr>
<tr class="memitem:ga131601bf15543969e17a2283303f015a"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga131601bf15543969e17a2283303f015a"></a>
int </td><td class="memItemRight" valign="bottom"><b>nl_cli_parse_dumptype</b> (const char *str)</td></tr>
<tr class="memitem:gaf2dd1606914f310894b7d864649c03cc"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gaf2dd1606914f310894b7d864649c03cc"></a>
int </td><td class="memItemRight" valign="bottom"><b>nl_cli_confirm</b> (struct nl_object *obj, struct <a class="el" href="structnl__dump__params.html">nl_dump_params</a> *params, int default_yes)</td></tr>
<tr class="memitem:gac35ef1d4041c46934fa78bf3addd8a29"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gac35ef1d4041c46934fa78bf3addd8a29"></a>
struct nl_cache * </td><td class="memItemRight" valign="bottom"><b>nl_cli_alloc_cache</b> (struct nl_sock *sock, const char *name, int(*ac)(struct nl_sock *, struct nl_cache **))</td></tr>
<tr class="memitem:ga5d1ae9067fd4115ba1a31d08cbb91176"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga5d1ae9067fd4115ba1a31d08cbb91176"></a>
void </td><td class="memItemRight" valign="bottom"><b>nl_cli_load_module</b> (const char *prefix, const char *name)</td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<p>These modules provide an interface for text based applications. </p>
<p>The functions provided are wrappers for their libnl equivalent with added error handling. The functions check for allocation failures, invalid input, and unknown types and will print error messages accordingly via <a class="el" href="group__cli.html#ga6eb1ac48798f073c336d918eaa88e34c" title="Print error message and quit application.">nl_cli_fatal()</a>. </p>
<hr/><h2>Function Documentation</h2>
<a class="anchor" id="gaab66b72df11e32668df817475683b139"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t nl_cli_parse_u32 </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>arg</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Parse a text based 32 bit unsigned integer argument. </p>
<dl class="params"><dt>Parameters:</dt><dd>
<table class="params">
<tr><td class="paramname">arg</td><td>Integer in text form.</td></tr>
</table>
</dd>
</dl>
<p>Tries to convert the number provided in arg to a uint32_t. Will call <a class="el" href="group__cli.html#ga6eb1ac48798f073c336d918eaa88e34c" title="Print error message and quit application.">nl_cli_fatal()</a> if the conversion fails.</p>
<dl class="section return"><dt>Returns:</dt><dd>32bit unsigned integer. </dd></dl>
<p>Definition at line <a class="el" href="src_2lib_2utils_8c_source.html#l00035">35</a> of file <a class="el" href="src_2lib_2utils_8c_source.html">utils.c</a>.</p>
<p>References <a class="el" href="src_2lib_2utils_8c_source.html#l00070">nl_cli_fatal()</a>.</p>
<p><div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
<img id="dynsection-0-trigger" src="closed.png" alt="+"/> Here is the call graph for this function:</div>
<div id="dynsection-0-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-0-content" class="dyncontent" style="display:none;">
<div class="center"><img src="group__cli_gaab66b72df11e32668df817475683b139_cgraph.png" border="0" usemap="#group__cli_gaab66b72df11e32668df817475683b139_cgraph" alt=""/></div>
<map name="group__cli_gaab66b72df11e32668df817475683b139_cgraph" id="group__cli_gaab66b72df11e32668df817475683b139_cgraph">
<area shape="rect" id="node3" href="group__cli.html#ga6eb1ac48798f073c336d918eaa88e34c" title="Print error message and quit application." alt="" coords="181,5,269,32"/></map>
</div>
</p>
</div>
</div>
<a class="anchor" id="ga6eb1ac48798f073c336d918eaa88e34c"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void nl_cli_fatal </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>err</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>fmt</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname"><em>...</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Print error message and quit application. </p>
<dl class="params"><dt>Parameters:</dt><dd>
<table class="params">
<tr><td class="paramname">err</td><td>Error code. </td></tr>
<tr><td class="paramname">fmt</td><td>Error message.</td></tr>
</table>
</dd>
</dl>
<p>Prints the formatted error message to stderr and quits the application using the provided error code. </p>
<p>Definition at line <a class="el" href="src_2lib_2utils_8c_source.html#l00070">70</a> of file <a class="el" href="src_2lib_2utils_8c_source.html">utils.c</a>.</p>
<p>Referenced by <a class="el" href="src_2lib_2utils_8c_source.html#l00035">nl_cli_parse_u32()</a>.</p>
<p><div id="dynsection-1" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
<img id="dynsection-1-trigger" src="closed.png" alt="+"/> Here is the caller graph for this function:</div>
<div id="dynsection-1-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-1-content" class="dyncontent" style="display:none;">
<div class="center"><img src="group__cli_ga6eb1ac48798f073c336d918eaa88e34c_icgraph.png" border="0" usemap="#group__cli_ga6eb1ac48798f073c336d918eaa88e34c_icgraph" alt=""/></div>
<map name="group__cli_ga6eb1ac48798f073c336d918eaa88e34c_icgraph" id="group__cli_ga6eb1ac48798f073c336d918eaa88e34c_icgraph">
<area shape="rect" id="node3" href="group__cli.html#gaab66b72df11e32668df817475683b139" title="Parse a text based 32 bit unsigned integer argument." alt="" coords="142,5,269,32"/></map>
</div>
</p>
</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="footer">Generated on Thu Jan 24 2013 14:39:30 for libnl by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.1.1 </li>
</ul>
</div>
</body>
</html>
