Sophie

Sophie

distrib > Fedora > 14 > x86_64 > media > updates > by-pkgid > 87b89b73c41f4440bb86afd421c7548f > files > 71

libnl-devel-1.1-14.fc14.x86_64.rpm

<!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/cache.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&#160;<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&#160;Page</span></a></li>
      <li><a href="modules.html"><span>Modules</span></a></li>
      <li><a href="annotated.html"><span>Data&#160;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&#160;List</span></a></li>
    </ul>
  </div>
<div class="header">
  <div class="headertitle">
<h1>include/netlink/cache.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/cache.h              Caching Module</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 &lt;tgraf@suug.ch&gt;</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_CACHE_H_</span>
<a name="l00013"></a>00013 <span class="preprocessor"></span><span class="preprocessor">#define NETLINK_CACHE_H_</span>
<a name="l00014"></a>00014 <span class="preprocessor"></span>
<a name="l00015"></a>00015 <span class="preprocessor">#include &lt;netlink/netlink.h&gt;</span>
<a name="l00016"></a>00016 <span class="preprocessor">#include &lt;netlink/msg.h&gt;</span>
<a name="l00017"></a>00017 <span class="preprocessor">#include &lt;netlink/utils.h&gt;</span>
<a name="l00018"></a>00018 <span class="preprocessor">#include &lt;netlink/object.h&gt;</span>
<a name="l00019"></a>00019 <span class="preprocessor">#include &lt;netlink/cache-api.h&gt;</span>
<a name="l00020"></a>00020 
<a name="l00021"></a>00021 <span class="preprocessor">#ifdef __cplusplus</span>
<a name="l00022"></a>00022 <span class="preprocessor"></span><span class="keyword">extern</span> <span class="stringliteral">&quot;C&quot;</span> {
<a name="l00023"></a>00023 <span class="preprocessor">#endif</span>
<a name="l00024"></a>00024 <span class="preprocessor"></span>
<a name="l00025"></a>00025 <span class="keyword">struct </span>nl_cache;
<a name="l00026"></a>00026 
<a name="l00027"></a>00027 <span class="keyword">typedef</span> void (*change_func_t)(<span class="keyword">struct </span>nl_cache *, <span class="keyword">struct </span>nl_object *, int);
<a name="l00028"></a>00028 
<a name="l00029"></a>00029 <span class="comment">/* Access Functions */</span>
<a name="l00030"></a>00030 <span class="keyword">extern</span> <span class="keywordtype">int</span>                      <a class="code" href="group__cache.html#ga47554223760ce5293c5c3dc8bf07cac8" title="Return the number of items in the cache.">nl_cache_nitems</a>(<span class="keyword">struct</span> nl_cache *);
<a name="l00031"></a>00031 <span class="keyword">extern</span> <span class="keywordtype">int</span>                      <a class="code" href="group__cache.html#ga57a3c518ce67e5e1db978a6eb039413f" title="Return the number of items matching a filter in the cache.">nl_cache_nitems_filter</a>(<span class="keyword">struct</span> nl_cache *,
<a name="l00032"></a>00032                                                        <span class="keyword">struct</span> nl_object *);
<a name="l00033"></a>00033 <span class="keyword">extern</span> <span class="keyword">struct </span><a class="code" href="structnl__cache__ops.html" title="Cache Operations.">nl_cache_ops</a> *    <a class="code" href="group__cache.html#ga20673ac0b3b5717b38e71dad37e2cb93" title="Return the operations set of the cache.">nl_cache_get_ops</a>(<span class="keyword">struct</span> nl_cache *);
<a name="l00034"></a>00034 <span class="keyword">extern</span> <span class="keyword">struct </span>nl_object *       <a class="code" href="group__cache.html#ga2d7a6e36cf61c536b0b664afa04fe001" title="Return the first element in the cache.">nl_cache_get_first</a>(<span class="keyword">struct</span> nl_cache *);
<a name="l00035"></a>00035 <span class="keyword">extern</span> <span class="keyword">struct </span>nl_object *       <a class="code" href="group__cache.html#gac0767be207d9a57600939544da48c33f" title="Return the last element in the cache.">nl_cache_get_last</a>(<span class="keyword">struct</span> nl_cache *);
<a name="l00036"></a>00036 <span class="keyword">extern</span> <span class="keyword">struct </span>nl_object *       <a class="code" href="group__cache.html#ga22a6394070bffe8df63b81d0cb0a4dc2" title="Return the next element in the cache.">nl_cache_get_next</a>(<span class="keyword">struct</span> nl_object *);
<a name="l00037"></a>00037 <span class="keyword">extern</span> <span class="keyword">struct </span>nl_object *       <a class="code" href="group__cache.html#ga683817f4551540a0e035f76bb40696fb" title="Return the previous element in the cache.">nl_cache_get_prev</a>(<span class="keyword">struct</span> nl_object *);
<a name="l00038"></a>00038 
<a name="l00039"></a>00039 <span class="comment">/* Cache creation/deletion */</span>
<a name="l00040"></a>00040 <span class="preprocessor">#define nl_cache_alloc_from_ops(ptr)    nl_cache_alloc(ptr)</span>
<a name="l00041"></a>00041 <span class="preprocessor"></span><span class="keyword">extern</span> <span class="keyword">struct </span>nl_cache *        <a class="code" href="group__cache.html#ga9520ae0f2158db3c081f34c851d92252" title="Allocate an empty cache.">nl_cache_alloc</a>(<span class="keyword">struct</span> <a class="code" href="structnl__cache__ops.html" title="Cache Operations.">nl_cache_ops</a> *);
<a name="l00042"></a>00042 <span class="keyword">extern</span> <span class="keyword">struct </span>nl_cache *        <a class="code" href="group__cache.html#ga8f50f55c63db05b184645ee6bff23649" title="Allocate an empty cache based on type name.">nl_cache_alloc_name</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *);
<a name="l00043"></a>00043 <span class="keyword">extern</span> <span class="keyword">struct </span>nl_cache *        <a class="code" href="group__cache.html#ga5ea44d636362abb91193084ec71a2668" title="Allocate a new cache containing a subset of a cache.">nl_cache_subset</a>(<span class="keyword">struct</span> nl_cache *,
<a name="l00044"></a>00044                                                 <span class="keyword">struct</span> nl_object *);
<a name="l00045"></a>00045 <span class="keyword">extern</span> <span class="keywordtype">void</span>                     <a class="code" href="group__cache.html#gad22be4bd392afc8daca60a80f24a277b" title="Clear a cache.">nl_cache_clear</a>(<span class="keyword">struct</span> nl_cache *);
<a name="l00046"></a>00046 <span class="keyword">extern</span> <span class="keywordtype">void</span>                     <a class="code" href="group__cache.html#ga530c896db26d72001d011114b1e6cfaa" title="Free a cache.">nl_cache_free</a>(<span class="keyword">struct</span> nl_cache *);
<a name="l00047"></a>00047 
<a name="l00048"></a>00048 <span class="comment">/* Cache modification */</span>
<a name="l00049"></a>00049 <span class="keyword">extern</span> <span class="keywordtype">int</span>                      <a class="code" href="group__cache.html#ga5edfe88c7223702e3fbb909584bd87db" title="Add object to a cache.">nl_cache_add</a>(<span class="keyword">struct</span> nl_cache *,
<a name="l00050"></a>00050                                              <span class="keyword">struct</span> nl_object *);
<a name="l00051"></a>00051 <span class="keyword">extern</span> <span class="keywordtype">int</span>                      <a class="code" href="group__cache.html#ga6fb98385ab2fb543b1720ce84ab559db" title="Parse a netlink message and add it to the cache.">nl_cache_parse_and_add</a>(<span class="keyword">struct</span> nl_cache *,
<a name="l00052"></a>00052                                                        <span class="keyword">struct</span> nl_msg *);
<a name="l00053"></a>00053 <span class="preprocessor">#define nl_cache_delete(a, b)   nl_cache_remove(b)</span>
<a name="l00054"></a>00054 <span class="preprocessor"></span><span class="keyword">extern</span> <span class="keywordtype">void</span>                     <a class="code" href="group__cache.html#ga8d1f1d2c3b355a7f129d9cd6f7da2b52" title="Removes an object from a cache.">nl_cache_remove</a>(<span class="keyword">struct</span> nl_object *);
<a name="l00055"></a>00055 <span class="preprocessor">#define nl_cache_update(a, b)   nl_cache_refill(a, b)</span>
<a name="l00056"></a>00056 <span class="preprocessor"></span><span class="keyword">extern</span> <span class="keywordtype">int</span>                      <a class="code" href="group__cache.html#gaf5bd584017847e6ef69ec36739a6aaf0" title="(Re)fill a cache with the contents in the kernel.">nl_cache_refill</a>(<span class="keyword">struct</span> nl_handle *,
<a name="l00057"></a>00057                                                 <span class="keyword">struct</span> nl_cache *);
<a name="l00058"></a>00058 <span class="keyword">extern</span> <span class="keywordtype">int</span>                      <a class="code" href="group__cache.html#gae9ee72b56b5d3e215403105c858b9479" title="Pickup a netlink dump response and put it into a cache.">nl_cache_pickup</a>(<span class="keyword">struct</span> nl_handle *,
<a name="l00059"></a>00059                                                 <span class="keyword">struct</span> nl_cache *);
<a name="l00060"></a>00060 <span class="keyword">extern</span> <span class="keywordtype">int</span>                      nl_cache_resync(<span class="keyword">struct</span> nl_handle *,
<a name="l00061"></a>00061                                                 <span class="keyword">struct</span> nl_cache *,
<a name="l00062"></a>00062                                                 change_func_t);
<a name="l00063"></a>00063 <span class="keyword">extern</span> <span class="keywordtype">int</span>                      nl_cache_include(<span class="keyword">struct</span> nl_cache *,
<a name="l00064"></a>00064                                                  <span class="keyword">struct</span> nl_object *,
<a name="l00065"></a>00065                                                  change_func_t);
<a name="l00066"></a>00066 
<a name="l00067"></a>00067 <span class="comment">/* General */</span>
<a name="l00068"></a>00068 <span class="keyword">extern</span> <span class="keywordtype">int</span>                      <a class="code" href="group__cache.html#ga921e4e1d4781714a47ad4c00e8a3bed2" title="Returns true if the cache is empty.">nl_cache_is_empty</a>(<span class="keyword">struct</span> nl_cache *);
<a name="l00069"></a>00069 <span class="keyword">extern</span> <span class="keywordtype">void</span>                     <a class="code" href="group__cache.html#gaf72b8b81e5b84440bb7534c8cd00b9d2" title="Mark all objects in a cache.">nl_cache_mark_all</a>(<span class="keyword">struct</span> nl_cache *);
<a name="l00070"></a>00070 
<a name="l00071"></a>00071 <span class="comment">/* Dumping */</span>
<a name="l00072"></a>00072 <span class="keyword">extern</span> <span class="keywordtype">void</span>                     <a class="code" href="group__cache.html#ga8e7a06ddf0139ee1c9304721793772d1" title="Dump all elements of a cache.">nl_cache_dump</a>(<span class="keyword">struct</span> nl_cache *,
<a name="l00073"></a>00073                                               <span class="keyword">struct</span> <a class="code" href="structnl__dump__params.html" title="Dumping parameters.">nl_dump_params</a> *);
<a name="l00074"></a>00074 <span class="keyword">extern</span> <span class="keywordtype">void</span>                     <a class="code" href="group__cache.html#ga5d7082fb0e848926ef73bd531187d50f" title="Dump all elements of a cache (filtered).">nl_cache_dump_filter</a>(<span class="keyword">struct</span> nl_cache *,
<a name="l00075"></a>00075                                                      <span class="keyword">struct</span> <a class="code" href="structnl__dump__params.html" title="Dumping parameters.">nl_dump_params</a> *,
<a name="l00076"></a>00076                                                      <span class="keyword">struct</span> nl_object *);
<a name="l00077"></a>00077 
<a name="l00078"></a>00078 <span class="comment">/* Iterators */</span>
<a name="l00079"></a>00079 <span class="keyword">extern</span> <span class="keywordtype">void</span>                     <a class="code" href="group__cache.html#ga3a0cdf3c64b41a601ee693abea8b9a17" title="Call a callback on each element of the cache.">nl_cache_foreach</a>(<span class="keyword">struct</span> nl_cache *,
<a name="l00080"></a>00080                                                  <span class="keywordtype">void</span> (*cb)(<span class="keyword">struct</span> nl_object *,
<a name="l00081"></a>00081                                                             <span class="keywordtype">void</span> *),
<a name="l00082"></a>00082                                                  <span class="keywordtype">void</span> *arg);
<a name="l00083"></a>00083 <span class="keyword">extern</span> <span class="keywordtype">void</span>                     <a class="code" href="group__cache.html#ga5f0cc9367329f85137b2191c2889d41c" title="Call a callback on each element of the cache (filtered).">nl_cache_foreach_filter</a>(<span class="keyword">struct</span> nl_cache *,
<a name="l00084"></a>00084                                                         <span class="keyword">struct</span> nl_object *,
<a name="l00085"></a>00085                                                         <span class="keywordtype">void</span> (*cb)(<span class="keyword">struct</span>
<a name="l00086"></a>00086                                                                    nl_object *,
<a name="l00087"></a>00087                                                                    <span class="keywordtype">void</span> *),
<a name="l00088"></a>00088                                                         <span class="keywordtype">void</span> *arg);
<a name="l00089"></a>00089 
<a name="l00090"></a>00090 <span class="comment">/* --- cache management --- */</span>
<a name="l00091"></a>00091 
<a name="l00092"></a>00092 <span class="comment">/* Cache type management */</span>
<a name="l00093"></a>00093 <span class="keyword">extern</span> <span class="keyword">struct </span><a class="code" href="structnl__cache__ops.html" title="Cache Operations.">nl_cache_ops</a> *    <a class="code" href="group__cache__mngt.html#ga7657cf661e569b4b43842a82e409b5fd" title="Lookup the set cache operations of a certain cache type.">nl_cache_ops_lookup</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *);
<a name="l00094"></a>00094 <span class="keyword">extern</span> <span class="keyword">struct </span><a class="code" href="structnl__cache__ops.html" title="Cache Operations.">nl_cache_ops</a> *    <a class="code" href="group__cache__mngt.html#ga92ddd84e94041733d8def0492b0afc1e" title="Associate a message type to a set of cache operations.">nl_cache_ops_associate</a>(<span class="keywordtype">int</span>, <span class="keywordtype">int</span>);
<a name="l00095"></a>00095 <span class="keyword">extern</span> <span class="keyword">struct </span><a class="code" href="structnl__msgtype.html" title="Message type to cache action association.">nl_msgtype</a> *      <a class="code" href="group__cache__mngt.html#ga8c4f353b471c72ce5158ad89318eb910" title="Lookup message type cache association.">nl_msgtype_lookup</a>(<span class="keyword">struct</span> <a class="code" href="structnl__cache__ops.html" title="Cache Operations.">nl_cache_ops</a> *, <span class="keywordtype">int</span>);
<a name="l00096"></a>00096 <span class="keyword">extern</span> <span class="keywordtype">void</span>                     <a class="code" href="group__cache__mngt.html#ga36353f3e7b601bbcb6853bd194e59c67" title="Call a function for each registered cache operation.">nl_cache_ops_foreach</a>(<span class="keywordtype">void</span> (*cb)(<span class="keyword">struct</span> <a class="code" href="structnl__cache__ops.html" title="Cache Operations.">nl_cache_ops</a> *, <span class="keywordtype">void</span> *), <span class="keywordtype">void</span> *);
<a name="l00097"></a>00097 <span class="keyword">extern</span> <span class="keywordtype">int</span>                      <a class="code" href="group__cache__mngt.html#ga390eeb1fa61634cf1c216792c6df63c3" title="Register a set of cache operations.">nl_cache_mngt_register</a>(<span class="keyword">struct</span> <a class="code" href="structnl__cache__ops.html" title="Cache Operations.">nl_cache_ops</a> *);
<a name="l00098"></a>00098 <span class="keyword">extern</span> <span class="keywordtype">int</span>                      <a class="code" href="group__cache__mngt.html#ga09f56b767b3868b7e0cf8559863dde77" title="Unregister a set of cache operations.">nl_cache_mngt_unregister</a>(<span class="keyword">struct</span> <a class="code" href="structnl__cache__ops.html" title="Cache Operations.">nl_cache_ops</a> *);
<a name="l00099"></a>00099 
<a name="l00100"></a>00100 <span class="comment">/* Global cache provisioning/requiring */</span>
<a name="l00101"></a>00101 <span class="keyword">extern</span> <span class="keywordtype">void</span>                     <a class="code" href="group__cache__mngt.html#ga6a5f7016b2aa9485979e2de38076014d" title="Provide a cache for global use.">nl_cache_mngt_provide</a>(<span class="keyword">struct</span> nl_cache *);
<a name="l00102"></a>00102 <span class="keyword">extern</span> <span class="keywordtype">void</span>                     <a class="code" href="group__cache__mngt.html#ga4a0c41c6fc0df3e408f80d14c0565615" title="Unprovide a cache for global use.">nl_cache_mngt_unprovide</a>(<span class="keyword">struct</span> nl_cache *);
<a name="l00103"></a>00103 <span class="keyword">extern</span> <span class="keyword">struct </span>nl_cache *        <a class="code" href="group__cache__mngt.html#gad06c0755c030845c3c90ed490108ea5d" title="Demand the use of a global cache.">nl_cache_mngt_require</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *);
<a name="l00104"></a>00104 
<a name="l00105"></a>00105 <span class="keyword">struct </span>nl_cache_mngr;
<a name="l00106"></a>00106 
<a name="l00107"></a>00107 <span class="preprocessor">#define NL_AUTO_PROVIDE         1</span>
<a name="l00108"></a>00108 <span class="preprocessor"></span>
<a name="l00109"></a>00109 <span class="keyword">extern</span> <span class="keyword">struct </span>nl_cache_mngr *   <a class="code" href="group__cache__mngr.html#gacb350ed929ffe7d01fb8bc2f872b8b19" title="Allocate new cache manager.">nl_cache_mngr_alloc</a>(<span class="keyword">struct</span> nl_handle *,
<a name="l00110"></a>00110                                                     <span class="keywordtype">int</span>, <span class="keywordtype">int</span>);
<a name="l00111"></a>00111 <span class="keyword">extern</span> <span class="keyword">struct </span>nl_cache *        <a class="code" href="group__cache__mngr.html#ga68610a013ae88504ba9ff1dffb8464c0" title="Add cache responsibility to cache manager.">nl_cache_mngr_add</a>(<span class="keyword">struct</span> nl_cache_mngr *,
<a name="l00112"></a>00112                                                   <span class="keyword">const</span> <span class="keywordtype">char</span> *,
<a name="l00113"></a>00113                                                   change_func_t);
<a name="l00114"></a>00114 <span class="keyword">extern</span> <span class="keywordtype">int</span>                      <a class="code" href="group__cache__mngr.html#gac49581d90c6e7be9f3fa7fe009a88e80" title="Get file descriptor.">nl_cache_mngr_get_fd</a>(<span class="keyword">struct</span> nl_cache_mngr *);
<a name="l00115"></a>00115 <span class="keyword">extern</span> <span class="keywordtype">int</span>                      <a class="code" href="group__cache__mngr.html#ga544e06be5c3cf48fa761677e152f64f6" title="Check for event notifications.">nl_cache_mngr_poll</a>(<span class="keyword">struct</span> nl_cache_mngr *,
<a name="l00116"></a>00116                                                    <span class="keywordtype">int</span>);
<a name="l00117"></a>00117 <span class="keyword">extern</span> <span class="keywordtype">int</span>                      <a class="code" href="group__cache__mngr.html#gaea5a5c62599aefaf9a540f770a5b1fd4" title="Receive available event notifications.">nl_cache_mngr_data_ready</a>(<span class="keyword">struct</span> nl_cache_mngr *);
<a name="l00118"></a>00118 <span class="keyword">extern</span> <span class="keywordtype">void</span>                     <a class="code" href="group__cache__mngr.html#ga3c3ff6903e0fd29c620cc9b7a47e5a99" title="Free cache manager.">nl_cache_mngr_free</a>(<span class="keyword">struct</span> nl_cache_mngr *);
<a name="l00119"></a>00119 
<a name="l00120"></a>00120 <span class="preprocessor">#ifdef __cplusplus</span>
<a name="l00121"></a>00121 <span class="preprocessor"></span>}
<a name="l00122"></a>00122 <span class="preprocessor">#endif</span>
<a name="l00123"></a>00123 <span class="preprocessor"></span>
<a name="l00124"></a>00124 <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&#160;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.3 </small></address>
</body>
</html>

Perl :: Catalyst :: PostgreSQL :: RPM Valid HTML 4.01 Transitional