172 lines
15 KiB
HTML
172 lines
15 KiB
HTML
<!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"/>
|
|
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
|
|
<meta name="generator" content="Doxygen 1.8.10"/>
|
|
<title>VectorNav C Library: thread.h Source File</title>
|
|
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="jquery.js"></script>
|
|
<script type="text/javascript" src="dynsections.js"></script>
|
|
<link href="search/search.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="search/searchdata.js"></script>
|
|
<script type="text/javascript" src="search/search.js"></script>
|
|
<script type="text/javascript">
|
|
$(document).ready(function() { init_search(); });
|
|
</script>
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
|
</head>
|
|
<body>
|
|
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
|
<div id="titlearea">
|
|
<table cellspacing="0" cellpadding="0">
|
|
<tbody>
|
|
<tr style="height: 56px;">
|
|
<td id="projectlogo"><img alt="Logo" src="proglib.png"/></td>
|
|
<td id="projectalign" style="padding-left: 0.5em;">
|
|
<div id="projectname">VectorNav C Library
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.10 -->
|
|
<script type="text/javascript">
|
|
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
|
</script>
|
|
<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>Data Structures</span></a></li>
|
|
<li class="current"><a href="files.html"><span>Files</span></a></li>
|
|
<li><a href="examples.html"><span>Examples</span></a></li>
|
|
<li>
|
|
<div id="MSearchBox" class="MSearchBoxInactive">
|
|
<span class="left">
|
|
<img id="MSearchSelect" src="search/mag_sel.png"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
alt=""/>
|
|
<input type="text" id="MSearchField" value="Search" accesskey="S"
|
|
onfocus="searchBox.OnSearchFieldFocus(true)"
|
|
onblur="searchBox.OnSearchFieldFocus(false)"
|
|
onkeyup="searchBox.OnSearchFieldChange(event)"/>
|
|
</span><span class="right">
|
|
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
|
|
</span>
|
|
</div>
|
|
</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>
|
|
<!-- window showing the filter options -->
|
|
<div id="MSearchSelectWindow"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
|
</div>
|
|
|
|
<!-- iframe showing the search results (closed by default) -->
|
|
<div id="MSearchResultsWindow">
|
|
<iframe src="javascript:void(0)" frameborder="0"
|
|
name="MSearchResults" id="MSearchResults">
|
|
</iframe>
|
|
</div>
|
|
|
|
<div id="nav-path" class="navpath">
|
|
<ul>
|
|
<li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_8bde4b85f1f8cd0faa87b91375e717e4.html">vn</a></li><li class="navelem"><a class="el" href="dir_027780aa32961d07c4d51557f73a7d30.html">xplat</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="headertitle">
|
|
<div class="title">thread.h</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<a href="thread_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> </div>
|
|
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="preprocessor">#ifndef _VN_THREAD_H_</span></div>
|
|
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="preprocessor">#define _VN_THREAD_H_</span></div>
|
|
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> </div>
|
|
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="preprocessor">#include "vn/error.h"</span></div>
|
|
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="preprocessor">#include "vn/int.h"</span></div>
|
|
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> </div>
|
|
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="preprocessor">#ifdef _WIN32</span></div>
|
|
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> </div>
|
|
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>  <span class="comment">/* Disable some warnings for Visual Studio with -Wall. */</span></div>
|
|
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="preprocessor"> #if defined(_MSC_VER)</span></div>
|
|
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="preprocessor"> #pragma warning(push)</span></div>
|
|
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="preprocessor"> #pragma warning(disable:4668)</span></div>
|
|
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="preprocessor"> #pragma warning(disable:4820)</span></div>
|
|
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="preprocessor"> #pragma warning(disable:4255)</span></div>
|
|
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor"> #endif</span></div>
|
|
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> </div>
|
|
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor"> #include <Windows.h></span></div>
|
|
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> </div>
|
|
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor"> #if defined(_MSC_VER)</span></div>
|
|
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="preprocessor"> #pragma warning(pop)</span></div>
|
|
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="preprocessor"> #endif</span></div>
|
|
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> </div>
|
|
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="preprocessor">#endif</span></div>
|
|
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span> </div>
|
|
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="preprocessor">#if defined __linux__ || defined __APPLE__ || defined __CYGWIN__ || defined __QNXNTO__</span></div>
|
|
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="preprocessor"> #include <pthread.h></span></div>
|
|
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="preprocessor">#endif</span></div>
|
|
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span> </div>
|
|
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="preprocessor">#ifdef __cplusplus</span></div>
|
|
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="keyword">extern</span> <span class="stringliteral">"C"</span> {</div>
|
|
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="preprocessor">#endif</span></div>
|
|
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span> </div>
|
|
<div class="line"><a name="l00040"></a><span class="lineno"><a class="line" href="struct_vn_thread.html"> 40</a></span> <span class="keyword">typedef</span> <span class="keyword">struct</span></div>
|
|
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span> {</div>
|
|
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="preprocessor"> #ifdef _WIN32</span></div>
|
|
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  HANDLE handle;</div>
|
|
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="preprocessor"> #elif defined __linux__ || defined __APPLE__ || defined __CYGWIN__ || defined __QNXNTO__</span></div>
|
|
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  pthread_t handle;</div>
|
|
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="preprocessor"> #else</span></div>
|
|
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <span class="preprocessor"> #error "Unknown System"</span></div>
|
|
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <span class="preprocessor"> #endif</span></div>
|
|
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span> } <a class="code" href="struct_vn_thread.html">VnThread</a>;</div>
|
|
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span> </div>
|
|
<div class="line"><a name="l00052"></a><span class="lineno"><a class="line" href="thread_8h.html#a48573a28650e096f1af4a848caee6ea4"> 52</a></span> <span class="keyword">typedef</span> void (*<a class="code" href="thread_8h.html#a48573a28650e096f1af4a848caee6ea4">VnThread_StartRoutine</a>)(<span class="keywordtype">void</span>*);</div>
|
|
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span> </div>
|
|
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span> VnError <a class="code" href="thread_8h.html#a553c92d20be27b8e3c0155d002ac2397">VnThread_startNew</a>(<a class="code" href="struct_vn_thread.html">VnThread</a> *thread, <a class="code" href="thread_8h.html#a48573a28650e096f1af4a848caee6ea4">VnThread_StartRoutine</a> startRoutine, <span class="keywordtype">void</span>* routineData);</div>
|
|
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span> </div>
|
|
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span> VnError <a class="code" href="thread_8h.html#aad9e390fadd1d328f07169feb6bb7332">VnThread_join</a>(<a class="code" href="struct_vn_thread.html">VnThread</a> *thread);</div>
|
|
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span> </div>
|
|
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span> <span class="keywordtype">void</span> <a class="code" href="thread_8h.html#a4f80a22d8ebeab270653deeb86199726">VnThread_sleepSec</a>(uint32_t numOfSecsToSleep);</div>
|
|
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span> </div>
|
|
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span> <span class="keywordtype">void</span> <a class="code" href="thread_8h.html#ae184a96ccf6c94c4b9d7b937655b0c44">VnThread_sleepMs</a>(uint32_t numOfMsToSleep);</div>
|
|
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span> </div>
|
|
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span> <span class="keywordtype">void</span> <a class="code" href="thread_8h.html#a81cfc1ad5f4aa45b597e571e7a171beb">VnThread_sleepUs</a>(uint32_t numOfUsToSleep);</div>
|
|
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span> </div>
|
|
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span> <span class="preprocessor">#ifdef __cplusplus</span></div>
|
|
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span> }</div>
|
|
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span> <span class="preprocessor">#endif</span></div>
|
|
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span> </div>
|
|
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span> <span class="preprocessor">#endif</span></div>
|
|
<div class="ttc" id="thread_8h_html_aad9e390fadd1d328f07169feb6bb7332"><div class="ttname"><a href="thread_8h.html#aad9e390fadd1d328f07169feb6bb7332">VnThread_join</a></div><div class="ttdeci">VnError VnThread_join(VnThread *thread)</div><div class="ttdoc">Blocks the calling thread until the referenced thread finishes. </div></div>
|
|
<div class="ttc" id="thread_8h_html_a553c92d20be27b8e3c0155d002ac2397"><div class="ttname"><a href="thread_8h.html#a553c92d20be27b8e3c0155d002ac2397">VnThread_startNew</a></div><div class="ttdeci">VnError VnThread_startNew(VnThread *thread, VnThread_StartRoutine startRoutine, void *routineData)</div><div class="ttdoc">Starts a new thread immediately which calls the provided start routine. </div></div>
|
|
<div class="ttc" id="thread_8h_html_ae184a96ccf6c94c4b9d7b937655b0c44"><div class="ttname"><a href="thread_8h.html#ae184a96ccf6c94c4b9d7b937655b0c44">VnThread_sleepMs</a></div><div class="ttdeci">void VnThread_sleepMs(uint32_t numOfMsToSleep)</div><div class="ttdoc">Causes the calling thread to sleep the specified number of milliseconds. </div></div>
|
|
<div class="ttc" id="struct_vn_thread_html"><div class="ttname"><a href="struct_vn_thread.html">VnThread</a></div><div class="ttdoc">Structure for working with threads. </div><div class="ttdef"><b>Definition:</b> thread.h:40</div></div>
|
|
<div class="ttc" id="thread_8h_html_a81cfc1ad5f4aa45b597e571e7a171beb"><div class="ttname"><a href="thread_8h.html#a81cfc1ad5f4aa45b597e571e7a171beb">VnThread_sleepUs</a></div><div class="ttdeci">void VnThread_sleepUs(uint32_t numOfUsToSleep)</div><div class="ttdoc">Causes the calling thread to sleep the specified number of microseconds. </div></div>
|
|
<div class="ttc" id="thread_8h_html_a4f80a22d8ebeab270653deeb86199726"><div class="ttname"><a href="thread_8h.html#a4f80a22d8ebeab270653deeb86199726">VnThread_sleepSec</a></div><div class="ttdeci">void VnThread_sleepSec(uint32_t numOfSecsToSleep)</div><div class="ttdoc">Causes the calling thread to sleep the specified number of seconds. </div></div>
|
|
<div class="ttc" id="thread_8h_html_a48573a28650e096f1af4a848caee6ea4"><div class="ttname"><a href="thread_8h.html#a48573a28650e096f1af4a848caee6ea4">VnThread_StartRoutine</a></div><div class="ttdeci">void(* VnThread_StartRoutine)(void *)</div><div class="ttdoc">Function signature for a start routine for a thread. </div><div class="ttdef"><b>Definition:</b> thread.h:52</div></div>
|
|
</div><!-- fragment --></div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated on Tue Jan 3 2017 18:26:57 for VectorNav C Library by  <a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
|
</a> 1.8.10
|
|
</small></address>
|
|
</body>
|
|
</html>
|