<!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>SphinxBase: include/sphinxbase/sbthread.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">SphinxBase <span id="projectnumber">0.6</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="annotated.html"><span>Data 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 List</span></a></li> <li><a href="globals.html"><span>Globals</span></a></li> </ul> </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('sbthread_8h.html',''); </script> <div id="doc-content"> <div class="header"> <div class="headertitle"> <h1>include/sphinxbase/sbthread.h</h1> </div> </div> <div class="contents"> <a href="sbthread_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-basic-offset: 4; indent-tabs-mode: nil -*- */</span> <a name="l00002"></a>00002 <span class="comment">/* ====================================================================</span> <a name="l00003"></a>00003 <span class="comment"> * Copyright (c) 2008 Carnegie Mellon University. All rights</span> <a name="l00004"></a>00004 <span class="comment"> * reserved.</span> <a name="l00005"></a>00005 <span class="comment"> *</span> <a name="l00006"></a>00006 <span class="comment"> * Redistribution and use in source and binary forms, with or without</span> <a name="l00007"></a>00007 <span class="comment"> * modification, are permitted provided that the following conditions</span> <a name="l00008"></a>00008 <span class="comment"> * are met:</span> <a name="l00009"></a>00009 <span class="comment"> *</span> <a name="l00010"></a>00010 <span class="comment"> * 1. Redistributions of source code must retain the above copyright</span> <a name="l00011"></a>00011 <span class="comment"> * notice, this list of conditions and the following disclaimer. </span> <a name="l00012"></a>00012 <span class="comment"> *</span> <a name="l00013"></a>00013 <span class="comment"> * 2. Redistributions in binary form must reproduce the above copyright</span> <a name="l00014"></a>00014 <span class="comment"> * notice, this list of conditions and the following disclaimer in</span> <a name="l00015"></a>00015 <span class="comment"> * the documentation and/or other materials provided with the</span> <a name="l00016"></a>00016 <span class="comment"> * distribution.</span> <a name="l00017"></a>00017 <span class="comment"> *</span> <a name="l00018"></a>00018 <span class="comment"> * This work was supported in part by funding from the Defense Advanced </span> <a name="l00019"></a>00019 <span class="comment"> * Research Projects Agency and the National Science Foundation of the </span> <a name="l00020"></a>00020 <span class="comment"> * United States of America, and the CMU Sphinx Speech Consortium.</span> <a name="l00021"></a>00021 <span class="comment"> *</span> <a name="l00022"></a>00022 <span class="comment"> * THIS SOFTWARE IS PROVIDED BY CARNEGIE MELLON UNIVERSITY ``AS IS'' AND </span> <a name="l00023"></a>00023 <span class="comment"> * ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, </span> <a name="l00024"></a>00024 <span class="comment"> * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR</span> <a name="l00025"></a>00025 <span class="comment"> * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL CARNEGIE MELLON UNIVERSITY</span> <a name="l00026"></a>00026 <span class="comment"> * NOR ITS EMPLOYEES BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,</span> <a name="l00027"></a>00027 <span class="comment"> * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT </span> <a name="l00028"></a>00028 <span class="comment"> * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, </span> <a name="l00029"></a>00029 <span class="comment"> * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY </span> <a name="l00030"></a>00030 <span class="comment"> * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT </span> <a name="l00031"></a>00031 <span class="comment"> * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE </span> <a name="l00032"></a>00032 <span class="comment"> * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.</span> <a name="l00033"></a>00033 <span class="comment"> *</span> <a name="l00034"></a>00034 <span class="comment"> * ====================================================================</span> <a name="l00035"></a>00035 <span class="comment"> *</span> <a name="l00036"></a>00036 <span class="comment"> */</span> <a name="l00043"></a>00043 <span class="preprocessor">#ifndef __SBTHREAD_H__</span> <a name="l00044"></a>00044 <span class="preprocessor"></span><span class="preprocessor">#define __SBTHREAD_H__</span> <a name="l00045"></a>00045 <span class="preprocessor"></span> <a name="l00046"></a>00046 <span class="preprocessor">#include <sphinx_config.h></span> <a name="l00047"></a>00047 <a name="l00048"></a>00048 <span class="preprocessor">#include <sphinxbase/sphinxbase_export.h></span> <a name="l00049"></a>00049 <span class="preprocessor">#include <sphinxbase/cmd_ln.h></span> <a name="l00050"></a>00050 <a name="l00051"></a>00051 <span class="preprocessor">#ifdef __cplusplus</span> <a name="l00052"></a>00052 <span class="preprocessor"></span><span class="keyword">extern</span> <span class="stringliteral">"C"</span> { <a name="l00053"></a>00053 <span class="preprocessor">#endif</span> <a name="l00054"></a>00054 <span class="preprocessor"></span><span class="preprocessor">#if 0</span> <a name="l00055"></a>00055 <span class="preprocessor"></span><span class="comment">/* Fool Emacs. */</span> <a name="l00056"></a>00056 } <a name="l00057"></a>00057 <span class="preprocessor">#endif</span> <a name="l00058"></a>00058 <span class="preprocessor"></span> <a name="l00062"></a><a class="code" href="sbthread_8h.html#a068f6028c760eee1e4eb4655ac7e7424">00062</a> <span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="structsbthread__s.html">sbthread_s</a> <a class="code" href="structsbthread__s.html">sbthread_t</a>; <a name="l00063"></a>00063 <a name="l00067"></a><a class="code" href="sbthread_8h.html#aad7adcc2e5f2fd6d2f429c25a52356ef">00067</a> <span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="structsbmsgq__s.html">sbmsgq_s</a> <a class="code" href="structsbmsgq__s.html">sbmsgq_t</a>; <a name="l00068"></a>00068 <a name="l00072"></a><a class="code" href="sbthread_8h.html#a21bc1100c4336693a6f25cdeec40cbec">00072</a> <span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="structsbmtx__s.html">sbmtx_s</a> <a class="code" href="structsbmtx__s.html">sbmtx_t</a>; <a name="l00073"></a>00073 <a name="l00077"></a><a class="code" href="sbthread_8h.html#a312dae368aa1662b07f199ea802cdefa">00077</a> <span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="structsbevent__s.html">sbevent_s</a> <a class="code" href="structsbevent__s.html">sbevent_t</a>; <a name="l00078"></a>00078 <a name="l00082"></a><a class="code" href="sbthread_8h.html#acb30b2ddcf70058f8bd38d68920be777">00082</a> <span class="keyword">typedef</span> int (*<a class="code" href="sbthread_8h.html#acb30b2ddcf70058f8bd38d68920be777" title="Entry point for a thread.">sbthread_main</a>)(<a class="code" href="structsbthread__s.html">sbthread_t</a> *th); <a name="l00083"></a>00083 <a name="l00087"></a>00087 SPHINXBASE_EXPORT <a name="l00088"></a>00088 <a class="code" href="structsbthread__s.html">sbthread_t</a> *<a class="code" href="sbthread_8h.html#abfe1f703f4e17a2940c88d86d1987a8f" title="Start a new thread.">sbthread_start</a>(<a class="code" href="structcmd__ln__t.html" title="Opaque structure used to hold the results of command-line parsing.">cmd_ln_t</a> *config, <a class="code" href="sbthread_8h.html#acb30b2ddcf70058f8bd38d68920be777" title="Entry point for a thread.">sbthread_main</a> func, <span class="keywordtype">void</span> *arg); <a name="l00089"></a>00089 <a name="l00093"></a>00093 SPHINXBASE_EXPORT <a name="l00094"></a>00094 <span class="keywordtype">int</span> <a class="code" href="sbthread_8h.html#a09c5c428b02b743c99d20bb2b11d964b" title="Wait for a thread to complete.">sbthread_wait</a>(<a class="code" href="structsbthread__s.html">sbthread_t</a> *th); <a name="l00095"></a>00095 <a name="l00099"></a>00099 SPHINXBASE_EXPORT <a name="l00100"></a>00100 <span class="keywordtype">void</span> <a class="code" href="sbthread_8h.html#aa7827b760dfa47d95141f4896698e5c5" title="Free a thread object.">sbthread_free</a>(<a class="code" href="structsbthread__s.html">sbthread_t</a> *th); <a name="l00101"></a>00101 <a name="l00105"></a>00105 SPHINXBASE_EXPORT <a name="l00106"></a>00106 <a class="code" href="structcmd__ln__t.html" title="Opaque structure used to hold the results of command-line parsing.">cmd_ln_t</a> *<a class="code" href="sbthread_8h.html#ab03c2f299f3e94b9f53aac1c1eaa0695" title="Get configuration object from a thread.">sbthread_config</a>(<a class="code" href="structsbthread__s.html">sbthread_t</a> *th); <a name="l00107"></a>00107 <a name="l00111"></a>00111 SPHINXBASE_EXPORT <a name="l00112"></a>00112 <span class="keywordtype">void</span> *<a class="code" href="sbthread_8h.html#a130f2273128498e0f1d875cf6c0c2928" title="Get argument pointer from a thread.">sbthread_arg</a>(<a class="code" href="structsbthread__s.html">sbthread_t</a> *th); <a name="l00113"></a>00113 <a name="l00117"></a>00117 SPHINXBASE_EXPORT <a name="l00118"></a>00118 <a class="code" href="structsbmsgq__s.html">sbmsgq_t</a> *<a class="code" href="sbthread_8h.html#a5dfe1b7bb9c8d9aea7339e99a89307af" title="Get message queue from a thread.">sbthread_msgq</a>(<a class="code" href="structsbthread__s.html">sbthread_t</a> *th); <a name="l00119"></a>00119 <a name="l00123"></a>00123 SPHINXBASE_EXPORT <a name="l00124"></a>00124 <span class="keywordtype">int</span> <a class="code" href="sbthread_8h.html#a09c5c428b02b743c99d20bb2b11d964b" title="Wait for a thread to complete.">sbthread_wait</a>(<a class="code" href="structsbthread__s.html">sbthread_t</a> *th); <a name="l00125"></a>00125 <a name="l00132"></a>00132 SPHINXBASE_EXPORT <a name="l00133"></a>00133 <span class="keywordtype">int</span> <a class="code" href="sbthread_8h.html#a932830409403ab4a03f0ffefe907551e" title="Send an asynchronous message to a thread.">sbthread_send</a>(<a class="code" href="structsbthread__s.html">sbthread_t</a> *th, <span class="keywordtype">size_t</span> len, <span class="keywordtype">void</span> <span class="keyword">const</span> *data); <a name="l00134"></a>00134 <a name="l00140"></a>00140 SPHINXBASE_EXPORT <a name="l00141"></a>00141 <a class="code" href="structsbmsgq__s.html">sbmsgq_t</a> *<a class="code" href="sbthread_8h.html#a535a4d0d3f71c30f32d75b6268cc5e1e" title="Create a message queue.">sbmsgq_init</a>(<span class="keywordtype">size_t</span> depth); <a name="l00142"></a>00142 <a name="l00146"></a>00146 SPHINXBASE_EXPORT <a name="l00147"></a>00147 <span class="keywordtype">void</span> <a class="code" href="sbthread_8h.html#ab1ab59934422a5fac90ce0c4b66ffcc8" title="Free a message queue.">sbmsgq_free</a>(<a class="code" href="structsbmsgq__s.html">sbmsgq_t</a> *q); <a name="l00148"></a>00148 <a name="l00152"></a>00152 SPHINXBASE_EXPORT <a name="l00153"></a>00153 <span class="keywordtype">int</span> <a class="code" href="sbthread_8h.html#ab0591b5cb626be52dd22edf8fa13a3e3" title="Post a message to a queue.">sbmsgq_send</a>(<a class="code" href="structsbmsgq__s.html">sbmsgq_t</a> *q, <span class="keywordtype">size_t</span> len, <span class="keywordtype">void</span> <span class="keyword">const</span> *data); <a name="l00154"></a>00154 <a name="l00158"></a>00158 SPHINXBASE_EXPORT <a name="l00159"></a>00159 <span class="keywordtype">void</span> *<a class="code" href="sbthread_8h.html#ab3a421d172a92ef5ad371442a66767b5" title="Wait for a message from a queue.">sbmsgq_wait</a>(<a class="code" href="structsbmsgq__s.html">sbmsgq_t</a> *q, <span class="keywordtype">size_t</span> *out_len, <span class="keywordtype">int</span> sec, <span class="keywordtype">int</span> nsec); <a name="l00160"></a>00160 <a name="l00164"></a>00164 SPHINXBASE_EXPORT <a name="l00165"></a>00165 <a class="code" href="structsbmtx__s.html">sbmtx_t</a> *<a class="code" href="sbthread_8h.html#a28067c5be5370074d21668620a68b229" title="Create a mutex.">sbmtx_init</a>(<span class="keywordtype">void</span>); <a name="l00166"></a>00166 <a name="l00170"></a>00170 SPHINXBASE_EXPORT <a name="l00171"></a>00171 <span class="keywordtype">int</span> <a class="code" href="sbthread_8h.html#a3b86c81160360234944737b4eab73125" title="Try to acquire a mutex.">sbmtx_trylock</a>(<a class="code" href="structsbmtx__s.html">sbmtx_t</a> *mtx); <a name="l00172"></a>00172 <a name="l00176"></a>00176 SPHINXBASE_EXPORT <a name="l00177"></a>00177 <span class="keywordtype">int</span> <a class="code" href="sbthread_8h.html#a6615e839f7c8ef3ebb6b288525f002cd" title="Acquire a mutex.">sbmtx_lock</a>(<a class="code" href="structsbmtx__s.html">sbmtx_t</a> *mtx); <a name="l00178"></a>00178 <a name="l00182"></a>00182 SPHINXBASE_EXPORT <a name="l00183"></a>00183 <span class="keywordtype">int</span> <a class="code" href="sbthread_8h.html#af65691258c916c68f1b5d000aaea233f" title="Release a mutex.">sbmtx_unlock</a>(<a class="code" href="structsbmtx__s.html">sbmtx_t</a> *mtx); <a name="l00184"></a>00184 <a name="l00188"></a>00188 SPHINXBASE_EXPORT <a name="l00189"></a>00189 <span class="keywordtype">void</span> <a class="code" href="sbthread_8h.html#aa17a6a93744eb813ca80bf098c69bdba" title="Dispose of a mutex.">sbmtx_free</a>(<a class="code" href="structsbmtx__s.html">sbmtx_t</a> *mtx); <a name="l00190"></a>00190 <a name="l00194"></a>00194 SPHINXBASE_EXPORT <a name="l00195"></a>00195 <a class="code" href="structsbevent__s.html">sbevent_t</a> *<a class="code" href="sbthread_8h.html#a1b3fa1cf6b82dcd82ab8d4124ab12490" title="Initialize an event.">sbevent_init</a>(<span class="keywordtype">void</span>); <a name="l00196"></a>00196 <a name="l00200"></a>00200 SPHINXBASE_EXPORT <a name="l00201"></a>00201 <span class="keywordtype">void</span> <a class="code" href="sbthread_8h.html#afe8253a0e804a019ad0d8c540eec75af" title="Free an event.">sbevent_free</a>(<a class="code" href="structsbevent__s.html">sbevent_t</a> *evt); <a name="l00202"></a>00202 <a name="l00206"></a>00206 SPHINXBASE_EXPORT <a name="l00207"></a>00207 <span class="keywordtype">int</span> <a class="code" href="sbthread_8h.html#a7c01e3e70c2ab8e961d59db84aa5fa68" title="Signal an event.">sbevent_signal</a>(<a class="code" href="structsbevent__s.html">sbevent_t</a> *evt); <a name="l00208"></a>00208 <a name="l00212"></a>00212 SPHINXBASE_EXPORT <a name="l00213"></a>00213 <span class="keywordtype">int</span> <a class="code" href="sbthread_8h.html#ac211760e4dffccf0102db65fb6f2c5b3" title="Wait for an event to be signalled.">sbevent_wait</a>(<a class="code" href="structsbevent__s.html">sbevent_t</a> *evt, <span class="keywordtype">int</span> sec, <span class="keywordtype">int</span> nsec); <a name="l00214"></a>00214 <a name="l00215"></a>00215 <a name="l00216"></a>00216 <span class="preprocessor">#ifdef __cplusplus</span> <a name="l00217"></a>00217 <span class="preprocessor"></span>} <a name="l00218"></a>00218 <span class="preprocessor">#endif</span> <a name="l00219"></a>00219 <span class="preprocessor"></span> <a name="l00220"></a>00220 <a name="l00221"></a>00221 <span class="preprocessor">#endif </span><span class="comment">/* __SBTHREAD_H__ */</span> </pre></div></div> </div> <div id="nav-path" class="navpath"> <ul> <li class="navelem"><a class="el" href="sbthread_8h.html">sbthread.h</a> </li> <li class="footer">Generated on Tue Apr 19 2011 for SphinxBase 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>