%PDF- %PDF-
Mini Shell

Mini Shell

Direktori : /proc/self/root/usr/share/nagios/html/docs/
Upload File :
Create Path :
Current File : //proc/self/root/usr/share/nagios/html/docs/fanout_8h_source.html

<!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.5"/>
<title>Nagios: fanout.h Source File</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">Nagios
   &#160;<span id="projectnumber">4.4.3</span>
   </div>
   <div id="projectbrief">Dev docs for Nagios core and neb-module hackers</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
<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&#160;Page</span></a></li>
      <li><a href="pages.html"><span>Related&#160;Pages</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>
      <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&#160;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">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</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_97aefd0d527b934f1d99a682da8fe6a9.html">lib</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="headertitle">
<div class="title">fanout.h</div>  </div>
</div><!--header-->
<div class="contents">
<a href="fanout_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno">    1</span>&#160;<span class="preprocessor">#ifndef LIBNAGIOS_FANOUT_H_INCLUDED</span></div>
<div class="line"><a name="l00002"></a><span class="lineno">    2</span>&#160;<span class="preprocessor"></span><span class="preprocessor">#define LIBNAGIOS_FANOUT_H_INCLUDED</span></div>
<div class="line"><a name="l00003"></a><span class="lineno">    3</span>&#160;<span class="preprocessor"></span><span class="preprocessor">#include &quot;<a class="code" href="lnag-utils_8h.html">lnag-utils.h</a>&quot;</span></div>
<div class="line"><a name="l00004"></a><span class="lineno">    4</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00005"></a><span class="lineno">    5</span>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00006"></a><span class="lineno">    6</span>&#160;<span class="comment"> * @file fanout.h</span></div>
<div class="line"><a name="l00007"></a><span class="lineno">    7</span>&#160;<span class="comment"> * @brief Simple fanout table implementation</span></div>
<div class="line"><a name="l00008"></a><span class="lineno">    8</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00009"></a><span class="lineno">    9</span>&#160;<span class="comment"> * Fanouts are useful to hold short-lived integer-indexed data where</span></div>
<div class="line"><a name="l00010"></a><span class="lineno">   10</span>&#160;<span class="comment"> * the keyspan between smallest and largest key can be too large and</span></div>
<div class="line"><a name="l00011"></a><span class="lineno">   11</span>&#160;<span class="comment"> * change too often for it to be practical to maintain a growing array.</span></div>
<div class="line"><a name="l00012"></a><span class="lineno">   12</span>&#160;<span class="comment"> * If you think of it as a hash-table optimized for unsigned longs you&#39;ve</span></div>
<div class="line"><a name="l00013"></a><span class="lineno">   13</span>&#160;<span class="comment"> * got the right idea.</span></div>
<div class="line"><a name="l00014"></a><span class="lineno">   14</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00015"></a><span class="lineno">   15</span>&#160;<span class="comment"> * @{</span></div>
<div class="line"><a name="l00016"></a><span class="lineno">   16</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00017"></a><span class="lineno">   17</span>&#160;</div>
<div class="line"><a name="l00018"></a><span class="lineno">   18</span>&#160;<a class="code" href="lnag-utils_8h.html#aa15a8af3588df950f89ef7dc6eda43a8">NAGIOS_BEGIN_DECL</a></div>
<div class="line"><a name="l00019"></a><span class="lineno">   19</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00020"></a><span class="lineno">   20</span>&#160;<span class="comment">/** Primary (opaque) type for this api */</span></div>
<div class="line"><a name="l00021"></a><span class="lineno"><a class="line" href="fanout_8h.html#aae080da7798ee92f6fe63fd99384d92a">   21</a></span>&#160;<span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="fanout_8h.html#aae080da7798ee92f6fe63fd99384d92a">fanout_table</a> <a class="code" href="fanout_8h.html#aae080da7798ee92f6fe63fd99384d92a">fanout_table</a>;</div>
<div class="line"><a name="l00022"></a><span class="lineno">   22</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00023"></a><span class="lineno">   23</span>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00024"></a><span class="lineno">   24</span>&#160;<span class="comment"> * Create a fanout table</span></div>
<div class="line"><a name="l00025"></a><span class="lineno">   25</span>&#160;<span class="comment"> * @param[in] size The size of the table. Preferably a power of 2</span></div>
<div class="line"><a name="l00026"></a><span class="lineno">   26</span>&#160;<span class="comment"> * @return Pointer to a newly created table</span></div>
<div class="line"><a name="l00027"></a><span class="lineno">   27</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00028"></a><span class="lineno">   28</span>&#160;<span class="keyword">extern</span> <a class="code" href="fanout_8h.html#aae080da7798ee92f6fe63fd99384d92a">fanout_table</a> *<a class="code" href="fanout_8h.html#a49f13e43bf51ef34c7aae62ef33d74a0">fanout_create</a>(<span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> size);</div>
<div class="line"><a name="l00029"></a><span class="lineno">   29</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00030"></a><span class="lineno">   30</span>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00031"></a><span class="lineno">   31</span>&#160;<span class="comment"> * Destroy a fanout table, with optional destructor.</span></div>
<div class="line"><a name="l00032"></a><span class="lineno">   32</span>&#160;<span class="comment"> * This function will iterate over all the entries in the fanout</span></div>
<div class="line"><a name="l00033"></a><span class="lineno">   33</span>&#160;<span class="comment"> * table and remove them, one by one. If &#39;destructor&#39; is not NULL,</span></div>
<div class="line"><a name="l00034"></a><span class="lineno">   34</span>&#160;<span class="comment"> * it will be called on each and every object in the table. Note that</span></div>
<div class="line"><a name="l00035"></a><span class="lineno">   35</span>&#160;<span class="comment"> * &#39;free&#39; is a valid destructor.</span></div>
<div class="line"><a name="l00036"></a><span class="lineno">   36</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00037"></a><span class="lineno">   37</span>&#160;<span class="comment"> * @param[in] t The fanout table to destroy</span></div>
<div class="line"><a name="l00038"></a><span class="lineno">   38</span>&#160;<span class="comment"> * @param[in] destructor Function to call on data pointers in table</span></div>
<div class="line"><a name="l00039"></a><span class="lineno">   39</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00040"></a><span class="lineno">   40</span>&#160;<span class="keyword">extern</span> <span class="keywordtype">void</span> <a class="code" href="fanout_8h.html#abdd64908339b7ec3af9bae2eda1222c9">fanout_destroy</a>(<a class="code" href="fanout_8h.html#aae080da7798ee92f6fe63fd99384d92a">fanout_table</a> *t, <span class="keywordtype">void</span> (*destructor)(<span class="keywordtype">void</span> *));</div>
<div class="line"><a name="l00041"></a><span class="lineno">   41</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00042"></a><span class="lineno">   42</span>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00043"></a><span class="lineno">   43</span>&#160;<span class="comment"> * Return a pointer from the fanout table t</span></div>
<div class="line"><a name="l00044"></a><span class="lineno">   44</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00045"></a><span class="lineno">   45</span>&#160;<span class="comment"> * @param[in] t table to fetch from</span></div>
<div class="line"><a name="l00046"></a><span class="lineno">   46</span>&#160;<span class="comment"> * @param[in] key key to fetch</span></div>
<div class="line"><a name="l00047"></a><span class="lineno">   47</span>&#160;<span class="comment"> * @return NULL on errors; Pointer to data on success</span></div>
<div class="line"><a name="l00048"></a><span class="lineno">   48</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00049"></a><span class="lineno">   49</span>&#160;<span class="keyword">extern</span> <span class="keywordtype">void</span> *<a class="code" href="fanout_8h.html#a1f99dbfe7905f4dfb742a26ba5fa212e">fanout_get</a>(<a class="code" href="fanout_8h.html#aae080da7798ee92f6fe63fd99384d92a">fanout_table</a> *t, <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> key);</div>
<div class="line"><a name="l00050"></a><span class="lineno">   50</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00051"></a><span class="lineno">   51</span>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00052"></a><span class="lineno">   52</span>&#160;<span class="comment"> * Add an entry to the fanout table.</span></div>
<div class="line"><a name="l00053"></a><span class="lineno">   53</span>&#160;<span class="comment"> * Note that we don&#39;t check if the key is unique. If it isn&#39;t,</span></div>
<div class="line"><a name="l00054"></a><span class="lineno">   54</span>&#160;<span class="comment"> * fanout_remove() will remove the latest added first.</span></div>
<div class="line"><a name="l00055"></a><span class="lineno">   55</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00056"></a><span class="lineno">   56</span>&#160;<span class="comment"> * @param[in] t fanout table to add to</span></div>
<div class="line"><a name="l00057"></a><span class="lineno">   57</span>&#160;<span class="comment"> * @param[in] key Key for this entry</span></div>
<div class="line"><a name="l00058"></a><span class="lineno">   58</span>&#160;<span class="comment"> * @param[in] data Data to add. Must not be NULL</span></div>
<div class="line"><a name="l00059"></a><span class="lineno">   59</span>&#160;<span class="comment"> * @return 0 on success, -1 on errors</span></div>
<div class="line"><a name="l00060"></a><span class="lineno">   60</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00061"></a><span class="lineno">   61</span>&#160;<span class="keyword">extern</span> <span class="keywordtype">int</span> <a class="code" href="fanout_8h.html#ad1cbfc3dbf61cc791b551b31463bdf4d">fanout_add</a>(<a class="code" href="fanout_8h.html#aae080da7798ee92f6fe63fd99384d92a">fanout_table</a> *t, <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> key, <span class="keywordtype">void</span> *data);</div>
<div class="line"><a name="l00062"></a><span class="lineno">   62</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00063"></a><span class="lineno">   63</span>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00064"></a><span class="lineno">   64</span>&#160;<span class="comment"> * Remove an entry from the fanout table and return its data.</span></div>
<div class="line"><a name="l00065"></a><span class="lineno">   65</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00066"></a><span class="lineno">   66</span>&#160;<span class="comment"> * @param[in] t fanout table to look in</span></div>
<div class="line"><a name="l00067"></a><span class="lineno">   67</span>&#160;<span class="comment"> * @param[in] key The key whose data we should locate</span></div>
<div class="line"><a name="l00068"></a><span class="lineno">   68</span>&#160;<span class="comment"> * @return Pointer to the data stored on success; NULL on errors</span></div>
<div class="line"><a name="l00069"></a><span class="lineno">   69</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00070"></a><span class="lineno">   70</span>&#160;<span class="keyword">extern</span> <span class="keywordtype">void</span> *<a class="code" href="fanout_8h.html#adbd76c7b84d983f84951630596f3d86d">fanout_remove</a>(<a class="code" href="fanout_8h.html#aae080da7798ee92f6fe63fd99384d92a">fanout_table</a> *t, <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> key);</div>
<div class="line"><a name="l00071"></a><span class="lineno">   71</span>&#160;<a class="code" href="lnag-utils_8h.html#a153dc411eb3334b8f7da41668144ce82">NAGIOS_END_DECL</a><span class="comment"></span></div>
<div class="line"><a name="l00072"></a><span class="lineno">   72</span>&#160;<span class="comment">/** @} */</span></div>
<div class="line"><a name="l00073"></a><span class="lineno">   73</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="ttc" id="fanout_8h_html_aae080da7798ee92f6fe63fd99384d92a"><div class="ttname"><a href="fanout_8h.html#aae080da7798ee92f6fe63fd99384d92a">fanout_table</a></div><div class="ttdeci">typedefNAGIOS_BEGIN_DECL struct fanout_table fanout_table</div><div class="ttdoc">Primary (opaque) type for this api. </div><div class="ttdef"><b>Definition:</b> fanout.h:21</div></div>
<div class="ttc" id="lnag-utils_8h_html_a153dc411eb3334b8f7da41668144ce82"><div class="ttname"><a href="lnag-utils_8h.html#a153dc411eb3334b8f7da41668144ce82">NAGIOS_END_DECL</a></div><div class="ttdeci">#define NAGIOS_END_DECL</div><div class="ttdoc">C++ compatibility macro that avoid confusing indentation programs. </div><div class="ttdef"><b>Definition:</b> lnag-utils.h:32</div></div>
<div class="ttc" id="fanout_8h_html_a49f13e43bf51ef34c7aae62ef33d74a0"><div class="ttname"><a href="fanout_8h.html#a49f13e43bf51ef34c7aae62ef33d74a0">fanout_create</a></div><div class="ttdeci">fanout_table * fanout_create(unsigned long size)</div><div class="ttdoc">Create a fanout table. </div></div>
<div class="ttc" id="lnag-utils_8h_html"><div class="ttname"><a href="lnag-utils_8h.html">lnag-utils.h</a></div><div class="ttdoc">libnagios helper and compatibility macros that lack a &amp;quot;real&amp;quot; home. </div></div>
<div class="ttc" id="fanout_8h_html_a1f99dbfe7905f4dfb742a26ba5fa212e"><div class="ttname"><a href="fanout_8h.html#a1f99dbfe7905f4dfb742a26ba5fa212e">fanout_get</a></div><div class="ttdeci">void * fanout_get(fanout_table *t, unsigned long key)</div><div class="ttdoc">Return a pointer from the fanout table t. </div></div>
<div class="ttc" id="fanout_8h_html_abdd64908339b7ec3af9bae2eda1222c9"><div class="ttname"><a href="fanout_8h.html#abdd64908339b7ec3af9bae2eda1222c9">fanout_destroy</a></div><div class="ttdeci">void fanout_destroy(fanout_table *t, void(*destructor)(void *))</div><div class="ttdoc">Destroy a fanout table, with optional destructor. </div></div>
<div class="ttc" id="fanout_8h_html_ad1cbfc3dbf61cc791b551b31463bdf4d"><div class="ttname"><a href="fanout_8h.html#ad1cbfc3dbf61cc791b551b31463bdf4d">fanout_add</a></div><div class="ttdeci">int fanout_add(fanout_table *t, unsigned long key, void *data)</div><div class="ttdoc">Add an entry to the fanout table. </div></div>
<div class="ttc" id="fanout_8h_html_adbd76c7b84d983f84951630596f3d86d"><div class="ttname"><a href="fanout_8h.html#adbd76c7b84d983f84951630596f3d86d">fanout_remove</a></div><div class="ttdeci">void * fanout_remove(fanout_table *t, unsigned long key)</div><div class="ttdoc">Remove an entry from the fanout table and return its data. </div></div>
<div class="ttc" id="lnag-utils_8h_html_aa15a8af3588df950f89ef7dc6eda43a8"><div class="ttname"><a href="lnag-utils_8h.html#aa15a8af3588df950f89ef7dc6eda43a8">NAGIOS_BEGIN_DECL</a></div><div class="ttdeci">#define NAGIOS_BEGIN_DECL</div><div class="ttdoc">C++ compatibility macro that avoids confusing indentation programs. </div><div class="ttdef"><b>Definition:</b> lnag-utils.h:30</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.5
</small></address>
</body>
</html>

Zerion Mini Shell 1.0