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: osl/mutex.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/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_9104d818b51e97c3517d665975e33dee.html">osl</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">mutex.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="a00348.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> <span class="comment"> * This file incorporates work covered by the following license notice:</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> * Licensed to the Apache Software Foundation (ASF) under one or more</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> * contributor license agreements. See the NOTICE file distributed</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> * with this work for additional information regarding copyright</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> * ownership. The ASF licenses this file to you under the Apache</span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> * License, Version 2.0 (the "License"); you may not use this file</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> * except in compliance with the License. You may obtain a copy of</span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"> * the License at http://www.apache.org/licenses/LICENSE-2.0 .</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> </div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="preprocessor">#ifndef INCLUDED_OSL_MUTEX_H</span></div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor"></span><span class="preprocessor">#define INCLUDED_OSL_MUTEX_H</span></div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor">#include "<a class="code" href="a00402.html">sal/config.h</a>"</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">#include "<a class="code" href="a00408.html">sal/saldllapi.h</a>"</span></div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="preprocessor">#include "<a class="code" href="a00409.html">sal/types.h</a>"</span></div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> </div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="preprocessor">#ifdef __cplusplus</span></div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="preprocessor"></span><span class="keyword">extern</span> <span class="stringliteral">"C"</span> {</div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="keyword">struct </span>_oslMutexImpl;</div>
<div class="line"><a name="l00033"></a><span class="lineno"><a class="line" href="a00348.html#aae876adec74f28e33f7522654122a3a3"> 33</a></span> <span class="keyword">typedef</span> <span class="keyword">struct </span>_oslMutexImpl * <a class="code" href="a00348.html#aae876adec74f28e33f7522654122a3a3">oslMutex</a>;</div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span> </div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <a class="code" href="a00408.html#aca1813580da4b82e3a00f8f85570b480">SAL_DLLPUBLIC</a> oslMutex SAL_CALL <a class="code" href="a00348.html#ad16866ccd8fe21b37f26d6fedf6d55cf">osl_createMutex</a>(<span class="keywordtype">void</span>);</div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span> </div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <a class="code" href="a00408.html#aca1813580da4b82e3a00f8f85570b480">SAL_DLLPUBLIC</a> <span class="keywordtype">void</span> SAL_CALL <a class="code" href="a00348.html#a62a948c6f53ef8b7c50e4a10f03fc729">osl_destroyMutex</a>(oslMutex Mutex);</div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span> </div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span> <a class="code" href="a00408.html#aca1813580da4b82e3a00f8f85570b480">SAL_DLLPUBLIC</a> <a class="code" href="a00409.html#a66585e12aa9edc6e11fc7994e1c12286">sal_Bool</a> SAL_CALL <a class="code" href="a00348.html#a3e5b648750c19aeea6ad30187d353e5d">osl_acquireMutex</a>(oslMutex Mutex);</div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span> </div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span> <a class="code" href="a00408.html#aca1813580da4b82e3a00f8f85570b480">SAL_DLLPUBLIC</a> <a class="code" href="a00409.html#a66585e12aa9edc6e11fc7994e1c12286">sal_Bool</a> SAL_CALL <a class="code" href="a00348.html#ac1182f8e88661a667d9d78130db92eab">osl_tryToAcquireMutex</a>(oslMutex Mutex);</div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span> </div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span> <a class="code" href="a00408.html#aca1813580da4b82e3a00f8f85570b480">SAL_DLLPUBLIC</a> <a class="code" href="a00409.html#a66585e12aa9edc6e11fc7994e1c12286">sal_Bool</a> SAL_CALL <a class="code" href="a00348.html#a9d0a9f4739b669d87d791fad8b7b5a4c">osl_releaseMutex</a>(oslMutex Mutex);</div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span> </div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span> <a class="code" href="a00408.html#aca1813580da4b82e3a00f8f85570b480">SAL_DLLPUBLIC</a> oslMutex * SAL_CALL <a class="code" href="a00348.html#a57507eb574789672767b016af137a389">osl_getGlobalMutex</a>(<span class="keywordtype">void</span>);</div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span> </div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span> <span class="preprocessor">#ifdef __cplusplus</span></div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span> <span class="preprocessor"></span>}</div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span> <span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span> <span class="preprocessor">#endif // INCLUDED_OSL_MUTEX_H</span></div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span> <span class="comment">/* vim:set shiftwidth=4 softtabstop=4 expandtab: */</span></div>
<div class="ttc" id="a00348_html_ad16866ccd8fe21b37f26d6fedf6d55cf"><div class="ttname"><a href="a00348.html#ad16866ccd8fe21b37f26d6fedf6d55cf">osl_createMutex</a></div><div class="ttdeci">SAL_DLLPUBLIC oslMutex osl_createMutex(void)</div><div class="ttdoc">Create a mutex. </div></div>
<div class="ttc" id="a00348_html_a57507eb574789672767b016af137a389"><div class="ttname"><a href="a00348.html#a57507eb574789672767b016af137a389">osl_getGlobalMutex</a></div><div class="ttdeci">SAL_DLLPUBLIC oslMutex * osl_getGlobalMutex(void)</div><div class="ttdoc">Returns a unique and global mutex. </div></div>
<div class="ttc" id="a00409_html_a66585e12aa9edc6e11fc7994e1c12286"><div class="ttname"><a href="a00409.html#a66585e12aa9edc6e11fc7994e1c12286">sal_Bool</a></div><div class="ttdeci">unsigned char sal_Bool</div><div class="ttdef"><b>Definition:</b> types.h:38</div></div>
<div class="ttc" id="a00409_html"><div class="ttname"><a href="a00409.html">types.h</a></div></div>
<div class="ttc" id="a00408_html_aca1813580da4b82e3a00f8f85570b480"><div class="ttname"><a href="a00408.html#aca1813580da4b82e3a00f8f85570b480">SAL_DLLPUBLIC</a></div><div class="ttdeci">#define SAL_DLLPUBLIC</div><div class="ttdef"><b>Definition:</b> saldllapi.h:30</div></div>
<div class="ttc" id="a00348_html_aae876adec74f28e33f7522654122a3a3"><div class="ttname"><a href="a00348.html#aae876adec74f28e33f7522654122a3a3">oslMutex</a></div><div class="ttdeci">struct _oslMutexImpl * oslMutex</div><div class="ttdef"><b>Definition:</b> mutex.h:33</div></div>
<div class="ttc" id="a00348_html_a9d0a9f4739b669d87d791fad8b7b5a4c"><div class="ttname"><a href="a00348.html#a9d0a9f4739b669d87d791fad8b7b5a4c">osl_releaseMutex</a></div><div class="ttdeci">SAL_DLLPUBLIC sal_Bool osl_releaseMutex(oslMutex Mutex)</div><div class="ttdoc">Release the mutex. </div></div>
<div class="ttc" id="a00348_html_a3e5b648750c19aeea6ad30187d353e5d"><div class="ttname"><a href="a00348.html#a3e5b648750c19aeea6ad30187d353e5d">osl_acquireMutex</a></div><div class="ttdeci">SAL_DLLPUBLIC sal_Bool osl_acquireMutex(oslMutex Mutex)</div><div class="ttdoc">Acquire the mutex, block if already acquired by another thread. </div></div>
<div class="ttc" id="a00408_html"><div class="ttname"><a href="a00408.html">saldllapi.h</a></div></div>
<div class="ttc" id="a00348_html_a62a948c6f53ef8b7c50e4a10f03fc729"><div class="ttname"><a href="a00348.html#a62a948c6f53ef8b7c50e4a10f03fc729">osl_destroyMutex</a></div><div class="ttdeci">SAL_DLLPUBLIC void osl_destroyMutex(oslMutex Mutex)</div><div class="ttdoc">Release the OS-structures and free mutex data-structure. </div></div>
<div class="ttc" id="a00402_html"><div class="ttname"><a href="a00402.html">config.h</a></div></div>
<div class="ttc" id="a00348_html_ac1182f8e88661a667d9d78130db92eab"><div class="ttname"><a href="a00348.html#ac1182f8e88661a667d9d78130db92eab">osl_tryToAcquireMutex</a></div><div class="ttdeci">SAL_DLLPUBLIC sal_Bool osl_tryToAcquireMutex(oslMutex Mutex)</div><div class="ttdoc">Try to acquire the mutex without blocking. </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>