<!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: include/netlink/attr.h 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>include/netlink/attr.h</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"> * netlink/attr.h Netlink Attributes</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
<a name="l00012"></a>00012 <span class="preprocessor">#ifndef NETLINK_ATTR_H_</span>
<a name="l00013"></a>00013 <span class="preprocessor"></span><span class="preprocessor">#define NETLINK_ATTR_H_</span>
<a name="l00014"></a>00014 <span class="preprocessor"></span>
<a name="l00015"></a>00015 <span class="preprocessor">#include <netlink/netlink.h></span>
<a name="l00016"></a>00016 <span class="preprocessor">#include <netlink/object.h></span>
<a name="l00017"></a>00017 <span class="preprocessor">#include <netlink/addr.h></span>
<a name="l00018"></a>00018 <span class="preprocessor">#include <netlink/data.h></span>
<a name="l00019"></a>00019
<a name="l00020"></a>00020 <span class="preprocessor">#ifdef __cplusplus</span>
<a name="l00021"></a>00021 <span class="preprocessor"></span><span class="keyword">extern</span> <span class="stringliteral">"C"</span> {
<a name="l00022"></a>00022 <span class="preprocessor">#endif</span>
<a name="l00023"></a>00023 <span class="preprocessor"></span>
<a name="l00024"></a>00024 <span class="keyword">struct </span>nl_msg;
<a name="l00025"></a>00025 <span class="comment"></span>
<a name="l00026"></a>00026 <span class="comment">/**</span>
<a name="l00027"></a>00027 <span class="comment"> * @name Validation Policy Types</span>
<a name="l00028"></a>00028 <span class="comment"> * @{</span>
<a name="l00029"></a>00029 <span class="comment"> */</span>
<a name="l00030"></a>00030 <span class="comment"></span>
<a name="l00031"></a>00031 <span class="comment"> /**</span>
<a name="l00032"></a>00032 <span class="comment"> * @ingroup attr</span>
<a name="l00033"></a>00033 <span class="comment"> * Standard attribute types to specify validation policy</span>
<a name="l00034"></a>00034 <span class="comment"> */</span>
<a name="l00035"></a>00035 <span class="keyword">enum</span> {
<a name="l00036"></a><a class="code" href="group__attr.html#gga06fc87d81c62e9abb8790b6e5713c55ba3050acbc4faecec82dff1038c7e65d21">00036</a> <a class="code" href="group__attr.html#gga06fc87d81c62e9abb8790b6e5713c55ba3050acbc4faecec82dff1038c7e65d21" title="Unspecified type.">NLA_UNSPEC</a>, <span class="comment">/**< Unspecified type */</span>
<a name="l00037"></a><a class="code" href="group__attr.html#gga06fc87d81c62e9abb8790b6e5713c55ba5e9fb615f67cd1b0232f82f978d76b39">00037</a> <a class="code" href="group__attr.html#gga06fc87d81c62e9abb8790b6e5713c55ba5e9fb615f67cd1b0232f82f978d76b39" title="8bit integer">NLA_U8</a>, <span class="comment">/**< 8bit integer */</span>
<a name="l00038"></a><a class="code" href="group__attr.html#gga06fc87d81c62e9abb8790b6e5713c55ba8ca718be156e8f388cbcbc4c3d1d874d">00038</a> <a class="code" href="group__attr.html#gga06fc87d81c62e9abb8790b6e5713c55ba8ca718be156e8f388cbcbc4c3d1d874d" title="16bit integer">NLA_U16</a>, <span class="comment">/**< 16bit integer */</span>
<a name="l00039"></a><a class="code" href="group__attr.html#gga06fc87d81c62e9abb8790b6e5713c55babddb836025b456b06b025c293bff6dc8">00039</a> <a class="code" href="group__attr.html#gga06fc87d81c62e9abb8790b6e5713c55babddb836025b456b06b025c293bff6dc8" title="32bit integer">NLA_U32</a>, <span class="comment">/**< 32bit integer */</span>
<a name="l00040"></a><a class="code" href="group__attr.html#gga06fc87d81c62e9abb8790b6e5713c55ba210e5e3c0d9281fbe9481092ba2ef201">00040</a> <a class="code" href="group__attr.html#gga06fc87d81c62e9abb8790b6e5713c55ba210e5e3c0d9281fbe9481092ba2ef201" title="64bit integer">NLA_U64</a>, <span class="comment">/**< 64bit integer */</span>
<a name="l00041"></a><a class="code" href="group__attr.html#gga06fc87d81c62e9abb8790b6e5713c55ba284d1eafd6d5d99cedaff3cd5f5a8378">00041</a> <a class="code" href="group__attr.html#gga06fc87d81c62e9abb8790b6e5713c55ba284d1eafd6d5d99cedaff3cd5f5a8378" title="character string">NLA_STRING</a>, <span class="comment">/**< character string */</span>
<a name="l00042"></a><a class="code" href="group__attr.html#gga06fc87d81c62e9abb8790b6e5713c55ba8ad0bfef5a11304edf6a95971647ae0e">00042</a> <a class="code" href="group__attr.html#gga06fc87d81c62e9abb8790b6e5713c55ba8ad0bfef5a11304edf6a95971647ae0e" title="flag">NLA_FLAG</a>, <span class="comment">/**< flag */</span>
<a name="l00043"></a><a class="code" href="group__attr.html#gga06fc87d81c62e9abb8790b6e5713c55ba47d87c1054ef3284540a5a85a3cd159e">00043</a> <a class="code" href="group__attr.html#gga06fc87d81c62e9abb8790b6e5713c55ba47d87c1054ef3284540a5a85a3cd159e" title="micro seconds (64bit)">NLA_MSECS</a>, <span class="comment">/**< micro seconds (64bit) */</span>
<a name="l00044"></a><a class="code" href="group__attr.html#gga06fc87d81c62e9abb8790b6e5713c55ba925c06a260a9ffaef80ee4aa13738e19">00044</a> <a class="code" href="group__attr.html#gga06fc87d81c62e9abb8790b6e5713c55ba925c06a260a9ffaef80ee4aa13738e19" title="nested attributes">NLA_NESTED</a>, <span class="comment">/**< nested attributes */</span>
<a name="l00045"></a>00045 __NLA_TYPE_MAX,
<a name="l00046"></a>00046 };
<a name="l00047"></a>00047 <span class="comment"></span>
<a name="l00048"></a>00048 <span class="comment">/**</span>
<a name="l00049"></a>00049 <span class="comment"> * @ingroup attr</span>
<a name="l00050"></a>00050 <span class="comment"> * Maximum netlink validation policy type</span>
<a name="l00051"></a>00051 <span class="comment"> */</span>
<a name="l00052"></a><a class="code" href="group__attr.html#ga5d5983c9eeaf9fb343fc1463bd7c5e4c">00052</a> <span class="preprocessor">#define NLA_TYPE_MAX (__NLA_TYPE_MAX - 1)</span>
<a name="l00053"></a>00053 <span class="preprocessor"></span><span class="comment"></span>
<a name="l00054"></a>00054 <span class="comment">/** @} */</span>
<a name="l00055"></a>00055 <span class="comment"></span>
<a name="l00056"></a>00056 <span class="comment">/**</span>
<a name="l00057"></a>00057 <span class="comment"> * @ingroup attr</span>
<a name="l00058"></a>00058 <span class="comment"> * attribute validation policy</span>
<a name="l00059"></a>00059 <span class="comment"> *</span>
<a name="l00060"></a>00060 <span class="comment"> * Policies are defined as arrays of this struct, the array must</span>
<a name="l00061"></a>00061 <span class="comment"> * be accessible by attribute type up to the highest identifier</span>
<a name="l00062"></a>00062 <span class="comment"> * to be expected.</span>
<a name="l00063"></a>00063 <span class="comment"> *</span>
<a name="l00064"></a>00064 <span class="comment"> * Example:</span>
<a name="l00065"></a>00065 <span class="comment"> * @code</span>
<a name="l00066"></a>00066 <span class="comment"> * static struct nla_policy my_policy[ATTR_MAX+1] __read_mostly = {</span>
<a name="l00067"></a>00067 <span class="comment"> * [ATTR_FOO] = { .type = NLA_U16 },</span>
<a name="l00068"></a>00068 <span class="comment"> * [ATTR_BAR] = { .type = NLA_STRING },</span>
<a name="l00069"></a>00069 <span class="comment"> * [ATTR_BAZ] = { .minlen = sizeof(struct mystruct) },</span>
<a name="l00070"></a>00070 <span class="comment"> * };</span>
<a name="l00071"></a>00071 <span class="comment"> * @endcode</span>
<a name="l00072"></a>00072 <span class="comment"> */</span>
<a name="l00073"></a><a class="code" href="structnla__policy.html">00073</a> <span class="keyword">struct </span><a class="code" href="structnla__policy.html" title="attribute validation policy">nla_policy</a> {<span class="comment"></span>
<a name="l00074"></a>00074 <span class="comment"> /** Type of attribute or NLA_UNSPEC */</span>
<a name="l00075"></a><a class="code" href="structnla__policy.html#aaa36c9d1e298fc9e4ee16a8fb553b32a">00075</a> uint16_t <a class="code" href="structnla__policy.html#aaa36c9d1e298fc9e4ee16a8fb553b32a" title="Type of attribute or NLA_UNSPEC.">type</a>;
<a name="l00076"></a>00076 <span class="comment"></span>
<a name="l00077"></a>00077 <span class="comment"> /** Minimal length of payload required to be available */</span>
<a name="l00078"></a><a class="code" href="structnla__policy.html#a70310d3332cb82c390754bd70b1cb7dd">00078</a> uint16_t <a class="code" href="structnla__policy.html#a70310d3332cb82c390754bd70b1cb7dd" title="Minimal length of payload required to be available.">minlen</a>;
<a name="l00079"></a>00079 <span class="comment"></span>
<a name="l00080"></a>00080 <span class="comment"> /** Maximal length of payload required to be available */</span>
<a name="l00081"></a><a class="code" href="structnla__policy.html#a408814d16c0dbeb4137e76b36776583d">00081</a> uint16_t <a class="code" href="structnla__policy.html#a408814d16c0dbeb4137e76b36776583d" title="Maximal length of payload required to be available.">maxlen</a>;
<a name="l00082"></a>00082 };
<a name="l00083"></a>00083
<a name="l00084"></a>00084 <span class="comment">/* size calculations */</span>
<a name="l00085"></a>00085 <span class="keyword">extern</span> <span class="keywordtype">int</span> <a class="code" href="group__attr.html#ga894e1ded50d0d62748a2b9b5f7195938" title="length of attribute not including padding">nla_attr_size</a>(<span class="keywordtype">int</span> payload);
<a name="l00086"></a>00086 <span class="keyword">extern</span> <span class="keywordtype">int</span> <a class="code" href="group__attr.html#gafc7e89c7d72952510eff46f96761e3ea" title="total length of attribute including padding">nla_total_size</a>(<span class="keywordtype">int</span> payload);
<a name="l00087"></a>00087 <span class="keyword">extern</span> <span class="keywordtype">int</span> <a class="code" href="group__attr.html#gae24ddf8c4bb186eaaed15ecb2d08b816" title="length of padding at the tail of the attribute">nla_padlen</a>(<span class="keywordtype">int</span> payload);
<a name="l00088"></a>00088
<a name="l00089"></a>00089 <span class="comment">/* payload access */</span>
<a name="l00090"></a>00090 <span class="keyword">extern</span> <span class="keywordtype">int</span> <a class="code" href="group__attr.html#ga4aa5611a0b84b217ee9a7dd2b0491128" title="attribute type">nla_type</a>(<span class="keyword">const</span> <span class="keyword">struct</span> nlattr *);
<a name="l00091"></a>00091 <span class="keyword">extern</span> <span class="keywordtype">void</span> * <a class="code" href="group__attr.html#gaf39d6bbd2be1fc2de30b6b7d079a5fce" title="head of payload">nla_data</a>(<span class="keyword">const</span> <span class="keyword">struct</span> nlattr *);
<a name="l00092"></a>00092 <span class="keyword">extern</span> <span class="keywordtype">int</span> <a class="code" href="group__attr.html#gac5a7705797946fa9c0775997bb8d130b" title="length of payload">nla_len</a>(<span class="keyword">const</span> <span class="keyword">struct</span> nlattr *);
<a name="l00093"></a>00093
<a name="l00094"></a>00094 <span class="comment">/* attribute parsing */</span>
<a name="l00095"></a>00095 <span class="keyword">extern</span> <span class="keywordtype">int</span> <a class="code" href="group__attr.html#ga5e4378d7681e9477e8e364542187d07a" title="check if the netlink attribute fits into the remaining bytes">nla_ok</a>(<span class="keyword">const</span> <span class="keyword">struct</span> nlattr *, <span class="keywordtype">int</span>);
<a name="l00096"></a>00096 <span class="keyword">extern</span> <span class="keyword">struct </span>nlattr * <a class="code" href="group__attr.html#ga68b6fbaa58b11804df8af489b79fbab7" title="next netlink attribte in attribute stream">nla_next</a>(<span class="keyword">const</span> <span class="keyword">struct</span> nlattr *, <span class="keywordtype">int</span> *);
<a name="l00097"></a>00097 <span class="keyword">extern</span> <span class="keywordtype">int</span> <a class="code" href="group__attr.html#gaa7ad544b5a93034602a442eb26cda92c" title="Parse a stream of attributes into a tb buffer.">nla_parse</a>(<span class="keyword">struct</span> nlattr **, <span class="keywordtype">int</span>, <span class="keyword">struct</span> nlattr *,
<a name="l00098"></a>00098 <span class="keywordtype">int</span>, <span class="keyword">struct</span> <a class="code" href="structnla__policy.html" title="attribute validation policy">nla_policy</a> *);
<a name="l00099"></a>00099 <span class="keyword">extern</span> <span class="keywordtype">int</span> <a class="code" href="group__attr.html#ga974ec0720b2d863a5c65da868bcb7a6e" title="parse nested attributes">nla_parse_nested</a>(<span class="keyword">struct</span> nlattr **, <span class="keywordtype">int</span>, <span class="keyword">struct</span> nlattr *,
<a name="l00100"></a>00100 <span class="keyword">struct</span> <a class="code" href="structnla__policy.html" title="attribute validation policy">nla_policy</a> *);
<a name="l00101"></a>00101 <span class="keyword">extern</span> <span class="keywordtype">int</span> <a class="code" href="group__attr.html#ga5d8d5930b012e61c8d8e4ba6b3038c36" title="Validate a stream of attributes.">nla_validate</a>(<span class="keyword">struct</span> nlattr *, <span class="keywordtype">int</span>, <span class="keywordtype">int</span>,
<a name="l00102"></a>00102 <span class="keyword">struct</span> <a class="code" href="structnla__policy.html" title="attribute validation policy">nla_policy</a> *);
<a name="l00103"></a>00103 <span class="keyword">extern</span> <span class="keyword">struct </span>nlattr * <a class="code" href="group__attr.html#ga2e98df8c30030aebcfd1eebf11bbb22a" title="Find a specific attribute in a stream of attributes.">nla_find</a>(<span class="keyword">struct</span> nlattr *, <span class="keywordtype">int</span>, <span class="keywordtype">int</span>);
<a name="l00104"></a>00104
<a name="l00105"></a>00105 <span class="comment">/* utilities */</span>
<a name="l00106"></a>00106 <span class="keyword">extern</span> <span class="keywordtype">int</span> <a class="code" href="group__attr.html#gaf2cdaf473a1054b9c3fc735ca7275403" title="Copy a netlink attribute into another memory area.">nla_memcpy</a>(<span class="keywordtype">void</span> *, <span class="keyword">struct</span> nlattr *, <span class="keywordtype">int</span>);
<a name="l00107"></a>00107 <span class="keyword">extern</span> <span class="keywordtype">size_t</span> <a class="code" href="group__attr.html#gaabddc8018334423d84088d241b4b7830" title="Copy string attribute payload into a sized buffer.">nla_strlcpy</a>(<span class="keywordtype">char</span> *, <span class="keyword">const</span> <span class="keyword">struct</span> nlattr *, <span class="keywordtype">size_t</span>);
<a name="l00108"></a>00108 <span class="keyword">extern</span> <span class="keywordtype">int</span> <a class="code" href="group__attr.html#ga737c469f4692bce4c3b18f364e4a1949" title="Compare an attribute with sized memory area.">nla_memcmp</a>(<span class="keyword">const</span> <span class="keyword">struct</span> nlattr *, <span class="keyword">const</span> <span class="keywordtype">void</span> *, <span class="keywordtype">size_t</span>);
<a name="l00109"></a>00109 <span class="keyword">extern</span> <span class="keywordtype">int</span> <a class="code" href="group__attr.html#ga236748b15cfbc86dde1500ea2bc65072" title="Compare a string attribute against a string.">nla_strcmp</a>(<span class="keyword">const</span> <span class="keyword">struct</span> nlattr *, <span class="keyword">const</span> <span class="keywordtype">char</span> *);
<a name="l00110"></a>00110
<a name="l00111"></a>00111 <span class="comment">/* attribute construction */</span>
<a name="l00112"></a>00112 <span class="keyword">extern</span> <span class="keyword">struct </span>nlattr * <a class="code" href="group__attr.html#gab738cbc916a17baca88aeed2e67dddc2" title="reserve room for attribute on the skb">nla_reserve</a>(<span class="keyword">struct</span> nl_msg *, <span class="keywordtype">int</span>, <span class="keywordtype">int</span>);
<a name="l00113"></a>00113 <span class="keyword">extern</span> <span class="keywordtype">int</span> <a class="code" href="group__attr.html#ga8b3964330f885da7f204d5e4609e4761" title="Add a netlink attribute to a netlink message.">nla_put</a>(<span class="keyword">struct</span> nl_msg *, <span class="keywordtype">int</span>, <span class="keywordtype">int</span>, <span class="keyword">const</span> <span class="keywordtype">void</span> *);
<a name="l00114"></a>00114 <span class="keyword">extern</span> <span class="keywordtype">int</span> <a class="code" href="group__attr.html#gafe7bad603c92ecee0dfc0cc112dd1182" title="Add a nested netlink attribute to a netlink message.">nla_put_nested</a>(<span class="keyword">struct</span> nl_msg *, <span class="keywordtype">int</span>, <span class="keyword">struct</span> nl_msg *);
<a name="l00115"></a>00115 <span class="keyword">extern</span> <span class="keywordtype">int</span> <a class="code" href="group__attr.html#ga14cf4e429de0cb05f37d4e1489914b28" title="Add a u16 netlink attribute to a netlink message.">nla_put_u8</a>(<span class="keyword">struct</span> nl_msg *, <span class="keywordtype">int</span>, uint8_t);
<a name="l00116"></a>00116 <span class="keyword">extern</span> <span class="keywordtype">int</span> <a class="code" href="group__attr.html#gaf44eb15a7becdfb2833a4bf1b5cd8571" title="Add a u16 netlink attribute to a netlink message.">nla_put_u16</a>(<span class="keyword">struct</span> nl_msg *, <span class="keywordtype">int</span>, uint16_t);
<a name="l00117"></a>00117 <span class="keyword">extern</span> <span class="keywordtype">int</span> <a class="code" href="group__attr.html#ga9891f766dcebe6bdb2ce86f021c6f6e6" title="Add a u32 netlink attribute to a netlink message.">nla_put_u32</a>(<span class="keyword">struct</span> nl_msg *, <span class="keywordtype">int</span>, uint32_t);
<a name="l00118"></a>00118 <span class="keyword">extern</span> <span class="keywordtype">int</span> <a class="code" href="group__attr.html#gade5cf81c340ddb0656842bb554f3cbfe" title="Add a u64 netlink attribute to a netlink message.">nla_put_u64</a>(<span class="keyword">struct</span> nl_msg *, <span class="keywordtype">int</span>, uint64_t);
<a name="l00119"></a>00119 <span class="keyword">extern</span> <span class="keywordtype">int</span> <a class="code" href="group__attr.html#gacf85c1c8becd42e29f03670553b6e2f3" title="Add a string netlink attribute to a netlink message.">nla_put_string</a>(<span class="keyword">struct</span> nl_msg *, <span class="keywordtype">int</span>, <span class="keyword">const</span> <span class="keywordtype">char</span> *);
<a name="l00120"></a>00120 <span class="keyword">extern</span> <span class="keywordtype">int</span> <a class="code" href="group__attr.html#ga669fcc00e7114fb8f7d800a8b48ff0a9" title="Add a flag netlink attribute to a netlink message.">nla_put_flag</a>(<span class="keyword">struct</span> nl_msg *, <span class="keywordtype">int</span>);
<a name="l00121"></a>00121 <span class="keyword">extern</span> <span class="keywordtype">int</span> <a class="code" href="group__attr.html#ga80f366ccf41b1820c7faf95c76b2d718" title="Add a msecs netlink attribute to a netlink message.">nla_put_msecs</a>(<span class="keyword">struct</span> nl_msg *, <span class="keywordtype">int</span>, <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span>);
<a name="l00122"></a>00122 <span class="keyword">extern</span> <span class="keywordtype">int</span> <a class="code" href="group__attr.html#gad07458aa26ae9a430fb9ff8d444b526d" title="Add an abstract data netlink attribute to a netlink message.">nla_put_data</a>(<span class="keyword">struct</span> nl_msg *, <span class="keywordtype">int</span>, <span class="keyword">struct</span> nl_data *);
<a name="l00123"></a>00123 <span class="keyword">extern</span> <span class="keywordtype">int</span> <a class="code" href="group__attr.html#gafd639c95cec147ae3b7dd9717a66e339" title="Add an abstract address netlink attribute to a netlink message.">nla_put_addr</a>(<span class="keyword">struct</span> nl_msg *, <span class="keywordtype">int</span>, <span class="keyword">struct</span> nl_addr *);
<a name="l00124"></a>00124
<a name="l00125"></a>00125 <span class="comment">/* attribute nesting */</span>
<a name="l00126"></a>00126 <span class="keyword">extern</span> <span class="keyword">struct </span>nlattr * <a class="code" href="group__attr.html#ga18640b6320b8959bb586fa2ca456130c" title="Start a new level of nested attributes.">nla_nest_start</a>(<span class="keyword">struct</span> nl_msg *, <span class="keywordtype">int</span>);
<a name="l00127"></a>00127 <span class="keyword">extern</span> <span class="keywordtype">int</span> <a class="code" href="group__attr.html#ga067f9ada74902c02d97c725a47f590b7" title="Finalize nesting of attributes.">nla_nest_end</a>(<span class="keyword">struct</span> nl_msg *, <span class="keyword">struct</span> nlattr *);
<a name="l00128"></a>00128
<a name="l00129"></a>00129 <span class="comment">/* attribute reading */</span>
<a name="l00130"></a>00130 <span class="keyword">extern</span> uint8_t <a class="code" href="group__attr.html#ga9ca4618a38f1567b1e42b1f21be887c9" title="Return payload of u8 attribute.">nla_get_u8</a>(<span class="keyword">struct</span> nlattr *);
<a name="l00131"></a>00131 <span class="keyword">extern</span> uint16_t <a class="code" href="group__attr.html#ga60c1be303721d4a39ad810876a13d304" title="Return payload of u16 attribute.">nla_get_u16</a>(<span class="keyword">struct</span> nlattr *);
<a name="l00132"></a>00132 <span class="keyword">extern</span> uint32_t <a class="code" href="group__attr.html#gabda0290a8b26cc577c2c5cefa814aeac" title="Return payload of u32 attribute.">nla_get_u32</a>(<span class="keyword">struct</span> nlattr *);
<a name="l00133"></a>00133 <span class="keyword">extern</span> uint64_t <a class="code" href="group__attr.html#ga517d3ae28480ef44fec7b1e3d2fb29e6" title="Return payload of u64 attribute.">nla_get_u64</a>(<span class="keyword">struct</span> nlattr *);
<a name="l00134"></a>00134 <span class="keyword">extern</span> <span class="keywordtype">char</span> * <a class="code" href="group__attr.html#ga99baaa7c85d04eaece8f5eea34d8e2e9" title="return payload of string attribute">nla_get_string</a>(<span class="keyword">struct</span> nlattr *);
<a name="l00135"></a>00135 <span class="keyword">extern</span> <span class="keywordtype">int</span> <a class="code" href="group__attr.html#ga7ca9e726c046a2953aecf22bc9cece0a" title="Return payload of flag attribute.">nla_get_flag</a>(<span class="keyword">struct</span> nlattr *);
<a name="l00136"></a>00136 <span class="keyword">extern</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> <a class="code" href="group__attr.html#gad785952a48597a2fafc6268ac999afe8" title="Return payload of msecs attribute.">nla_get_msecs</a>(<span class="keyword">struct</span> nlattr *);
<a name="l00137"></a>00137 <span class="keyword">extern</span> <span class="keyword">struct </span>nl_data * <a class="code" href="group__attr.html#ga33a5aef23c5d26c8247632ed1f167068" title="Return payload of abstract data attribute.">nla_get_data</a>(<span class="keyword">struct</span> nlattr *);
<a name="l00138"></a>00138 <span class="keyword">extern</span> <span class="keyword">struct </span>nl_addr * <a class="code" href="group__attr.html#ga98a5ac1eefea9266cf46c91b9a9867f3" title="Return payload of address attribute.">nla_get_addr</a>(<span class="keyword">struct</span> nlattr *, <span class="keywordtype">int</span>);
<a name="l00139"></a>00139 <span class="comment"></span>
<a name="l00140"></a>00140 <span class="comment">/**</span>
<a name="l00141"></a>00141 <span class="comment"> * @name Attribute Construction (Exception Based)</span>
<a name="l00142"></a>00142 <span class="comment"> *</span>
<a name="l00143"></a>00143 <span class="comment"> * All these functions jump to nla_put_failure in case of a failure</span>
<a name="l00144"></a>00144 <span class="comment"> * instead of returning an error code.</span>
<a name="l00145"></a>00145 <span class="comment"> * </span>
<a name="l00146"></a>00146 <span class="comment"> * @{</span>
<a name="l00147"></a>00147 <span class="comment"> */</span>
<a name="l00148"></a>00148 <span class="comment"></span>
<a name="l00149"></a>00149 <span class="comment">/**</span>
<a name="l00150"></a>00150 <span class="comment"> * @ingroup attr</span>
<a name="l00151"></a>00151 <span class="comment"> * Add a netlink attribute to a netlink message</span>
<a name="l00152"></a>00152 <span class="comment"> * @arg n netlink message</span>
<a name="l00153"></a>00153 <span class="comment"> * @arg attrtype attribute type</span>
<a name="l00154"></a>00154 <span class="comment"> * @arg attrlen length of attribute payload</span>
<a name="l00155"></a>00155 <span class="comment"> * @arg data head of attribute payload</span>
<a name="l00156"></a>00156 <span class="comment"> */</span>
<a name="l00157"></a><a class="code" href="group__attr.html#gab63953375be738011e7c9d2c6de74a45">00157</a> <span class="preprocessor">#define NLA_PUT(n, attrtype, attrlen, data) \</span>
<a name="l00158"></a>00158 <span class="preprocessor"> do { \</span>
<a name="l00159"></a>00159 <span class="preprocessor"> if (nla_put(n, attrtype, attrlen, data) < 0) \</span>
<a name="l00160"></a>00160 <span class="preprocessor"> goto nla_put_failure; \</span>
<a name="l00161"></a>00161 <span class="preprocessor"> } while(0)</span>
<a name="l00162"></a>00162 <span class="preprocessor"></span><span class="comment"></span>
<a name="l00163"></a>00163 <span class="comment">/**</span>
<a name="l00164"></a>00164 <span class="comment"> * @ingroup attr</span>
<a name="l00165"></a>00165 <span class="comment"> * Add a basic netlink attribute to a netlink message</span>
<a name="l00166"></a>00166 <span class="comment"> * @arg n netlink message</span>
<a name="l00167"></a>00167 <span class="comment"> * @arg type atomic type</span>
<a name="l00168"></a>00168 <span class="comment"> * @arg attrtype attribute type</span>
<a name="l00169"></a>00169 <span class="comment"> * @arg value head of attribute payload</span>
<a name="l00170"></a>00170 <span class="comment"> */</span>
<a name="l00171"></a><a class="code" href="group__attr.html#ga2598cc7bf21a46b13a16c237695d8c18">00171</a> <span class="preprocessor">#define NLA_PUT_TYPE(n, type, attrtype, value) \</span>
<a name="l00172"></a>00172 <span class="preprocessor"> do { \</span>
<a name="l00173"></a>00173 <span class="preprocessor"> type __tmp = value; \</span>
<a name="l00174"></a>00174 <span class="preprocessor"> NLA_PUT(n, attrtype, sizeof(type), &__tmp); \</span>
<a name="l00175"></a>00175 <span class="preprocessor"> } while(0)</span>
<a name="l00176"></a>00176 <span class="preprocessor"></span><span class="comment"></span>
<a name="l00177"></a>00177 <span class="comment">/**</span>
<a name="l00178"></a>00178 <span class="comment"> * Add a u8 netlink attribute to a netlink message</span>
<a name="l00179"></a>00179 <span class="comment"> * @arg n netlink message</span>
<a name="l00180"></a>00180 <span class="comment"> * @arg attrtype attribute type</span>
<a name="l00181"></a>00181 <span class="comment"> * @arg value numeric value</span>
<a name="l00182"></a>00182 <span class="comment"> */</span>
<a name="l00183"></a><a class="code" href="group__attr.html#ga9df4c7be2d17ef301e5218b622bd984d">00183</a> <span class="preprocessor">#define NLA_PUT_U8(n, attrtype, value) \</span>
<a name="l00184"></a>00184 <span class="preprocessor"> NLA_PUT_TYPE(n, uint8_t, attrtype, value)</span>
<a name="l00185"></a>00185 <span class="preprocessor"></span><span class="comment"></span>
<a name="l00186"></a>00186 <span class="comment">/**</span>
<a name="l00187"></a>00187 <span class="comment"> * Add a u16 netlink attribute to a netlink message</span>
<a name="l00188"></a>00188 <span class="comment"> * @arg n netlink message</span>
<a name="l00189"></a>00189 <span class="comment"> * @arg attrtype attribute type</span>
<a name="l00190"></a>00190 <span class="comment"> * @arg value numeric value</span>
<a name="l00191"></a>00191 <span class="comment"> */</span>
<a name="l00192"></a><a class="code" href="group__attr.html#gadb79e3aff32c89efb5564dd4d595f277">00192</a> <span class="preprocessor">#define NLA_PUT_U16(n, attrtype, value) \</span>
<a name="l00193"></a>00193 <span class="preprocessor"> NLA_PUT_TYPE(n, uint16_t, attrtype, value)</span>
<a name="l00194"></a>00194 <span class="preprocessor"></span><span class="comment"></span>
<a name="l00195"></a>00195 <span class="comment">/**</span>
<a name="l00196"></a>00196 <span class="comment"> * Add a u32 netlink attribute to a netlink message</span>
<a name="l00197"></a>00197 <span class="comment"> * @arg n netlink message</span>
<a name="l00198"></a>00198 <span class="comment"> * @arg attrtype attribute type</span>
<a name="l00199"></a>00199 <span class="comment"> * @arg value numeric value</span>
<a name="l00200"></a>00200 <span class="comment"> */</span>
<a name="l00201"></a><a class="code" href="group__attr.html#ga61c87db4b2aa6c7b31e733d1ec684efb">00201</a> <span class="preprocessor">#define NLA_PUT_U32(n, attrtype, value) \</span>
<a name="l00202"></a>00202 <span class="preprocessor"> NLA_PUT_TYPE(n, uint32_t, attrtype, value)</span>
<a name="l00203"></a>00203 <span class="preprocessor"></span><span class="comment"></span>
<a name="l00204"></a>00204 <span class="comment">/**</span>
<a name="l00205"></a>00205 <span class="comment"> * Add a u64 netlink attribute to a netlink message</span>
<a name="l00206"></a>00206 <span class="comment"> * @arg n netlink message</span>
<a name="l00207"></a>00207 <span class="comment"> * @arg attrtype attribute type</span>
<a name="l00208"></a>00208 <span class="comment"> * @arg value numeric value</span>
<a name="l00209"></a>00209 <span class="comment"> */</span>
<a name="l00210"></a><a class="code" href="group__attr.html#ga5cf6fbd42288ae364ed25ce2655b8fd0">00210</a> <span class="preprocessor">#define NLA_PUT_U64(n, attrtype, value) \</span>
<a name="l00211"></a>00211 <span class="preprocessor"> NLA_PUT_TYPE(n, uint64_t, attrtype, value)</span>
<a name="l00212"></a>00212 <span class="preprocessor"></span><span class="comment"></span>
<a name="l00213"></a>00213 <span class="comment">/**</span>
<a name="l00214"></a>00214 <span class="comment"> * Add a character string netlink attribute to a netlink message</span>
<a name="l00215"></a>00215 <span class="comment"> * @arg n netlink message</span>
<a name="l00216"></a>00216 <span class="comment"> * @arg attrtype attribute type</span>
<a name="l00217"></a>00217 <span class="comment"> * @arg value character string</span>
<a name="l00218"></a>00218 <span class="comment"> */</span>
<a name="l00219"></a><a class="code" href="group__attr.html#ga7f2397f226e4561d195611572021b714">00219</a> <span class="preprocessor">#define NLA_PUT_STRING(n, attrtype, value) \</span>
<a name="l00220"></a>00220 <span class="preprocessor"> NLA_PUT(n, attrtype, strlen(value) + 1, value)</span>
<a name="l00221"></a>00221 <span class="preprocessor"></span><span class="comment"></span>
<a name="l00222"></a>00222 <span class="comment">/**</span>
<a name="l00223"></a>00223 <span class="comment"> * Add a flag netlink attribute to a netlink message</span>
<a name="l00224"></a>00224 <span class="comment"> * @arg n netlink message</span>
<a name="l00225"></a>00225 <span class="comment"> * @arg attrtype attribute type</span>
<a name="l00226"></a>00226 <span class="comment"> */</span>
<a name="l00227"></a><a class="code" href="group__attr.html#ga55c58e9fe7005b101965bb7c01de7a51">00227</a> <span class="preprocessor">#define NLA_PUT_FLAG(n, attrtype) \</span>
<a name="l00228"></a>00228 <span class="preprocessor"> NLA_PUT(n, attrtype, 0, NULL)</span>
<a name="l00229"></a>00229 <span class="preprocessor"></span><span class="comment"></span>
<a name="l00230"></a>00230 <span class="comment">/**</span>
<a name="l00231"></a>00231 <span class="comment"> * Add a msecs netlink attribute to a netlink message</span>
<a name="l00232"></a>00232 <span class="comment"> * @arg n netlink message</span>
<a name="l00233"></a>00233 <span class="comment"> * @arg attrtype attribute type</span>
<a name="l00234"></a>00234 <span class="comment"> * @arg msecs numeric value in micro seconds</span>
<a name="l00235"></a>00235 <span class="comment"> */</span>
<a name="l00236"></a><a class="code" href="group__attr.html#gac2886b9c176a183981cf45945b849948">00236</a> <span class="preprocessor">#define NLA_PUT_MSECS(n, attrtype, msecs) \</span>
<a name="l00237"></a>00237 <span class="preprocessor"> NLA_PUT_U64(n, attrtype, msecs)</span>
<a name="l00238"></a>00238 <span class="preprocessor"></span><span class="comment"></span>
<a name="l00239"></a>00239 <span class="comment">/**</span>
<a name="l00240"></a>00240 <span class="comment"> * Add a address attribute to a netlink message</span>
<a name="l00241"></a>00241 <span class="comment"> * @arg n netlink message</span>
<a name="l00242"></a>00242 <span class="comment"> * @arg attrtype attribute type</span>
<a name="l00243"></a>00243 <span class="comment"> * @arg addr abstract address object</span>
<a name="l00244"></a>00244 <span class="comment"> */</span>
<a name="l00245"></a><a class="code" href="group__attr.html#ga34038d75b33942a151a0e91791629a76">00245</a> <span class="preprocessor">#define NLA_PUT_ADDR(n, attrtype, addr) \</span>
<a name="l00246"></a>00246 <span class="preprocessor"> NLA_PUT(n, attrtype, nl_addr_get_len(addr), \</span>
<a name="l00247"></a>00247 <span class="preprocessor"> nl_addr_get_binary_addr(addr))</span>
<a name="l00248"></a>00248 <span class="preprocessor"></span><span class="comment"></span>
<a name="l00249"></a>00249 <span class="comment">/** @} */</span>
<a name="l00250"></a>00250 <span class="comment"></span>
<a name="l00251"></a>00251 <span class="comment">/**</span>
<a name="l00252"></a>00252 <span class="comment"> * @name Iterators</span>
<a name="l00253"></a>00253 <span class="comment"> * @{</span>
<a name="l00254"></a>00254 <span class="comment"> */</span>
<a name="l00255"></a>00255 <span class="comment"></span>
<a name="l00256"></a>00256 <span class="comment">/**</span>
<a name="l00257"></a>00257 <span class="comment"> * @ingroup attr</span>
<a name="l00258"></a>00258 <span class="comment"> * iterate over a stream of attributes</span>
<a name="l00259"></a>00259 <span class="comment"> * @arg pos loop counter, set to current attribute</span>
<a name="l00260"></a>00260 <span class="comment"> * @arg head head of attribute stream</span>
<a name="l00261"></a>00261 <span class="comment"> * @arg len length of attribute stream</span>
<a name="l00262"></a>00262 <span class="comment"> * @arg rem initialized to len, holds bytes currently remaining in stream</span>
<a name="l00263"></a>00263 <span class="comment"> */</span>
<a name="l00264"></a><a class="code" href="group__attr.html#ga7a262955c3fb8eab3158bd07180fbc2c">00264</a> <span class="preprocessor">#define nla_for_each_attr(pos, head, len, rem) \</span>
<a name="l00265"></a>00265 <span class="preprocessor"> for (pos = head, rem = len; \</span>
<a name="l00266"></a>00266 <span class="preprocessor"> nla_ok(pos, rem); \</span>
<a name="l00267"></a>00267 <span class="preprocessor"> pos = nla_next(pos, &(rem)))</span>
<a name="l00268"></a>00268 <span class="preprocessor"></span><span class="comment"></span>
<a name="l00269"></a>00269 <span class="comment">/**</span>
<a name="l00270"></a>00270 <span class="comment"> * @ingroup attr</span>
<a name="l00271"></a>00271 <span class="comment"> * iterate over a stream of nested attributes</span>
<a name="l00272"></a>00272 <span class="comment"> * @arg pos loop counter, set to current attribute</span>
<a name="l00273"></a>00273 <span class="comment"> * @arg nla attribute containing the nested attributes</span>
<a name="l00274"></a>00274 <span class="comment"> * @arg rem initialized to len, holds bytes currently remaining in stream</span>
<a name="l00275"></a>00275 <span class="comment"> */</span>
<a name="l00276"></a><a class="code" href="group__attr.html#gac2634af90bda4393105b6323da2044fa">00276</a> <span class="preprocessor">#define nla_for_each_nested(pos, nla, rem) \</span>
<a name="l00277"></a>00277 <span class="preprocessor"> for (pos = nla_data(nla), rem = nla_len(nla); \</span>
<a name="l00278"></a>00278 <span class="preprocessor"> nla_ok(pos, rem); \</span>
<a name="l00279"></a>00279 <span class="preprocessor"> pos = nla_next(pos, &(rem)))</span>
<a name="l00280"></a>00280 <span class="preprocessor"></span><span class="comment"></span>
<a name="l00281"></a>00281 <span class="comment">/** @} */</span>
<a name="l00282"></a>00282
<a name="l00283"></a>00283 <span class="preprocessor">#ifdef __cplusplus</span>
<a name="l00284"></a>00284 <span class="preprocessor"></span>}
<a name="l00285"></a>00285 <span class="preprocessor">#endif</span>
<a name="l00286"></a>00286 <span class="preprocessor"></span>
<a name="l00287"></a>00287 <span class="preprocessor">#endif</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>
