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
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
|
<!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++: mysqlpp::BeecryptMutex Class Reference</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>
<!-- 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 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:ad5f40c490dfe41d0dce5a2742545bdab"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1BeecryptMutex.html#ad5f40c490dfe41d0dce5a2742545bdab">BeecryptMutex</a> () MAY_THROW(<a class="el" href="classmysqlpp_1_1MutexFailed.html">MutexFailed</a>)</td></tr>
<tr class="memdesc:ad5f40c490dfe41d0dce5a2742545bdab"><td class="mdescLeft"> </td><td class="mdescRight">Create the mutex object. <a href="#ad5f40c490dfe41d0dce5a2742545bdab">More...</a><br /></td></tr>
<tr class="separator:ad5f40c490dfe41d0dce5a2742545bdab"><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:adb5f8dc007416c376826ac9461b82e87"><td class="memItemLeft" align="right" valign="top"><a id="adb5f8dc007416c376826ac9461b82e87"></a>
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1BeecryptMutex.html#adb5f8dc007416c376826ac9461b82e87">lock</a> () MAY_THROW(<a class="el" href="classmysqlpp_1_1MutexFailed.html">MutexFailed</a>)</td></tr>
<tr class="memdesc:adb5f8dc007416c376826ac9461b82e87"><td class="mdescLeft"> </td><td class="mdescRight">Acquire the mutex, blocking if it can't be acquired immediately. <br /></td></tr>
<tr class="separator:adb5f8dc007416c376826ac9461b82e87"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8f2ede53abf6ca90e733f139d860999d"><td class="memItemLeft" align="right" valign="top"><a id="a8f2ede53abf6ca90e733f139d860999d"></a>
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1BeecryptMutex.html#a8f2ede53abf6ca90e733f139d860999d">trylock</a> () MAY_THROW(<a class="el" href="classmysqlpp_1_1MutexFailed.html">MutexFailed</a>)</td></tr>
<tr class="memdesc:a8f2ede53abf6ca90e733f139d860999d"><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:a8f2ede53abf6ca90e733f139d860999d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9c9dbc827e3777a0310dc7e6253d0998"><td class="memItemLeft" align="right" valign="top"><a id="a9c9dbc827e3777a0310dc7e6253d0998"></a>
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1BeecryptMutex.html#a9c9dbc827e3777a0310dc7e6253d0998">unlock</a> () MAY_THROW(<a class="el" href="classmysqlpp_1_1MutexFailed.html">MutexFailed</a>)</td></tr>
<tr class="memdesc:a9c9dbc827e3777a0310dc7e6253d0998"><td class="mdescLeft"> </td><td class="mdescRight">Release the mutex. <br /></td></tr>
<tr class="separator:a9c9dbc827e3777a0310dc7e6253d0998"><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 id="ad5f40c490dfe41d0dce5a2742545bdab"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad5f40c490dfe41d0dce5a2742545bdab">◆ </a></span>BeecryptMutex()</h2>
<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>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 id="a8f568cdd9ab9ea3ebebe88db934dd46a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8f568cdd9ab9ea3ebebe88db934dd46a">◆ </a></span>~BeecryptMutex()</h2>
<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 Sun Jul 21 2019 05:32:21 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>
|
