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
120
121
122
123
|
<!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 class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="inherits.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><b>mysqlpp</b></li><li class="navelem"><a class="el" href="classmysqlpp_1_1BeecryptMutex.html">BeecryptMutex</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="classmysqlpp_1_1BeecryptMutex-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">mysqlpp::BeecryptMutex Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Wrapper around platform-specific mutexes.
<a href="classmysqlpp_1_1BeecryptMutex.html#details">More...</a></p>
<p><code>#include <<a class="el" href="beemutex_8h_source.html">beemutex.h</a>></code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:af9736ae7ee203973197e0b8f1905b17e"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1BeecryptMutex.html#af9736ae7ee203973197e0b8f1905b17e">BeecryptMutex</a> () throw (MutexFailed)</td></tr>
<tr class="memdesc:af9736ae7ee203973197e0b8f1905b17e"><td class="mdescLeft"> </td><td class="mdescRight">Create the mutex object. <a href="#af9736ae7ee203973197e0b8f1905b17e">More...</a><br/></td></tr>
<tr class="separator:af9736ae7ee203973197e0b8f1905b17e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8f568cdd9ab9ea3ebebe88db934dd46a"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1BeecryptMutex.html#a8f568cdd9ab9ea3ebebe88db934dd46a">~BeecryptMutex</a> ()</td></tr>
<tr class="memdesc:a8f568cdd9ab9ea3ebebe88db934dd46a"><td class="mdescLeft"> </td><td class="mdescRight">Destroy the mutex. <a href="#a8f568cdd9ab9ea3ebebe88db934dd46a">More...</a><br/></td></tr>
<tr class="separator:a8f568cdd9ab9ea3ebebe88db934dd46a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2b0c1d8a4fee0a0fbf43218d5652cf70"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2b0c1d8a4fee0a0fbf43218d5652cf70"></a>
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1BeecryptMutex.html#a2b0c1d8a4fee0a0fbf43218d5652cf70">lock</a> () throw (MutexFailed)</td></tr>
<tr class="memdesc:a2b0c1d8a4fee0a0fbf43218d5652cf70"><td class="mdescLeft"> </td><td class="mdescRight">Acquire the mutex, blocking if it can't be acquired immediately. <br/></td></tr>
<tr class="separator:a2b0c1d8a4fee0a0fbf43218d5652cf70"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac53868b6eff7b22a0701a879f222162f"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac53868b6eff7b22a0701a879f222162f"></a>
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1BeecryptMutex.html#ac53868b6eff7b22a0701a879f222162f">trylock</a> () throw (MutexFailed)</td></tr>
<tr class="memdesc:ac53868b6eff7b22a0701a879f222162f"><td class="mdescLeft"> </td><td class="mdescRight">Acquire the mutex immediately and return true, or return false if it would have to block to acquire the mutex. <br/></td></tr>
<tr class="separator:ac53868b6eff7b22a0701a879f222162f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0796cf13bbd8a52c222ff18dad80a48e"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0796cf13bbd8a52c222ff18dad80a48e"></a>
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1BeecryptMutex.html#a0796cf13bbd8a52c222ff18dad80a48e">unlock</a> () throw (MutexFailed)</td></tr>
<tr class="memdesc:a0796cf13bbd8a52c222ff18dad80a48e"><td class="mdescLeft"> </td><td class="mdescRight">Release the mutex. <br/></td></tr>
<tr class="separator:a0796cf13bbd8a52c222ff18dad80a48e"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Wrapper around platform-specific mutexes. </p>
<p>This class is only intended to be used within the library. We don't really want to support this as a general purpose class. If it works for you as-is, that's great, we won't try to stop you. But if you run into a problem that doesn't affect MySQL++ itself, we're not likely to bother enhancing this class to fix the problem. </p>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a class="anchor" id="af9736ae7ee203973197e0b8f1905b17e"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">mysqlpp::BeecryptMutex::BeecryptMutex </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
<tr>
<td align="right">throw </td><td>(</td><td colspan="2"><a class="el" href="classmysqlpp_1_1MutexFailed.html">MutexFailed</a></td>
</tr>
<tr>
<td align="right"></td><td>)</td><td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Create the mutex object. </p>
<p>Throws a <a class="el" href="classmysqlpp_1_1MutexFailed.html" title="Exception thrown when a BeecryptMutex object fails. ">MutexFailed</a> exception if we can't acquire the lock for some reason. The exception contains a message saying why. </p>
</div>
</div>
<a class="anchor" id="a8f568cdd9ab9ea3ebebe88db934dd46a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">mysqlpp::BeecryptMutex::~BeecryptMutex </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Destroy the mutex. </p>
<p>Failures are quietly ignored. </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="beemutex_8h_source.html">beemutex.h</a></li>
<li>beemutex.cpp</li>
</ul>
</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>
|
