Repository URL to install this package:
|
Version:
6.3.5.2-2 ▾
|
<!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.5"/>
<title>LibreOffice: salhelper/thread.hxx 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/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</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 style="padding-left: 0.5em;">
<div id="projectname">LibreOffice
</div>
<div id="projectbrief">LibreOffice 6.3 SDK C/C++ API Reference</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
<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="namespaces.html"><span>Namespaces</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>
<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>File Members</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)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(11)"><span class="SelectionMark"> </span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(12)"><span class="SelectionMark"> </span>Pages</a></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_53aa4ad1b831e9847d1f4a68148b5df1.html">salhelper</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">thread.hxx</div> </div>
</div><!--header-->
<div class="contents">
<a href="a00418.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment">/*</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> * This file is part of the LibreOffice project.</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> * This Source Code Form is subject to the terms of the Mozilla Public</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> * License, v. 2.0. If a copy of the MPL was not distributed with this</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> * file, You can obtain one at http://mozilla.org/MPL/2.0/.</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> */</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">#ifndef INCLUDED_SALHELPER_THREAD_HXX</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="preprocessor"></span><span class="preprocessor">#define INCLUDED_SALHELPER_THREAD_HXX</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="preprocessor">#include "<a class="code" href="a00402.html">sal/config.h</a>"</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="preprocessor">#include <cstddef></span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> </div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="preprocessor">#include "<a class="code" href="a00419.html">osl/thread.hxx</a>"</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="preprocessor">#include "<a class="code" href="a00409.html">sal/types.h</a>"</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="preprocessor">#include "<a class="code" href="a00415.html">salhelper/salhelperdllapi.h</a>"</span></div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="preprocessor">#include "<a class="code" href="a00416.html">salhelper/simplereferenceobject.hxx</a>"</span></div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> </div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="keyword">namespace </span>salhelper {</div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> </div>
<div class="line"><a name="l00029"></a><span class="lineno"><a class="line" href="a00193.html"> 29</a></span> <span class="keyword">class </span><a class="code" href="a00415.html#a6ded12780a307ee48f7fce5f410d12e1">SALHELPER_DLLPUBLIC</a> <a class="code" href="a00193.html">Thread</a>:</div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>  <span class="keyword">public</span> <a class="code" href="a00183.html">salhelper::SimpleReferenceObject</a>, <span class="keyword">private</span> <a class="code" href="a00194.html">osl::Thread</a></div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span> {</div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="keyword">public</span>:</div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  <a class="code" href="a00193.html">Thread</a>(<span class="keywordtype">char</span> <span class="keyword">const</span> * name);</div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span> </div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  <span class="keywordtype">void</span> launch();</div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span> </div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  <span class="keyword">using</span> <a class="code" href="a00194.html#af5aa53837584b793b44c298f14614bdc">osl::Thread::getIdentifier</a>;</div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  <span class="keyword">using</span> <a class="code" href="a00194.html#a86f2212b5b0e5962380348139e5b7161">osl::Thread::join</a>;</div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  <span class="keyword">using</span> <a class="code" href="a00194.html#a6ed301a362205d777c6251a95b2573d6">osl::Thread::schedule</a>;</div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  <span class="keyword">using</span> <a class="code" href="a00194.html#af7ffa642d68ae530bc76b12ca5852ca6">osl::Thread::terminate</a>;</div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span> </div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  <span class="comment">// While the below static member functions should arguably always be called</span></div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  <span class="comment">// with qualified (osl::Thread) names, compilers would still complain that</span></div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  <span class="comment">// they are inaccessible from within derivations of salhelper::Thread (an</span></div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  <span class="comment">// alternative would be to force such derivations to use global names,</span></div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  <span class="comment">// prefixed with ::osl::Thread):</span></div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  <span class="keyword">using</span> <a class="code" href="a00194.html#a37d9d1da36d232a37f420c0a9916c51e">osl::Thread::getCurrentIdentifier</a>;</div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  <span class="keyword">using</span> <a class="code" href="a00194.html#ac51d11d3729116f912934ffefe9ad2d6">osl::Thread::wait</a>;</div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  <span class="keyword">using</span> <a class="code" href="a00194.html#a4bc475055ab6e109c1a9bf6274fc29c3">osl::Thread::yield</a>;</div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span> </div>
<div class="line"><a name="l00065"></a><span class="lineno"><a class="line" href="a00193.html#ad28db6566369cd22f1b6b37b39a236ab"> 65</a></span>  <span class="keyword">static</span> <span class="keywordtype">void</span> * <span class="keyword">operator</span> <span class="keyword">new</span>(std::size_t size)</div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  { <span class="keywordflow">return</span> SimpleReferenceObject::operator <span class="keyword">new</span>(size); }</div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span> </div>
<div class="line"><a name="l00068"></a><span class="lineno"><a class="line" href="a00193.html#a7c21a01cab1ee4af31f1b9392fbaebba"> 68</a></span>  <span class="keyword">static</span> <span class="keywordtype">void</span> <span class="keyword">operator</span> <span class="keyword">delete</span>(<span class="keywordtype">void</span> * pointer)</div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  { SimpleReferenceObject::operator <span class="keyword">delete</span>(pointer); }</div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span> </div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span> <span class="keyword">protected</span>:</div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  <span class="keyword">virtual</span> ~<a class="code" href="a00193.html">Thread</a>() <a class="code" href="a00409.html#a77ee0efccf64cd1370bbc78bf311563d">SAL_OVERRIDE</a>;</div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span> </div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  virtual <span class="keywordtype">void</span> execute() = 0;</div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span> </div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span> private:</div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  virtual <span class="keywordtype">void</span> SAL_CALL run() <a class="code" href="a00409.html#a77ee0efccf64cd1370bbc78bf311563d">SAL_OVERRIDE</a>;</div>
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span> </div>
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  virtual <span class="keywordtype">void</span> SAL_CALL onTerminated() SAL_OVERRIDE;</div>
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span> </div>
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span>  <span class="keywordtype">char</span> const * name_;</div>
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span> };</div>
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span> </div>
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span> }</div>
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span> </div>
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span> <span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span> <span class="comment">/* vim:set shiftwidth=4 softtabstop=4 expandtab: */</span></div>
<div class="ttc" id="a00194_html_a4bc475055ab6e109c1a9bf6274fc29c3"><div class="ttname"><a href="a00194.html#a4bc475055ab6e109c1a9bf6274fc29c3">osl::Thread::yield</a></div><div class="ttdeci">static void yield()</div><div class="ttdef"><b>Definition:</b> thread.hxx:146</div></div>
<div class="ttc" id="a00193_html"><div class="ttname"><a href="a00193.html">salhelper::Thread</a></div><div class="ttdoc">A safe encapsulation of osl::Thread. </div><div class="ttdef"><b>Definition:</b> thread.hxx:29</div></div>
<div class="ttc" id="a00415_html_a6ded12780a307ee48f7fce5f410d12e1"><div class="ttname"><a href="a00415.html#a6ded12780a307ee48f7fce5f410d12e1">SALHELPER_DLLPUBLIC</a></div><div class="ttdeci">#define SALHELPER_DLLPUBLIC</div><div class="ttdef"><b>Definition:</b> salhelperdllapi.h:28</div></div>
<div class="ttc" id="a00415_html"><div class="ttname"><a href="a00415.html">salhelperdllapi.h</a></div></div>
<div class="ttc" id="a00194_html_a37d9d1da36d232a37f420c0a9916c51e"><div class="ttname"><a href="a00194.html#a37d9d1da36d232a37f420c0a9916c51e">osl::Thread::getCurrentIdentifier</a></div><div class="ttdeci">static oslThreadIdentifier getCurrentIdentifier()</div><div class="ttdef"><b>Definition:</b> thread.hxx:136</div></div>
<div class="ttc" id="a00194_html_a86f2212b5b0e5962380348139e5b7161"><div class="ttname"><a href="a00194.html#a86f2212b5b0e5962380348139e5b7161">osl::Thread::join</a></div><div class="ttdeci">virtual void join()</div><div class="ttdef"><b>Definition:</b> thread.hxx:110</div></div>
<div class="ttc" id="a00409_html_a77ee0efccf64cd1370bbc78bf311563d"><div class="ttname"><a href="a00409.html#a77ee0efccf64cd1370bbc78bf311563d">SAL_OVERRIDE</a></div><div class="ttdeci">#define SAL_OVERRIDE</div><div class="ttdoc">C++11 &quot;override&quot; feature. </div><div class="ttdef"><b>Definition:</b> types.h:409</div></div>
<div class="ttc" id="a00409_html"><div class="ttname"><a href="a00409.html">types.h</a></div></div>
<div class="ttc" id="a00183_html"><div class="ttname"><a href="a00183.html">salhelper::SimpleReferenceObject</a></div><div class="ttdoc">A simple base implementation for reference-counted objects. </div><div class="ttdef"><b>Definition:</b> simplereferenceobject.hxx:57</div></div>
<div class="ttc" id="a00194_html_af7ffa642d68ae530bc76b12ca5852ca6"><div class="ttname"><a href="a00194.html#af7ffa642d68ae530bc76b12ca5852ca6">osl::Thread::terminate</a></div><div class="ttdeci">virtual void terminate()</div><div class="ttdef"><b>Definition:</b> thread.hxx:104</div></div>
<div class="ttc" id="a00194_html_ac51d11d3729116f912934ffefe9ad2d6"><div class="ttname"><a href="a00194.html#ac51d11d3729116f912934ffefe9ad2d6">osl::Thread::wait</a></div><div class="ttdeci">static void wait(const TimeValue &Delay)</div><div class="ttdef"><b>Definition:</b> thread.hxx:141</div></div>
<div class="ttc" id="a00194_html_af5aa53837584b793b44c298f14614bdc"><div class="ttname"><a href="a00194.html#af5aa53837584b793b44c298f14614bdc">osl::Thread::getIdentifier</a></div><div class="ttdeci">oslThreadIdentifier getIdentifier() const </div><div class="ttdef"><b>Definition:</b> thread.hxx:131</div></div>
<div class="ttc" id="a00194_html"><div class="ttname"><a href="a00194.html">osl::Thread</a></div><div class="ttdoc">A thread abstraction. </div><div class="ttdef"><b>Definition:</b> thread.hxx:48</div></div>
<div class="ttc" id="a00194_html_a6ed301a362205d777c6251a95b2573d6"><div class="ttname"><a href="a00194.html#a6ed301a362205d777c6251a95b2573d6">osl::Thread::schedule</a></div><div class="ttdeci">virtual bool schedule()</div><div class="ttdef"><b>Definition:</b> thread.hxx:155</div></div>
<div class="ttc" id="a00416_html"><div class="ttname"><a href="a00416.html">simplereferenceobject.hxx</a></div></div>
<div class="ttc" id="a00402_html"><div class="ttname"><a href="a00402.html">config.h</a></div></div>
<div class="ttc" id="a00419_html"><div class="ttname"><a href="a00419.html">thread.hxx</a></div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.5
</small></address>
</body>
</html>