<!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>GNU Radio 3.2.2 C++ API: realtime.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
</script>
<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">GNU Radio 3.2.2 C++ API</div>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
initNavTree('realtime_8h.html','');
</script>
<div id="doc-content">
<div class="header">
<div class="headertitle">
<h1>realtime.h</h1> </div>
</div>
<div class="contents">
<a href="realtime_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/* -*- c++ -*- */</span>
<a name="l00002"></a>00002 <span class="comment">/*</span>
<a name="l00003"></a>00003 <span class="comment"> * Copyright 2006,2008 Free Software Foundation, Inc.</span>
<a name="l00004"></a>00004 <span class="comment"> * </span>
<a name="l00005"></a>00005 <span class="comment"> * This file is part of GNU Radio</span>
<a name="l00006"></a>00006 <span class="comment"> * </span>
<a name="l00007"></a>00007 <span class="comment"> * GNU Radio is free software; you can redistribute it and/or modify</span>
<a name="l00008"></a>00008 <span class="comment"> * it under the terms of the GNU General Public License as published by</span>
<a name="l00009"></a>00009 <span class="comment"> * the Free Software Foundation; either version 3, or (at your option)</span>
<a name="l00010"></a>00010 <span class="comment"> * any later version.</span>
<a name="l00011"></a>00011 <span class="comment"> * </span>
<a name="l00012"></a>00012 <span class="comment"> * GNU Radio is distributed in the hope that it will be useful,</span>
<a name="l00013"></a>00013 <span class="comment"> * but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
<a name="l00014"></a>00014 <span class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the</span>
<a name="l00015"></a>00015 <span class="comment"> * GNU General Public License for more details.</span>
<a name="l00016"></a>00016 <span class="comment"> * </span>
<a name="l00017"></a>00017 <span class="comment"> * You should have received a copy of the GNU General Public License</span>
<a name="l00018"></a>00018 <span class="comment"> * along with GNU Radio; see the file COPYING. If not, write to</span>
<a name="l00019"></a>00019 <span class="comment"> * the Free Software Foundation, Inc., 51 Franklin Street,</span>
<a name="l00020"></a>00020 <span class="comment"> * Boston, MA 02110-1301, USA.</span>
<a name="l00021"></a>00021 <span class="comment"> */</span>
<a name="l00022"></a>00022
<a name="l00023"></a>00023 <span class="preprocessor">#ifndef INCLUDED_GRUEL_REALTIME_H</span>
<a name="l00024"></a>00024 <span class="preprocessor"></span><span class="preprocessor">#define INCLUDED_GRUEL_REALTIME_H</span>
<a name="l00025"></a>00025 <span class="preprocessor"></span>
<a name="l00026"></a>00026 <span class="preprocessor">#include <stdexcept></span>
<a name="l00027"></a>00027 <span class="comment"></span>
<a name="l00028"></a>00028 <span class="comment">/*!</span>
<a name="l00029"></a>00029 <span class="comment"> * \brief System independent way to ask for realtime scheduling</span>
<a name="l00030"></a>00030 <span class="comment"> *</span>
<a name="l00031"></a>00031 <span class="comment"> * \sa sys_pri.h</span>
<a name="l00032"></a>00032 <span class="comment"> */</span>
<a name="l00033"></a>00033
<a name="l00034"></a>00034 <span class="keyword">namespace </span>gruel {
<a name="l00035"></a>00035
<a name="l00036"></a>00036 <span class="keyword">typedef</span> <span class="keyword">enum</span> {
<a name="l00037"></a>00037 RT_OK = 0,
<a name="l00038"></a>00038 RT_NOT_IMPLEMENTED,
<a name="l00039"></a>00039 RT_NO_PRIVS,
<a name="l00040"></a>00040 RT_OTHER_ERROR
<a name="l00041"></a>00041 } rt_status_t;
<a name="l00042"></a>00042
<a name="l00043"></a>00043
<a name="l00044"></a>00044 <span class="keyword">enum</span> rt_sched_policy {
<a name="l00045"></a>00045 RT_SCHED_RR = 0, <span class="comment">// round robin</span>
<a name="l00046"></a>00046 RT_SCHED_FIFO = 1, <span class="comment">// first in first out</span>
<a name="l00047"></a>00047 };
<a name="l00048"></a>00048
<a name="l00049"></a>00049 <span class="comment">/*</span>
<a name="l00050"></a>00050 <span class="comment"> * Define the range for our virtual priorities (don't change these)</span>
<a name="l00051"></a>00051 <span class="comment"> *</span>
<a name="l00052"></a>00052 <span class="comment"> * Processes (or threads) with numerically higher priority values</span>
<a name="l00053"></a>00053 <span class="comment"> * are scheduled before processes with numerically lower priority</span>
<a name="l00054"></a>00054 <span class="comment"> * values. Thus, the value returned by rt_priority_max() will be</span>
<a name="l00055"></a>00055 <span class="comment"> * greater than the value returned by rt_priority_min().</span>
<a name="l00056"></a>00056 <span class="comment"> */</span>
<a name="l00057"></a>00057 <span class="keyword">static</span> <span class="keyword">inline</span> <span class="keywordtype">int</span> rt_priority_min() { <span class="keywordflow">return</span> 0; }
<a name="l00058"></a>00058 <span class="keyword">static</span> <span class="keyword">inline</span> <span class="keywordtype">int</span> rt_priority_max() { <span class="keywordflow">return</span> 15; }
<a name="l00059"></a>00059 <span class="keyword">static</span> <span class="keyword">inline</span> <span class="keywordtype">int</span> rt_priority_default() { <span class="keywordflow">return</span> 1; }
<a name="l00060"></a>00060
<a name="l00061"></a><a class="code" href="structgruel_1_1rt__sched__param.html">00061</a> <span class="keyword">struct </span><a class="code" href="structgruel_1_1rt__sched__param.html">rt_sched_param</a> {
<a name="l00062"></a><a class="code" href="structgruel_1_1rt__sched__param.html#ae3b1bc20d91fa2e614aa7bb483866be6">00062</a> <span class="keywordtype">int</span> <a class="code" href="structgruel_1_1rt__sched__param.html#ae3b1bc20d91fa2e614aa7bb483866be6">priority</a>;
<a name="l00063"></a><a class="code" href="structgruel_1_1rt__sched__param.html#af42388ca3382b9f646228f9a391f1dbc">00063</a> rt_sched_policy <a class="code" href="structgruel_1_1rt__sched__param.html#af42388ca3382b9f646228f9a391f1dbc">policy</a>;
<a name="l00064"></a>00064
<a name="l00065"></a><a class="code" href="structgruel_1_1rt__sched__param.html#a7592c8e69e3a07cc8ac0b0bf9339df70">00065</a> <a class="code" href="structgruel_1_1rt__sched__param.html#a7592c8e69e3a07cc8ac0b0bf9339df70">rt_sched_param</a>()
<a name="l00066"></a>00066 : <a class="code" href="structgruel_1_1rt__sched__param.html#ae3b1bc20d91fa2e614aa7bb483866be6">priority</a>(rt_priority_default()), <a class="code" href="structgruel_1_1rt__sched__param.html#af42388ca3382b9f646228f9a391f1dbc">policy</a>(RT_SCHED_RR){}
<a name="l00067"></a>00067
<a name="l00068"></a><a class="code" href="structgruel_1_1rt__sched__param.html#a5257e726503db28d31aa4f780ddead47">00068</a> <a class="code" href="structgruel_1_1rt__sched__param.html#a7592c8e69e3a07cc8ac0b0bf9339df70">rt_sched_param</a>(<span class="keywordtype">int</span> priority_, rt_sched_policy policy_ = RT_SCHED_RR)
<a name="l00069"></a>00069 {
<a name="l00070"></a>00070 <span class="keywordflow">if</span> (priority_ < rt_priority_min() || priority_ > rt_priority_max())
<a name="l00071"></a>00071 <span class="keywordflow">throw</span> std::invalid_argument(<span class="stringliteral">"rt_sched_param: priority out of range"</span>);
<a name="l00072"></a>00072
<a name="l00073"></a>00073 <a class="code" href="structgruel_1_1rt__sched__param.html#ae3b1bc20d91fa2e614aa7bb483866be6">priority</a> = priority_;
<a name="l00074"></a>00074 <a class="code" href="structgruel_1_1rt__sched__param.html#af42388ca3382b9f646228f9a391f1dbc">policy</a> = policy_;
<a name="l00075"></a>00075 }
<a name="l00076"></a>00076 };
<a name="l00077"></a>00077 <span class="comment"></span>
<a name="l00078"></a>00078 <span class="comment"> /*!</span>
<a name="l00079"></a>00079 <span class="comment"> * \brief If possible, enable "realtime" scheduling.</span>
<a name="l00080"></a>00080 <span class="comment"> * \ingroup misc</span>
<a name="l00081"></a>00081 <span class="comment"> *</span>
<a name="l00082"></a>00082 <span class="comment"> * In general, this means that the code will be scheduled before any</span>
<a name="l00083"></a>00083 <span class="comment"> * non-realtime (normal) processes. Note that if your code contains</span>
<a name="l00084"></a>00084 <span class="comment"> * an non-blocking infinite loop and you enable realtime scheduling,</span>
<a name="l00085"></a>00085 <span class="comment"> * it's possible to hang the system.</span>
<a name="l00086"></a>00086 <span class="comment"> */</span>
<a name="l00087"></a>00087
<a name="l00088"></a>00088 <span class="comment">// NOTE: If you change this, you need to change the code in </span>
<a name="l00089"></a>00089 <span class="comment">// gnuradio-core/src/lib/runtime/gr_realtime.i, see note there.</span>
<a name="l00090"></a>00090 rt_status_t
<a name="l00091"></a>00091 <a class="code" href="group__misc.html#gadde7fc3925a3b1f5c919523740281728" title="If possible, enable &quot;realtime&quot; scheduling.In general, this means that the code will be sche...">enable_realtime_scheduling</a>(rt_sched_param = rt_sched_param());
<a name="l00092"></a>00092
<a name="l00093"></a>00093 } <span class="comment">// namespace gruel</span>
<a name="l00094"></a>00094
<a name="l00095"></a>00095 <span class="preprocessor">#endif </span><span class="comment">/* INCLUDED_GRUEL_REALTIME_H */</span>
</pre></div></div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="realtime_8h.html">realtime.h</a> </li>
<li class="footer">Generated on Thu Feb 17 2011 for GNU Radio 3.2.2 C++ API by 
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.3 </li>
</ul>
</div>
</body>
</html>
distrib
>
Fedora
>
14
>
x86_64
>
media
>
updates
>
by-pkgid
>
6e7a2755bd78c9deedab199b86e675f3
>
files
>
6798
