<!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"/>
<title>libnl: lib/doc.c Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.7.3 -->
<div id="top">
<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">1.1</span></div>
</td>
</tr>
</tbody>
</table>
</div>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="modules.html"><span>Modules</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>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File List</span></a></li>
</ul>
</div>
<div class="header">
<div class="headertitle">
<h1>lib/doc.c</h1> </div>
</div>
<div class="contents">
<div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*</span>
<a name="l00002"></a>00002 <span class="comment"> * lib/doc.c Documentation Purpose</span>
<a name="l00003"></a>00003 <span class="comment"> *</span>
<a name="l00004"></a>00004 <span class="comment"> * This library is free software; you can redistribute it and/or</span>
<a name="l00005"></a>00005 <span class="comment"> * modify it under the terms of the GNU Lesser General Public</span>
<a name="l00006"></a>00006 <span class="comment"> * License as published by the Free Software Foundation version 2.1</span>
<a name="l00007"></a>00007 <span class="comment"> * of the License.</span>
<a name="l00008"></a>00008 <span class="comment"> *</span>
<a name="l00009"></a>00009 <span class="comment"> * Copyright (c) 2003-2006 Thomas Graf <tgraf@suug.ch></span>
<a name="l00010"></a>00010 <span class="comment"> */</span>
<a name="l00011"></a>00011 <span class="comment"></span>
<a name="l00012"></a>00012 <span class="comment">/**</span>
<a name="l00013"></a>00013 <span class="comment"> * @mainpage</span>
<a name="l00014"></a>00014 <span class="comment"> *</span>
<a name="l00015"></a>00015 <span class="comment"> * @section remarks Remarks</span>
<a name="l00016"></a>00016 <span class="comment"> *</span>
<a name="l00017"></a>00017 <span class="comment"> * @subsection cache_alloc Allocation of Caches</span>
<a name="l00018"></a>00018 <span class="comment"> *</span>
<a name="l00019"></a>00019 <span class="comment"> * Almost all subsystem provide a function to allocate a new cache</span>
<a name="l00020"></a>00020 <span class="comment"> * of some form. The function usually looks like this:</span>
<a name="l00021"></a>00021 <span class="comment"> * @code</span>
<a name="l00022"></a>00022 <span class="comment"> * struct nl_cache *<object name>_alloc_cache(struct nl_handle *handle)</span>
<a name="l00023"></a>00023 <span class="comment"> * @endcode</span>
<a name="l00024"></a>00024 <span class="comment"> *</span>
<a name="l00025"></a>00025 <span class="comment"> * These functions allocate a new cache for the own object type,</span>
<a name="l00026"></a>00026 <span class="comment"> * initializes it properly and updates it to represent the current</span>
<a name="l00027"></a>00027 <span class="comment"> * state of their master, e.g. a link cache would include all</span>
<a name="l00028"></a>00028 <span class="comment"> * links currently configured in the kernel.</span>
<a name="l00029"></a>00029 <span class="comment"> *</span>
<a name="l00030"></a>00030 <span class="comment"> * Some of the allocation functions may take additional arguments</span>
<a name="l00031"></a>00031 <span class="comment"> * to further specify what will be part of the cache.</span>
<a name="l00032"></a>00032 <span class="comment"> *</span>
<a name="l00033"></a>00033 <span class="comment"> * All such functions return a newly allocated cache or NULL</span>
<a name="l00034"></a>00034 <span class="comment"> * in case of an error.</span>
<a name="l00035"></a>00035 <span class="comment"> *</span>
<a name="l00036"></a>00036 <span class="comment"> * @subsection addr Setting of Addresses</span>
<a name="l00037"></a>00037 <span class="comment"> * @code</span>
<a name="l00038"></a>00038 <span class="comment"> * int <object name>_set_addr(struct nl_object *, struct nl_addr *)</span>
<a name="l00039"></a>00039 <span class="comment"> * @endcode</span>
<a name="l00040"></a>00040 <span class="comment"> *</span>
<a name="l00041"></a>00041 <span class="comment"> * All attribute functions avaiable for assigning addresses to objects</span>
<a name="l00042"></a>00042 <span class="comment"> * take a struct nl_addr argument. The provided address object is</span>
<a name="l00043"></a>00043 <span class="comment"> * validated against the address family of the object if known already.</span>
<a name="l00044"></a>00044 <span class="comment"> * The assignment fails if the address families mismatch. In case the</span>
<a name="l00045"></a>00045 <span class="comment"> * address family has not been specified yet, the address family of</span>
<a name="l00046"></a>00046 <span class="comment"> * the new address is elected to be the new requirement.</span>
<a name="l00047"></a>00047 <span class="comment"> *</span>
<a name="l00048"></a>00048 <span class="comment"> * The function will acquire a new reference on the address object</span>
<a name="l00049"></a>00049 <span class="comment"> * before assignment, the caller is NOT responsible for this.</span>
<a name="l00050"></a>00050 <span class="comment"> *</span>
<a name="l00051"></a>00051 <span class="comment"> * All functions return 0 on success or a negative error code.</span>
<a name="l00052"></a>00052 <span class="comment"> *</span>
<a name="l00053"></a>00053 <span class="comment"> * @subsection flags Flags to Character StringTranslations</span>
<a name="l00054"></a>00054 <span class="comment"> * All functions converting a set of flags to a character string follow</span>
<a name="l00055"></a>00055 <span class="comment"> * the same principles, therefore, the following information applies</span>
<a name="l00056"></a>00056 <span class="comment"> * to all functions convertings flags to a character string and vice versa.</span>
<a name="l00057"></a>00057 <span class="comment"> *</span>
<a name="l00058"></a>00058 <span class="comment"> * @subsubsection flags2str Flags to Character String</span>
<a name="l00059"></a>00059 <span class="comment"> * @code</span>
<a name="l00060"></a>00060 <span class="comment"> * char *<object name>_flags2str(int flags, char *buf, size_t len)</span>
<a name="l00061"></a>00061 <span class="comment"> * @endcode</span>
<a name="l00062"></a>00062 <span class="comment"> * @arg flags Flags.</span>
<a name="l00063"></a>00063 <span class="comment"> * @arg buf Destination buffer.</span>
<a name="l00064"></a>00064 <span class="comment"> * @arg len Buffer length.</span>
<a name="l00065"></a>00065 <span class="comment"> *</span>
<a name="l00066"></a>00066 <span class="comment"> * Converts the specified flags to a character string separated by</span>
<a name="l00067"></a>00067 <span class="comment"> * commas and stores it in the specified destination buffer.</span>
<a name="l00068"></a>00068 <span class="comment"> *</span>
<a name="l00069"></a>00069 <span class="comment"> * @return The destination buffer</span>
<a name="l00070"></a>00070 <span class="comment"> *</span>
<a name="l00071"></a>00071 <span class="comment"> * @subsubsection str2flags Character String to Flags</span>
<a name="l00072"></a>00072 <span class="comment"> * @code</span>
<a name="l00073"></a>00073 <span class="comment"> * int <object name>_str2flags(const char *name)</span>
<a name="l00074"></a>00074 <span class="comment"> * @endcode</span>
<a name="l00075"></a>00075 <span class="comment"> * @arg name Name of flag.</span>
<a name="l00076"></a>00076 <span class="comment"> *</span>
<a name="l00077"></a>00077 <span class="comment"> * Converts the provided character string specifying a flag</span>
<a name="l00078"></a>00078 <span class="comment"> * to the corresponding numeric value.</span>
<a name="l00079"></a>00079 <span class="comment"> *</span>
<a name="l00080"></a>00080 <span class="comment"> * @return Link flag or a negative value if none was found.</span>
<a name="l00081"></a>00081 <span class="comment"> *</span>
<a name="l00082"></a>00082 <span class="comment"> * @subsubsection type2str Type to Character String</span>
<a name="l00083"></a>00083 <span class="comment"> * @code</span>
<a name="l00084"></a>00084 <span class="comment"> * char *<object name>_<type>2str(int type, char *buf, size_t len)</span>
<a name="l00085"></a>00085 <span class="comment"> * @endcode</span>
<a name="l00086"></a>00086 <span class="comment"> * @arg type Type as numeric value</span>
<a name="l00087"></a>00087 <span class="comment"> * @arg buf Destination buffer.</span>
<a name="l00088"></a>00088 <span class="comment"> * @arg len Buffer length.</span>
<a name="l00089"></a>00089 <span class="comment"> *</span>
<a name="l00090"></a>00090 <span class="comment"> * Converts an identifier (type) to a character string and stores</span>
<a name="l00091"></a>00091 <span class="comment"> * it in the specified destination buffer.</span>
<a name="l00092"></a>00092 <span class="comment"> *</span>
<a name="l00093"></a>00093 <span class="comment"> * @return The destination buffer or the type encoded in hexidecimal</span>
<a name="l00094"></a>00094 <span class="comment"> * form if the identifier is unknown.</span>
<a name="l00095"></a>00095 <span class="comment"> *</span>
<a name="l00096"></a>00096 <span class="comment"> * @subsubsection str2type Character String to Type</span>
<a name="l00097"></a>00097 <span class="comment"> * @code</span>
<a name="l00098"></a>00098 <span class="comment"> * int <object name>_str2<type>(const char *name)</span>
<a name="l00099"></a>00099 <span class="comment"> * @endcode</span>
<a name="l00100"></a>00100 <span class="comment"> * @arg name Name of identifier (type).</span>
<a name="l00101"></a>00101 <span class="comment"> *</span>
<a name="l00102"></a>00102 <span class="comment"> * Converts the provided character string specifying a identifier</span>
<a name="l00103"></a>00103 <span class="comment"> * to the corresponding numeric value.</span>
<a name="l00104"></a>00104 <span class="comment"> *</span>
<a name="l00105"></a>00105 <span class="comment"> * @return Identifier as numeric value or a negative value if none was found.</span>
<a name="l00106"></a>00106 <span class="comment"> */</span>
</pre></div></div>
</div>
<hr class="footer"/><address class="footer"><small>Generated on Mon Mar 21 2011 for libnl by 
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.3 </small></address>
</body>
</html>
distrib
>
Fedora
>
14
>
x86_64
>
media
>
updates
>
by-pkgid
>
87b89b73c41f4440bb86afd421c7548f
>
files
>
96
