<!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: src/libsphinxbase/util/sbthread.c 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_8c.html','');
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#nested-classes">Data Structures</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<h1>src/libsphinxbase/util/sbthread.c File Reference</h1> </div>
</div>
<div class="contents">
<p>Simple portable thread functions.
<a href="#_details">More...</a></p>
<div class="textblock"><code>#include <string.h></code><br/>
<code>#include "sphinxbase/sbthread.h"</code><br/>
<code>#include "sphinxbase/ckd_alloc.h"</code><br/>
<code>#include "sphinxbase/err.h"</code><br/>
<code>#include <pthread.h></code><br/>
<code>#include <sys/time.h></code><br/>
</div>
<p><a href="sbthread_8c_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structsbthread__s.html">sbthread_s</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structsbmsgq__s.html">sbmsgq_s</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structsbevent__s.html">sbevent_s</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structsbmtx__s.html">sbmtx_s</a></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="a0ba06f52feda5c218dc38373e930017c"></a><!-- doxytag: member="sbthread.c::sbthread_start" ref="a0ba06f52feda5c218dc38373e930017c" args="(cmd_ln_t *config, sbthread_main func, void *arg)" -->
<a class="el" href="structsbthread__s.html">sbthread_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="sbthread_8c.html#a0ba06f52feda5c218dc38373e930017c">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="ad4cc725834be72ea986f80c4f4ecb24d"></a><!-- doxytag: member="sbthread.c::sbthread_wait" ref="ad4cc725834be72ea986f80c4f4ecb24d" args="(sbthread_t *th)" -->
int </td><td class="memItemRight" valign="bottom"><a class="el" href="sbthread_8c.html#ad4cc725834be72ea986f80c4f4ecb24d">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="el" href="structsbmsgq__s.html">sbmsgq_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="sbthread_8c.html#a76852d201655b6f08ed6c35f6ebf8b4b">sbmsgq_init</a> (size_t depth)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create a message queue. <a href="#a76852d201655b6f08ed6c35f6ebf8b4b"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa8483d06a1456207643abcfebc3b2e0a"></a><!-- doxytag: member="sbthread.c::sbmsgq_free" ref="aa8483d06a1456207643abcfebc3b2e0a" args="(sbmsgq_t *msgq)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="sbthread_8c.html#aa8483d06a1456207643abcfebc3b2e0a">sbmsgq_free</a> (<a class="el" href="structsbmsgq__s.html">sbmsgq_t</a> *msgq)</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="ae6c214bf1fab2f10cb51648b7e736698"></a><!-- doxytag: member="sbthread.c::sbmsgq_send" ref="ae6c214bf1fab2f10cb51648b7e736698" args="(sbmsgq_t *q, size_t len, void const *data)" -->
int </td><td class="memItemRight" valign="bottom"><a class="el" href="sbthread_8c.html#ae6c214bf1fab2f10cb51648b7e736698">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="a5ef0a82190db1efc97e5921d2f822535"></a><!-- doxytag: member="sbthread.c::sbmsgq_wait" ref="a5ef0a82190db1efc97e5921d2f822535" args="(sbmsgq_t *q, size_t *out_len, int sec, int nsec)" -->
void * </td><td class="memItemRight" valign="bottom"><a class="el" href="sbthread_8c.html#a5ef0a82190db1efc97e5921d2f822535">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="ad6f018be06301acbfd2b41888ca1d345"></a><!-- doxytag: member="sbthread.c::sbevent_init" ref="ad6f018be06301acbfd2b41888ca1d345" args="(void)" -->
<a class="el" href="structsbevent__s.html">sbevent_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="sbthread_8c.html#ad6f018be06301acbfd2b41888ca1d345">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="abba6d18d863334a98eecbaf5ffe81ab1"></a><!-- doxytag: member="sbthread.c::sbevent_free" ref="abba6d18d863334a98eecbaf5ffe81ab1" args="(sbevent_t *evt)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="sbthread_8c.html#abba6d18d863334a98eecbaf5ffe81ab1">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="a89f88d25e27146dc7e4956211e69a6d5"></a><!-- doxytag: member="sbthread.c::sbevent_signal" ref="a89f88d25e27146dc7e4956211e69a6d5" args="(sbevent_t *evt)" -->
int </td><td class="memItemRight" valign="bottom"><a class="el" href="sbthread_8c.html#a89f88d25e27146dc7e4956211e69a6d5">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="a9f48001ca75395a3b192902b37edd5e0"></a><!-- doxytag: member="sbthread.c::sbevent_wait" ref="a9f48001ca75395a3b192902b37edd5e0" args="(sbevent_t *evt, int sec, int nsec)" -->
int </td><td class="memItemRight" valign="bottom"><a class="el" href="sbthread_8c.html#a9f48001ca75395a3b192902b37edd5e0">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>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a690fb21b06b7ef9f958a4a204bc04269"></a><!-- doxytag: member="sbthread.c::sbmtx_init" ref="a690fb21b06b7ef9f958a4a204bc04269" args="(void)" -->
<a class="el" href="structsbmtx__s.html">sbmtx_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="sbthread_8c.html#a690fb21b06b7ef9f958a4a204bc04269">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="aaca10c92363d8979100c8fddeb783f9a"></a><!-- doxytag: member="sbthread.c::sbmtx_trylock" ref="aaca10c92363d8979100c8fddeb783f9a" args="(sbmtx_t *mtx)" -->
int </td><td class="memItemRight" valign="bottom"><a class="el" href="sbthread_8c.html#aaca10c92363d8979100c8fddeb783f9a">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="a000d9d0610c6b91649edde95e3bafa6c"></a><!-- doxytag: member="sbthread.c::sbmtx_lock" ref="a000d9d0610c6b91649edde95e3bafa6c" args="(sbmtx_t *mtx)" -->
int </td><td class="memItemRight" valign="bottom"><a class="el" href="sbthread_8c.html#a000d9d0610c6b91649edde95e3bafa6c">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="ab3fdc55976e2b0581e598bd20187ce3a"></a><!-- doxytag: member="sbthread.c::sbmtx_unlock" ref="ab3fdc55976e2b0581e598bd20187ce3a" args="(sbmtx_t *mtx)" -->
int </td><td class="memItemRight" valign="bottom"><a class="el" href="sbthread_8c.html#ab3fdc55976e2b0581e598bd20187ce3a">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="af1f9eb876ca9fc93d6c548120af14197"></a><!-- doxytag: member="sbthread.c::sbmtx_free" ref="af1f9eb876ca9fc93d6c548120af14197" args="(sbmtx_t *mtx)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="sbthread_8c.html#af1f9eb876ca9fc93d6c548120af14197">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="a95c25385f31541c412a458deb9ee94e5"></a><!-- doxytag: member="sbthread.c::sbthread_config" ref="a95c25385f31541c412a458deb9ee94e5" args="(sbthread_t *th)" -->
<a class="el" href="structcmd__ln__t.html">cmd_ln_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="sbthread_8c.html#a95c25385f31541c412a458deb9ee94e5">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="a94e4cf2b756764e453b1469df79b3140"></a><!-- doxytag: member="sbthread.c::sbthread_arg" ref="a94e4cf2b756764e453b1469df79b3140" args="(sbthread_t *th)" -->
void * </td><td class="memItemRight" valign="bottom"><a class="el" href="sbthread_8c.html#a94e4cf2b756764e453b1469df79b3140">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="af13e76cf03ad458f48f9604ec4731bdc"></a><!-- doxytag: member="sbthread.c::sbthread_msgq" ref="af13e76cf03ad458f48f9604ec4731bdc" args="(sbthread_t *th)" -->
<a class="el" href="structsbmsgq__s.html">sbmsgq_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="sbthread_8c.html#af13e76cf03ad458f48f9604ec4731bdc">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">int </td><td class="memItemRight" valign="bottom"><a class="el" href="sbthread_8c.html#afae533b302b310a828cf2eed1f2f5995">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="#afae533b302b310a828cf2eed1f2f5995"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2b80d955dab72ff602d9048551dc7489"></a><!-- doxytag: member="sbthread.c::sbthread_free" ref="a2b80d955dab72ff602d9048551dc7489" args="(sbthread_t *th)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="sbthread_8c.html#a2b80d955dab72ff602d9048551dc7489">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>
</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_8c_source.html">sbthread.c</a>.</p>
</div><hr/><h2>Function Documentation</h2>
<a class="anchor" id="a76852d201655b6f08ed6c35f6ebf8b4b"></a><!-- doxytag: member="sbthread.c::sbmsgq_init" ref="a76852d201655b6f08ed6c35f6ebf8b4b" args="(size_t depth)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><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="afae533b302b310a828cf2eed1f2f5995"></a><!-- doxytag: member="sbthread.c::sbthread_send" ref="afae533b302b310a828cf2eed1f2f5995" args="(sbthread_t *th, size_t len, void const *data)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">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_8c.html">sbthread.c</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>
distrib
>
Fedora
>
14
>
x86_64
>
media
>
updates
>
by-pkgid
>
0b420d0fce195cf4115dc6a3be5c2da2
>
files
>
321
