<!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>Jack2: JackMessageBuffer.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">Jack2 <span id="projectnumber">1.9.7</span></div>
</td>
</tr>
</tbody>
</table>
</div>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>File Members</span></a></li>
</ul>
</div>
<div class="header">
<div class="headertitle">
<h1>JackMessageBuffer.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"> * messagebuffer.h -- realtime-safe message interface for jackd.</span>
<a name="l00003"></a>00003 <span class="comment"> *</span>
<a name="l00004"></a>00004 <span class="comment"> * This function is included in libjack so backend drivers can use</span>
<a name="l00005"></a>00005 <span class="comment"> * it, *not* for external client processes. The VERBOSE() and</span>
<a name="l00006"></a>00006 <span class="comment"> * MESSAGE() macros are realtime-safe.</span>
<a name="l00007"></a>00007 <span class="comment"> */</span>
<a name="l00008"></a>00008
<a name="l00009"></a>00009 <span class="comment">/*</span>
<a name="l00010"></a>00010 <span class="comment"> * Copyright (C) 2004 Rui Nuno Capela, Steve Harris</span>
<a name="l00011"></a>00011 <span class="comment"> * Copyright (C) 2008 Nedko Arnaudov</span>
<a name="l00012"></a>00012 <span class="comment"> * Copyright (C) 2008 Grame</span>
<a name="l00013"></a>00013 <span class="comment"> * </span>
<a name="l00014"></a>00014 <span class="comment"> * This program is free software; you can redistribute it and/or modify</span>
<a name="l00015"></a>00015 <span class="comment"> * it under the terms of the GNU Lesser General Public License as published by</span>
<a name="l00016"></a>00016 <span class="comment"> * the Free Software Foundation; either version 2.1 of the License, or</span>
<a name="l00017"></a>00017 <span class="comment"> * (at your option) any later version.</span>
<a name="l00018"></a>00018 <span class="comment"> * </span>
<a name="l00019"></a>00019 <span class="comment"> * This program is distributed in the hope that it will be useful,</span>
<a name="l00020"></a>00020 <span class="comment"> * but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
<a name="l00021"></a>00021 <span class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the</span>
<a name="l00022"></a>00022 <span class="comment"> * GNU Lesser General Public License for more details.</span>
<a name="l00023"></a>00023 <span class="comment"> * </span>
<a name="l00024"></a>00024 <span class="comment"> * You should have received a copy of the GNU Lesser General Public License</span>
<a name="l00025"></a>00025 <span class="comment"> * along with this program; if not, write to the Free Software </span>
<a name="l00026"></a>00026 <span class="comment"> * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.</span>
<a name="l00027"></a>00027 <span class="comment"> *</span>
<a name="l00028"></a>00028 <span class="comment"> */</span>
<a name="l00029"></a>00029
<a name="l00030"></a>00030 <span class="preprocessor">#ifndef __JackMessageBuffer__</span>
<a name="l00031"></a>00031 <span class="preprocessor"></span><span class="preprocessor">#define __JackMessageBuffer__</span>
<a name="l00032"></a>00032 <span class="preprocessor"></span>
<a name="l00033"></a>00033 <span class="preprocessor">#include "JackPlatformPlug.h"</span>
<a name="l00034"></a>00034 <span class="preprocessor">#include "JackMutex.h"</span>
<a name="l00035"></a>00035 <span class="preprocessor">#include "JackAtomic.h"</span>
<a name="l00036"></a>00036
<a name="l00037"></a>00037 <span class="keyword">namespace </span>Jack
<a name="l00038"></a>00038 {
<a name="l00039"></a>00039
<a name="l00040"></a>00040 <span class="comment">/* MB_NEXT() relies on the fact that MB_BUFFERS is a power of two */</span>
<a name="l00041"></a>00041 <span class="preprocessor">#define MB_BUFFERS 128</span>
<a name="l00042"></a>00042 <span class="preprocessor"></span><span class="preprocessor">#define MB_NEXT(index) ((index+1) & (MB_BUFFERS-1))</span>
<a name="l00043"></a>00043 <span class="preprocessor"></span><span class="preprocessor">#define MB_BUFFERSIZE 256 </span><span class="comment">/* message length limit */</span>
<a name="l00044"></a>00044
<a name="l00045"></a><a class="code" href="structJack_1_1JackMessage.html">00045</a> <span class="keyword">struct </span><a class="code" href="structJack_1_1JackMessage.html">JackMessage</a>
<a name="l00046"></a>00046 {
<a name="l00047"></a>00047 <span class="keywordtype">int</span> level;
<a name="l00048"></a>00048 <span class="keywordtype">char</span> message[MB_BUFFERSIZE];
<a name="l00049"></a>00049 };
<a name="l00050"></a>00050
<a name="l00055"></a><a class="code" href="classJack_1_1JackMessageBuffer.html">00055</a> <span class="keyword">class </span><a class="code" href="classJack_1_1JackMessageBuffer.html" title="Message buffer to be used from RT threads.">JackMessageBuffer</a> : <span class="keyword">public</span> <a class="code" href="classJack_1_1JackRunnableInterface.html" title="The base class for runnable objects, that have an Init and Execute method to be called in a threa...">JackRunnableInterface</a>
<a name="l00056"></a>00056 {
<a name="l00057"></a>00057
<a name="l00058"></a>00058 <span class="keyword">private</span>:
<a name="l00059"></a>00059
<a name="l00060"></a>00060 JackThreadInitCallback fInit;
<a name="l00061"></a>00061 <span class="keywordtype">void</span>* fInitArg;
<a name="l00062"></a>00062 <a class="code" href="structJack_1_1JackMessage.html">JackMessage</a> fBuffers[MB_BUFFERS];
<a name="l00063"></a>00063 <a class="code" href="classJack_1_1JackMachThread.html" title="Darwin threads. Real-time threads are actually &quot;time constraint&quot; threads.">JackThread</a> fThread;
<a name="l00064"></a>00064 <a class="code" href="classJack_1_1JackProcessSync.html" title="A synchronization primitive built using a condition variable.">JackProcessSync</a> fGuard;
<a name="l00065"></a>00065 <span class="keyword">volatile</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> fInBuffer;
<a name="l00066"></a>00066 <span class="keyword">volatile</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> fOutBuffer;
<a name="l00067"></a>00067 SInt32 fOverruns;
<a name="l00068"></a>00068 <span class="keywordtype">bool</span> fRunning;
<a name="l00069"></a>00069
<a name="l00070"></a>00070 <span class="keywordtype">void</span> Flush();
<a name="l00071"></a>00071
<a name="l00072"></a>00072 <span class="keywordtype">void</span> Start();
<a name="l00073"></a>00073 <span class="keywordtype">void</span> Stop();
<a name="l00074"></a>00074
<a name="l00075"></a>00075 <span class="keyword">public</span>:
<a name="l00076"></a>00076
<a name="l00077"></a>00077 <a class="code" href="classJack_1_1JackMessageBuffer.html" title="Message buffer to be used from RT threads.">JackMessageBuffer</a>();
<a name="l00078"></a>00078 ~<a class="code" href="classJack_1_1JackMessageBuffer.html" title="Message buffer to be used from RT threads.">JackMessageBuffer</a>();
<a name="l00079"></a>00079
<a name="l00080"></a>00080 <span class="comment">// JackRunnableInterface interface</span>
<a name="l00081"></a>00081 <span class="keywordtype">bool</span> Execute();
<a name="l00082"></a>00082
<a name="l00083"></a>00083 <span class="keywordtype">void</span> <span class="keyword">static</span> Create();
<a name="l00084"></a>00084 <span class="keywordtype">void</span> <span class="keyword">static</span> Destroy();
<a name="l00085"></a>00085
<a name="l00086"></a>00086 <span class="keywordtype">void</span> AddMessage(<span class="keywordtype">int</span> level, <span class="keyword">const</span> <span class="keywordtype">char</span> *message);
<a name="l00087"></a>00087 <span class="keywordtype">void</span> SetInitCallback(JackThreadInitCallback callback, <span class="keywordtype">void</span> *arg);
<a name="l00088"></a>00088
<a name="l00089"></a>00089 <span class="keyword">static</span> <a class="code" href="classJack_1_1JackMessageBuffer.html" title="Message buffer to be used from RT threads.">JackMessageBuffer</a>* fInstance;
<a name="l00090"></a>00090 };
<a name="l00091"></a>00091
<a name="l00092"></a>00092 <span class="preprocessor">#ifdef __cplusplus</span>
<a name="l00093"></a>00093 <span class="preprocessor"></span><span class="keyword">extern</span> <span class="stringliteral">"C"</span>
<a name="l00094"></a>00094 {
<a name="l00095"></a>00095 <span class="preprocessor">#endif</span>
<a name="l00096"></a>00096 <span class="preprocessor"></span>
<a name="l00097"></a>00097 <span class="keywordtype">void</span> JackMessageBufferAdd(<span class="keywordtype">int</span> level, <span class="keyword">const</span> <span class="keywordtype">char</span> *message);
<a name="l00098"></a>00098
<a name="l00099"></a>00099 <span class="preprocessor">#ifdef __cplusplus</span>
<a name="l00100"></a>00100 <span class="preprocessor"></span>}
<a name="l00101"></a>00101 <span class="preprocessor">#endif</span>
<a name="l00102"></a>00102 <span class="preprocessor"></span>
<a name="l00103"></a>00103 };
<a name="l00104"></a>00104
<a name="l00105"></a>00105 <span class="preprocessor">#endif </span>
</pre></div></div>
</div>
<hr size="1"><address style="text-align: right;"><small>
Generated for Jack2 by <a href="http://www.doxygen.org/
index.html"><img src="doxygen.png" alt="doxygen" align="middle" border="0"></a>
1.7.3</small></address>
</body>
</html>
