1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
|
<!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>
<title>MySQL++ Reference Manual</title>
<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.15"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>MySQL++: beemutex.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.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>
<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="projectalign" style="padding-left: 0.5em;">
<div id="projectname">MySQL++
 <span id="projectnumber">3.2.5</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.15 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<!-- 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 class="header">
<div class="headertitle">
<div class="title">beemutex.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="beemutex_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="l00021"></a><span class="lineno"> 21</span> <span class="comment">/***********************************************************************</span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="comment"> Copyright © 2004 Beeyond Software Holding BV and © 2007-2008, 2018</span></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="comment"> by Educational Technology Resources, Inc. Others may also hold</span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="comment"> copyrights on code in this file. See the CREDITS.txt file in the</span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="comment"> top directory of the distribution for details.</span></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="comment"></span></div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="comment"> This file is part of MySQL++.</span></div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="comment"></span></div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="comment"> MySQL++ is free software; you can redistribute it and/or modify it</span></div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="comment"> under the terms of the GNU Lesser General Public License as published</span></div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="comment"> by the Free Software Foundation; either version 2.1 of the License, or</span></div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="comment"> (at your option) any later version.</span></div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="comment"></span></div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="comment"> MySQL++ is distributed in the hope that it will be useful, but WITHOUT</span></div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="comment"> ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or</span></div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="comment"> FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public</span></div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="comment"> License for more details.</span></div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="comment"></span></div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="comment"> You should have received a copy of the GNU Lesser General Public</span></div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="comment"> License along with MySQL++; if not, write to the Free Software</span></div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="comment"> Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301</span></div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="comment"> USA</span></div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="comment">***********************************************************************/</span></div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span> </div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="preprocessor">#if !defined(MYSQLPP_BEEMUTEX_H)</span></div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="preprocessor">#define MYSQLPP_BEEMUTEX_H</span></div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span> </div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <span class="preprocessor">#include "<a class="code" href="exceptions_8h.html">exceptions.h</a>"</span></div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span> </div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span> <span class="keyword">namespace </span>mysqlpp {</div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span> </div><div class="line"><a name="l00059"></a><span class="lineno"><a class="line" href="classmysqlpp_1_1BeecryptMutex.html"> 59</a></span> <span class="keyword">class </span>MYSQLPP_EXPORT <a class="code" href="classmysqlpp_1_1BeecryptMutex.html">BeecryptMutex</a></div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span> {</div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span> <span class="keyword">public</span>:</div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  <a class="code" href="classmysqlpp_1_1BeecryptMutex.html">BeecryptMutex</a>() MAY_THROW(<a class="code" href="classmysqlpp_1_1MutexFailed.html">MutexFailed</a>);</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>  ~<a class="code" href="classmysqlpp_1_1BeecryptMutex.html">BeecryptMutex</a>();</div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span> </div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  <span class="keywordtype">void</span> lock() MAY_THROW(<a class="code" href="classmysqlpp_1_1MutexFailed.html">MutexFailed</a>);</div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span> </div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  <span class="keywordtype">bool</span> trylock() MAY_THROW(<a class="code" href="classmysqlpp_1_1MutexFailed.html">MutexFailed</a>);</div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span> </div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  <span class="keywordtype">void</span> unlock() MAY_THROW(<a class="code" href="classmysqlpp_1_1MutexFailed.html">MutexFailed</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> <span class="keyword">private</span>:</div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  <span class="keywordtype">void</span>* pmutex_;</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> </div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span> </div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span> </div><div class="line"><a name="l00097"></a><span class="lineno"><a class="line" href="classmysqlpp_1_1ScopedLock.html"> 97</a></span> <span class="keyword">class </span><a class="code" href="classmysqlpp_1_1ScopedLock.html">ScopedLock</a></div><div class="line"><a name="l00098"></a><span class="lineno"> 98</span> {</div><div class="line"><a name="l00099"></a><span class="lineno"> 99</span> <span class="keyword">public</span>:</div><div class="line"><a name="l00101"></a><span class="lineno"><a class="line" href="classmysqlpp_1_1ScopedLock.html#a0684decf81a6915e06297ff0fec218e9"> 101</a></span>  <span class="keyword">explicit</span> <a class="code" href="classmysqlpp_1_1ScopedLock.html#a0684decf81a6915e06297ff0fec218e9">ScopedLock</a>(<a class="code" href="classmysqlpp_1_1BeecryptMutex.html">BeecryptMutex</a>& mutex) :</div><div class="line"><a name="l00102"></a><span class="lineno"> 102</span>  mutex_(mutex)</div><div class="line"><a name="l00103"></a><span class="lineno"> 103</span>  {</div><div class="line"><a name="l00104"></a><span class="lineno"> 104</span>  mutex.<a class="code" href="classmysqlpp_1_1BeecryptMutex.html#adb5f8dc007416c376826ac9461b82e87">lock</a>();</div><div class="line"><a name="l00105"></a><span class="lineno"> 105</span>  }</div><div class="line"><a name="l00106"></a><span class="lineno"> 106</span> </div><div class="line"><a name="l00108"></a><span class="lineno"><a class="line" href="classmysqlpp_1_1ScopedLock.html#a1f03bd9ff85a61bef0255c6f313f3099"> 108</a></span>  <a class="code" href="classmysqlpp_1_1ScopedLock.html#a1f03bd9ff85a61bef0255c6f313f3099">~ScopedLock</a>() { mutex_.<a class="code" href="classmysqlpp_1_1BeecryptMutex.html#a9c9dbc827e3777a0310dc7e6253d0998">unlock</a>(); }</div><div class="line"><a name="l00109"></a><span class="lineno"> 109</span> </div><div class="line"><a name="l00110"></a><span class="lineno"> 110</span> <span class="keyword">private</span>:</div><div class="line"><a name="l00111"></a><span class="lineno"> 111</span>  <a class="code" href="classmysqlpp_1_1ScopedLock.html#a0684decf81a6915e06297ff0fec218e9">ScopedLock</a>(<span class="keyword">const</span> <a class="code" href="classmysqlpp_1_1ScopedLock.html">ScopedLock</a>&); <span class="comment">// can't copy</span></div><div class="line"><a name="l00112"></a><span class="lineno"> 112</span>  <a class="code" href="classmysqlpp_1_1ScopedLock.html">ScopedLock</a>& operator =(<span class="keyword">const</span> <a class="code" href="classmysqlpp_1_1ScopedLock.html">ScopedLock</a>&); <span class="comment">// can't assign</span></div><div class="line"><a name="l00113"></a><span class="lineno"> 113</span> </div><div class="line"><a name="l00114"></a><span class="lineno"> 114</span>  <a class="code" href="classmysqlpp_1_1BeecryptMutex.html">BeecryptMutex</a>& mutex_; </div><div class="line"><a name="l00115"></a><span class="lineno"> 115</span> };</div><div class="line"><a name="l00116"></a><span class="lineno"> 116</span> </div><div class="line"><a name="l00117"></a><span class="lineno"> 117</span> } <span class="comment">// end namespace mysqlpp</span></div><div class="line"><a name="l00118"></a><span class="lineno"> 118</span> </div><div class="line"><a name="l00119"></a><span class="lineno"> 119</span> <span class="preprocessor">#endif // !defined(MYSQLPP_BEEMUTEX_H)</span></div><div class="line"><a name="l00120"></a><span class="lineno"> 120</span> </div><div class="ttc" id="classmysqlpp_1_1ScopedLock_html_a0684decf81a6915e06297ff0fec218e9"><div class="ttname"><a href="classmysqlpp_1_1ScopedLock.html#a0684decf81a6915e06297ff0fec218e9">mysqlpp::ScopedLock::ScopedLock</a></div><div class="ttdeci">ScopedLock(BeecryptMutex &mutex)</div><div class="ttdoc">Lock the mutex.</div><div class="ttdef"><b>Definition:</b> beemutex.h:101</div></div>
<div class="ttc" id="classmysqlpp_1_1MutexFailed_html"><div class="ttname"><a href="classmysqlpp_1_1MutexFailed.html">mysqlpp::MutexFailed</a></div><div class="ttdoc">Exception thrown when a BeecryptMutex object fails.</div><div class="ttdef"><b>Definition:</b> exceptions.h:389</div></div>
<div class="ttc" id="classmysqlpp_1_1ScopedLock_html"><div class="ttname"><a href="classmysqlpp_1_1ScopedLock.html">mysqlpp::ScopedLock</a></div><div class="ttdoc">Wrapper around BeecryptMutex to add scope-bound locking and unlocking.</div><div class="ttdef"><b>Definition:</b> beemutex.h:97</div></div>
<div class="ttc" id="classmysqlpp_1_1ScopedLock_html_a1f03bd9ff85a61bef0255c6f313f3099"><div class="ttname"><a href="classmysqlpp_1_1ScopedLock.html#a1f03bd9ff85a61bef0255c6f313f3099">mysqlpp::ScopedLock::~ScopedLock</a></div><div class="ttdeci">~ScopedLock()</div><div class="ttdoc">Unlock the mutex.</div><div class="ttdef"><b>Definition:</b> beemutex.h:108</div></div>
<div class="ttc" id="classmysqlpp_1_1BeecryptMutex_html_a9c9dbc827e3777a0310dc7e6253d0998"><div class="ttname"><a href="classmysqlpp_1_1BeecryptMutex.html#a9c9dbc827e3777a0310dc7e6253d0998">mysqlpp::BeecryptMutex::unlock</a></div><div class="ttdeci">void unlock() MAY_THROW(MutexFailed)</div><div class="ttdoc">Release the mutex.</div><div class="ttdef"><b>Definition:</b> beemutex.cpp:167</div></div>
<div class="ttc" id="exceptions_8h_html"><div class="ttname"><a href="exceptions_8h.html">exceptions.h</a></div><div class="ttdoc">Declares the MySQL++-specific exception classes.</div></div>
<div class="ttc" id="classmysqlpp_1_1BeecryptMutex_html"><div class="ttname"><a href="classmysqlpp_1_1BeecryptMutex.html">mysqlpp::BeecryptMutex</a></div><div class="ttdoc">Wrapper around platform-specific mutexes.</div><div class="ttdef"><b>Definition:</b> beemutex.h:59</div></div>
<div class="ttc" id="classmysqlpp_1_1BeecryptMutex_html_adb5f8dc007416c376826ac9461b82e87"><div class="ttname"><a href="classmysqlpp_1_1BeecryptMutex.html#adb5f8dc007416c376826ac9461b82e87">mysqlpp::BeecryptMutex::lock</a></div><div class="ttdeci">void lock() MAY_THROW(MutexFailed)</div><div class="ttdoc">Acquire the mutex, blocking if it can't be acquired immediately.</div><div class="ttdef"><b>Definition:</b> beemutex.cpp:110</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sun Jul 21 2019 05:32:20 for MySQL++ by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.15
</small></address>
</body>
</html>
|
