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
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<title>MySQL++ Reference Manual</title>
<meta http-equiv="Content-type" content="text/html;charset=iso-8859-1">
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head>
<body>
<!-- Generated by Doxygen 1.8.5 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</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>
</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>
</div><!-- top -->
<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="l00019"></a><span class="lineno"> 19</span> <span class="comment">/***********************************************************************</span></div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment"> Copyright (c) 2004 Beeyond Software Holding BV and (c) 2007-2008</span></div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment"> by Educational Technology Resources, Inc. Others may also hold</span></div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="comment"> copyrights on code in this file. See the CREDITS.txt file in the</span></div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="comment"> top directory of the distribution for details.</span></div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="comment"></span></div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="comment"> This file is part of MySQL++.</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"> MySQL++ is free software; you can redistribute it and/or modify it</span></div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="comment"> under the terms of the GNU Lesser General Public License as published</span></div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="comment"> by the Free Software Foundation; either version 2.1 of the License, or</span></div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="comment"> (at your option) any later version.</span></div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="comment"></span></div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="comment"> MySQL++ is distributed in the hope that it will be useful, but WITHOUT</span></div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="comment"> ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or</span></div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="comment"> FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public</span></div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="comment"> License for more details.</span></div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="comment"></span></div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="comment"> You should have received a copy of the GNU Lesser General Public</span></div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="comment"> License along with MySQL++; if not, write to the Free Software</span></div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="comment"> Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301</span></div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="comment"> USA</span></div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="comment">***********************************************************************/</span></div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span> </div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="preprocessor">#if !defined(MYSQLPP_BEEMUTEX_H)</span></div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="preprocessor"></span><span class="preprocessor">#define MYSQLPP_BEEMUTEX_H</span></div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="preprocessor">#include "<a class="code" href="exceptions_8h.html">exceptions.h</a>"</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="keyword">namespace </span>mysqlpp {</div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span> </div>
<div class="line"><a name="l00057"></a><span class="lineno"><a class="line" href="classmysqlpp_1_1BeecryptMutex.html"> 57</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="l00058"></a><span class="lineno"> 58</span> {</div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span> <span class="keyword">public</span>:</div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  <a class="code" href="classmysqlpp_1_1BeecryptMutex.html">BeecryptMutex</a>() <span class="keywordflow">throw</span> (<a class="code" href="classmysqlpp_1_1MutexFailed.html">MutexFailed</a>);</div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span> </div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  ~<a class="code" href="classmysqlpp_1_1BeecryptMutex.html">BeecryptMutex</a>();</div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span> </div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  <span class="keywordtype">void</span> lock() <span class="keywordflow">throw</span> (<a class="code" href="classmysqlpp_1_1MutexFailed.html">MutexFailed</a>);</div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span> </div>
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  <span class="keywordtype">bool</span> trylock() <span class="keywordflow">throw</span> (<a class="code" href="classmysqlpp_1_1MutexFailed.html">MutexFailed</a>);</div>
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span> </div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  <span class="keywordtype">void</span> unlock() <span class="keywordflow">throw</span> (<a class="code" href="classmysqlpp_1_1MutexFailed.html">MutexFailed</a>);</div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span> </div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span> <span class="keyword">private</span>:</div>
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  <span class="keywordtype">void</span>* pmutex_;</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> </div>
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span> </div>
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span> </div>
<div class="line"><a name="l00095"></a><span class="lineno"><a class="line" href="classmysqlpp_1_1ScopedLock.html"> 95</a></span> <span class="keyword">class </span><a class="code" href="classmysqlpp_1_1ScopedLock.html">ScopedLock</a></div>
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span> {</div>
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span> <span class="keyword">public</span>:</div>
<div class="line"><a name="l00099"></a><span class="lineno"><a class="line" href="classmysqlpp_1_1ScopedLock.html#a0684decf81a6915e06297ff0fec218e9"> 99</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="l00100"></a><span class="lineno"> 100</span>  mutex_(mutex)</div>
<div class="line"><a name="l00101"></a><span class="lineno"> 101</span>  {</div>
<div class="line"><a name="l00102"></a><span class="lineno"> 102</span>  mutex.<a class="code" href="classmysqlpp_1_1BeecryptMutex.html#a2b0c1d8a4fee0a0fbf43218d5652cf70">lock</a>();</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> </div>
<div class="line"><a name="l00106"></a><span class="lineno"><a class="line" href="classmysqlpp_1_1ScopedLock.html#a1f03bd9ff85a61bef0255c6f313f3099"> 106</a></span>  <a class="code" href="classmysqlpp_1_1ScopedLock.html#a1f03bd9ff85a61bef0255c6f313f3099">~ScopedLock</a>() { mutex_.<a class="code" href="classmysqlpp_1_1BeecryptMutex.html#a0796cf13bbd8a52c222ff18dad80a48e">unlock</a>(); }</div>
<div class="line"><a name="l00107"></a><span class="lineno"> 107</span> </div>
<div class="line"><a name="l00108"></a><span class="lineno"> 108</span> <span class="keyword">private</span>:</div>
<div class="line"><a name="l00109"></a><span class="lineno"> 109</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="l00110"></a><span class="lineno"> 110</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="l00111"></a><span class="lineno"> 111</span> </div>
<div class="line"><a name="l00112"></a><span class="lineno"> 112</span>  <a class="code" href="classmysqlpp_1_1BeecryptMutex.html">BeecryptMutex</a>& mutex_; </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> </div>
<div class="line"><a name="l00115"></a><span class="lineno"> 115</span> } <span class="comment">// end namespace mysqlpp</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="preprocessor">#endif // !defined(MYSQLPP_BEEMUTEX_H)</span></div>
<div class="line"><a name="l00118"></a><span class="lineno"> 118</span> <span class="preprocessor"></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:99</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:95</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:106</div></div>
<div class="ttc" id="classmysqlpp_1_1BeecryptMutex_html_a2b0c1d8a4fee0a0fbf43218d5652cf70"><div class="ttname"><a href="classmysqlpp_1_1BeecryptMutex.html#a2b0c1d8a4fee0a0fbf43218d5652cf70">mysqlpp::BeecryptMutex::lock</a></div><div class="ttdeci">void lock()</div><div class="ttdoc">Acquire the mutex, blocking if it can&#39;t be acquired immediately. </div><div class="ttdef"><b>Definition:</b> beemutex.cpp:106</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:57</div></div>
<div class="ttc" id="classmysqlpp_1_1BeecryptMutex_html_a0796cf13bbd8a52c222ff18dad80a48e"><div class="ttname"><a href="classmysqlpp_1_1BeecryptMutex.html#a0796cf13bbd8a52c222ff18dad80a48e">mysqlpp::BeecryptMutex::unlock</a></div><div class="ttdeci">void unlock()</div><div class="ttdoc">Release the mutex. </div><div class="ttdef"><b>Definition:</b> beemutex.cpp:163</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Wed Mar 18 2015 18:55:03 for MySQL++ 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>
|
