<!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 File Reference</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="summary"> <a href="#typedef-members">Typedefs</a> | <a href="#func-members">Functions</a> </div> <div class="headertitle"> <h1>include/sphinxbase/sbthread.h File Reference</h1> </div> </div> <div class="contents"> <p>Simple portable thread functions. <a href="#_details">More...</a></p> <div class="textblock"><code>#include <sphinx_config.h></code><br/> <code>#include <sphinxbase/sphinxbase_export.h></code><br/> <code>#include <sphinxbase/cmd_ln.h></code><br/> </div> <p><a href="sbthread_8h_source.html">Go to the source code of this file.</a></p> <table class="memberdecls"> <tr><td colspan="2"><h2><a name="typedef-members"></a> Typedefs</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a068f6028c760eee1e4eb4655ac7e7424"></a><!-- doxytag: member="sbthread.h::sbthread_t" ref="a068f6028c760eee1e4eb4655ac7e7424" args="" --> typedef struct <a class="el" href="structsbthread__s.html">sbthread_s</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="sbthread_8h.html#a068f6028c760eee1e4eb4655ac7e7424">sbthread_t</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Thread object. <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aad7adcc2e5f2fd6d2f429c25a52356ef"></a><!-- doxytag: member="sbthread.h::sbmsgq_t" ref="aad7adcc2e5f2fd6d2f429c25a52356ef" args="" --> typedef struct <a class="el" href="structsbmsgq__s.html">sbmsgq_s</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="sbthread_8h.html#aad7adcc2e5f2fd6d2f429c25a52356ef">sbmsgq_t</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Asynchronous message queue object. <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a21bc1100c4336693a6f25cdeec40cbec"></a><!-- doxytag: member="sbthread.h::sbmtx_t" ref="a21bc1100c4336693a6f25cdeec40cbec" args="" --> typedef struct <a class="el" href="structsbmtx__s.html">sbmtx_s</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="sbthread_8h.html#a21bc1100c4336693a6f25cdeec40cbec">sbmtx_t</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Mutex (critical section) object. <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a312dae368aa1662b07f199ea802cdefa"></a><!-- doxytag: member="sbthread.h::sbevent_t" ref="a312dae368aa1662b07f199ea802cdefa" args="" --> typedef struct <a class="el" href="structsbevent__s.html">sbevent_s</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="sbthread_8h.html#a312dae368aa1662b07f199ea802cdefa">sbevent_t</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Event object. <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="acb30b2ddcf70058f8bd38d68920be777"></a><!-- doxytag: member="sbthread.h::sbthread_main" ref="acb30b2ddcf70058f8bd38d68920be777" args=")(sbthread_t *th)" --> typedef int(* </td><td class="memItemRight" valign="bottom"><a class="el" href="sbthread_8h.html#acb30b2ddcf70058f8bd38d68920be777">sbthread_main</a> )(<a class="el" href="structsbthread__s.html">sbthread_t</a> *th)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Entry point for a thread. <br/></td></tr> <tr><td colspan="2"><h2><a name="func-members"></a> Functions</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="abfe1f703f4e17a2940c88d86d1987a8f"></a><!-- doxytag: member="sbthread.h::sbthread_start" ref="abfe1f703f4e17a2940c88d86d1987a8f" args="(cmd_ln_t *config, sbthread_main func, void *arg)" --> SPHINXBASE_EXPORT <a class="el" href="structsbthread__s.html">sbthread_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="sbthread_8h.html#abfe1f703f4e17a2940c88d86d1987a8f">sbthread_start</a> (<a class="el" href="structcmd__ln__t.html">cmd_ln_t</a> *config, <a class="el" href="sbthread_8h.html#acb30b2ddcf70058f8bd38d68920be777">sbthread_main</a> func, void *arg)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Start a new thread. <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a09c5c428b02b743c99d20bb2b11d964b"></a><!-- doxytag: member="sbthread.h::sbthread_wait" ref="a09c5c428b02b743c99d20bb2b11d964b" args="(sbthread_t *th)" --> SPHINXBASE_EXPORT int </td><td class="memItemRight" valign="bottom"><a class="el" href="sbthread_8h.html#a09c5c428b02b743c99d20bb2b11d964b">sbthread_wait</a> (<a class="el" href="structsbthread__s.html">sbthread_t</a> *th)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Wait for a thread to complete. <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa7827b760dfa47d95141f4896698e5c5"></a><!-- doxytag: member="sbthread.h::sbthread_free" ref="aa7827b760dfa47d95141f4896698e5c5" args="(sbthread_t *th)" --> SPHINXBASE_EXPORT void </td><td class="memItemRight" valign="bottom"><a class="el" href="sbthread_8h.html#aa7827b760dfa47d95141f4896698e5c5">sbthread_free</a> (<a class="el" href="structsbthread__s.html">sbthread_t</a> *th)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Free a thread object. <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab03c2f299f3e94b9f53aac1c1eaa0695"></a><!-- doxytag: member="sbthread.h::sbthread_config" ref="ab03c2f299f3e94b9f53aac1c1eaa0695" args="(sbthread_t *th)" --> SPHINXBASE_EXPORT <a class="el" href="structcmd__ln__t.html">cmd_ln_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="sbthread_8h.html#ab03c2f299f3e94b9f53aac1c1eaa0695">sbthread_config</a> (<a class="el" href="structsbthread__s.html">sbthread_t</a> *th)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Get configuration object from a thread. <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a130f2273128498e0f1d875cf6c0c2928"></a><!-- doxytag: member="sbthread.h::sbthread_arg" ref="a130f2273128498e0f1d875cf6c0c2928" args="(sbthread_t *th)" --> SPHINXBASE_EXPORT void * </td><td class="memItemRight" valign="bottom"><a class="el" href="sbthread_8h.html#a130f2273128498e0f1d875cf6c0c2928">sbthread_arg</a> (<a class="el" href="structsbthread__s.html">sbthread_t</a> *th)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Get argument pointer from a thread. <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5dfe1b7bb9c8d9aea7339e99a89307af"></a><!-- doxytag: member="sbthread.h::sbthread_msgq" ref="a5dfe1b7bb9c8d9aea7339e99a89307af" args="(sbthread_t *th)" --> SPHINXBASE_EXPORT <a class="el" href="structsbmsgq__s.html">sbmsgq_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="sbthread_8h.html#a5dfe1b7bb9c8d9aea7339e99a89307af">sbthread_msgq</a> (<a class="el" href="structsbthread__s.html">sbthread_t</a> *th)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Get message queue from a thread. <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">SPHINXBASE_EXPORT int </td><td class="memItemRight" valign="bottom"><a class="el" href="sbthread_8h.html#a932830409403ab4a03f0ffefe907551e">sbthread_send</a> (<a class="el" href="structsbthread__s.html">sbthread_t</a> *th, size_t len, void const *data)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Send an asynchronous message to a thread. <a href="#a932830409403ab4a03f0ffefe907551e"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">SPHINXBASE_EXPORT <a class="el" href="structsbmsgq__s.html">sbmsgq_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="sbthread_8h.html#a535a4d0d3f71c30f32d75b6268cc5e1e">sbmsgq_init</a> (size_t depth)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Create a message queue. <a href="#a535a4d0d3f71c30f32d75b6268cc5e1e"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab1ab59934422a5fac90ce0c4b66ffcc8"></a><!-- doxytag: member="sbthread.h::sbmsgq_free" ref="ab1ab59934422a5fac90ce0c4b66ffcc8" args="(sbmsgq_t *q)" --> SPHINXBASE_EXPORT void </td><td class="memItemRight" valign="bottom"><a class="el" href="sbthread_8h.html#ab1ab59934422a5fac90ce0c4b66ffcc8">sbmsgq_free</a> (<a class="el" href="structsbmsgq__s.html">sbmsgq_t</a> *q)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Free a message queue. <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab0591b5cb626be52dd22edf8fa13a3e3"></a><!-- doxytag: member="sbthread.h::sbmsgq_send" ref="ab0591b5cb626be52dd22edf8fa13a3e3" args="(sbmsgq_t *q, size_t len, void const *data)" --> SPHINXBASE_EXPORT int </td><td class="memItemRight" valign="bottom"><a class="el" href="sbthread_8h.html#ab0591b5cb626be52dd22edf8fa13a3e3">sbmsgq_send</a> (<a class="el" href="structsbmsgq__s.html">sbmsgq_t</a> *q, size_t len, void const *data)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Post a message to a queue. <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab3a421d172a92ef5ad371442a66767b5"></a><!-- doxytag: member="sbthread.h::sbmsgq_wait" ref="ab3a421d172a92ef5ad371442a66767b5" args="(sbmsgq_t *q, size_t *out_len, int sec, int nsec)" --> SPHINXBASE_EXPORT void * </td><td class="memItemRight" valign="bottom"><a class="el" href="sbthread_8h.html#ab3a421d172a92ef5ad371442a66767b5">sbmsgq_wait</a> (<a class="el" href="structsbmsgq__s.html">sbmsgq_t</a> *q, size_t *out_len, int sec, int nsec)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Wait for a message from a queue. <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a28067c5be5370074d21668620a68b229"></a><!-- doxytag: member="sbthread.h::sbmtx_init" ref="a28067c5be5370074d21668620a68b229" args="(void)" --> SPHINXBASE_EXPORT <a class="el" href="structsbmtx__s.html">sbmtx_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="sbthread_8h.html#a28067c5be5370074d21668620a68b229">sbmtx_init</a> (void)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Create a mutex. <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3b86c81160360234944737b4eab73125"></a><!-- doxytag: member="sbthread.h::sbmtx_trylock" ref="a3b86c81160360234944737b4eab73125" args="(sbmtx_t *mtx)" --> SPHINXBASE_EXPORT int </td><td class="memItemRight" valign="bottom"><a class="el" href="sbthread_8h.html#a3b86c81160360234944737b4eab73125">sbmtx_trylock</a> (<a class="el" href="structsbmtx__s.html">sbmtx_t</a> *mtx)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Try to acquire a mutex. <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6615e839f7c8ef3ebb6b288525f002cd"></a><!-- doxytag: member="sbthread.h::sbmtx_lock" ref="a6615e839f7c8ef3ebb6b288525f002cd" args="(sbmtx_t *mtx)" --> SPHINXBASE_EXPORT int </td><td class="memItemRight" valign="bottom"><a class="el" href="sbthread_8h.html#a6615e839f7c8ef3ebb6b288525f002cd">sbmtx_lock</a> (<a class="el" href="structsbmtx__s.html">sbmtx_t</a> *mtx)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Acquire a mutex. <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af65691258c916c68f1b5d000aaea233f"></a><!-- doxytag: member="sbthread.h::sbmtx_unlock" ref="af65691258c916c68f1b5d000aaea233f" args="(sbmtx_t *mtx)" --> SPHINXBASE_EXPORT int </td><td class="memItemRight" valign="bottom"><a class="el" href="sbthread_8h.html#af65691258c916c68f1b5d000aaea233f">sbmtx_unlock</a> (<a class="el" href="structsbmtx__s.html">sbmtx_t</a> *mtx)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Release a mutex. <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa17a6a93744eb813ca80bf098c69bdba"></a><!-- doxytag: member="sbthread.h::sbmtx_free" ref="aa17a6a93744eb813ca80bf098c69bdba" args="(sbmtx_t *mtx)" --> SPHINXBASE_EXPORT void </td><td class="memItemRight" valign="bottom"><a class="el" href="sbthread_8h.html#aa17a6a93744eb813ca80bf098c69bdba">sbmtx_free</a> (<a class="el" href="structsbmtx__s.html">sbmtx_t</a> *mtx)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Dispose of a mutex. <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1b3fa1cf6b82dcd82ab8d4124ab12490"></a><!-- doxytag: member="sbthread.h::sbevent_init" ref="a1b3fa1cf6b82dcd82ab8d4124ab12490" args="(void)" --> SPHINXBASE_EXPORT <a class="el" href="structsbevent__s.html">sbevent_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="sbthread_8h.html#a1b3fa1cf6b82dcd82ab8d4124ab12490">sbevent_init</a> (void)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Initialize an event. <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="afe8253a0e804a019ad0d8c540eec75af"></a><!-- doxytag: member="sbthread.h::sbevent_free" ref="afe8253a0e804a019ad0d8c540eec75af" args="(sbevent_t *evt)" --> SPHINXBASE_EXPORT void </td><td class="memItemRight" valign="bottom"><a class="el" href="sbthread_8h.html#afe8253a0e804a019ad0d8c540eec75af">sbevent_free</a> (<a class="el" href="structsbevent__s.html">sbevent_t</a> *evt)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Free an event. <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7c01e3e70c2ab8e961d59db84aa5fa68"></a><!-- doxytag: member="sbthread.h::sbevent_signal" ref="a7c01e3e70c2ab8e961d59db84aa5fa68" args="(sbevent_t *evt)" --> SPHINXBASE_EXPORT int </td><td class="memItemRight" valign="bottom"><a class="el" href="sbthread_8h.html#a7c01e3e70c2ab8e961d59db84aa5fa68">sbevent_signal</a> (<a class="el" href="structsbevent__s.html">sbevent_t</a> *evt)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Signal an event. <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac211760e4dffccf0102db65fb6f2c5b3"></a><!-- doxytag: member="sbthread.h::sbevent_wait" ref="ac211760e4dffccf0102db65fb6f2c5b3" args="(sbevent_t *evt, int sec, int nsec)" --> SPHINXBASE_EXPORT int </td><td class="memItemRight" valign="bottom"><a class="el" href="sbthread_8h.html#ac211760e4dffccf0102db65fb6f2c5b3">sbevent_wait</a> (<a class="el" href="structsbevent__s.html">sbevent_t</a> *evt, int sec, int nsec)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Wait for an event to be signalled. <br/></td></tr> </table> <hr/><a name="_details"></a><h2>Detailed Description</h2> <div class="textblock"><p>Simple portable thread functions. </p> <dl class="author"><dt><b>Author:</b></dt><dd>David Huggins-Daines <<a href="mailto:dhuggins@cs.cmu.edu">dhuggins@cs.cmu.edu</a>> </dd></dl> <p>Definition in file <a class="el" href="sbthread_8h_source.html">sbthread.h</a>.</p> </div><hr/><h2>Function Documentation</h2> <a class="anchor" id="a535a4d0d3f71c30f32d75b6268cc5e1e"></a><!-- doxytag: member="sbthread.h::sbmsgq_init" ref="a535a4d0d3f71c30f32d75b6268cc5e1e" args="(size_t depth)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">SPHINXBASE_EXPORT <a class="el" href="structsbmsgq__s.html">sbmsgq_t</a>* sbmsgq_init </td> <td>(</td> <td class="paramtype">size_t </td> <td class="paramname"><em>depth</em></td><td>)</td> <td></td> </tr> </table> </div> <div class="memdoc"> <p>Create a message queue. </p> <dl><dt><b>Parameters:</b></dt><dd> <table class="params"> <tr><td class="paramname">depth</td><td>Depth of the queue. </td></tr> </table> </dd> </dl> <p>Definition at line <a class="el" href="sbthread_8c_source.html#l00444">444</a> of file <a class="el" href="sbthread_8c_source.html">sbthread.c</a>.</p> <p>References <a class="el" href="ckd__alloc_8h_source.html#l00248">ckd_calloc</a>, and <a class="el" href="ckd__alloc_8c_source.html#l00241">ckd_free()</a>.</p> <p>Referenced by <a class="el" href="sbthread_8c_source.html#l00406">sbthread_start()</a>.</p> </div> </div> <a class="anchor" id="a932830409403ab4a03f0ffefe907551e"></a><!-- doxytag: member="sbthread.h::sbthread_send" ref="a932830409403ab4a03f0ffefe907551e" args="(sbthread_t *th, size_t len, void const *data)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">SPHINXBASE_EXPORT int sbthread_send </td> <td>(</td> <td class="paramtype"><a class="el" href="structsbthread__s.html">sbthread_t</a> * </td> <td class="paramname"><em>th</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">size_t </td> <td class="paramname"><em>len</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">void const * </td> <td class="paramname"><em>data</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div> <div class="memdoc"> <p>Send an asynchronous message to a thread. </p> <p>Each thread gets a message queue by default, so this is just a wrapper around <a class="el" href="sbthread_8h.html#ab0591b5cb626be52dd22edf8fa13a3e3" title="Post a message to a queue.">sbmsgq_send()</a>. </p> <p>Definition at line <a class="el" href="sbthread_8c_source.html#l00728">728</a> of file <a class="el" href="sbthread_8c_source.html">sbthread.c</a>.</p> <p>References <a class="el" href="sbthread_8c_source.html#l00475">sbmsgq_send()</a>.</p> </div> </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>