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
|
<!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">
<link href="refman.css" rel="stylesheet" type="text/css">
</head>
<body>
<!-- Generated by Doxygen 1.4.7 -->
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li id="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul></div>
<div class="tabs">
<ul>
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul></div>
<div class="nav">
<b>mysqlpp</b>::<a class="el" href="classmysqlpp_1_1BeecryptMutex.html">BeecryptMutex</a></div>
<h1>mysqlpp::BeecryptMutex Class Reference</h1><!-- doxytag: class="mysqlpp::BeecryptMutex" -->Wrapper around platform-specific mutexes.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="beemutex_8h-source.html">beemutex.h</a>></code>
<p>
<a href="classmysqlpp_1_1BeecryptMutex-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1BeecryptMutex.html#f9736ae7ee203973197e0b8f1905b17e">BeecryptMutex</a> () throw (MutexFailed)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create the mutex object. <a href="#f9736ae7ee203973197e0b8f1905b17e"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1BeecryptMutex.html#8f568cdd9ab9ea3ebebe88db934dd46a">~BeecryptMutex</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destroy the mutex. <a href="#8f568cdd9ab9ea3ebebe88db934dd46a"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="2b0c1d8a4fee0a0fbf43218d5652cf70"></a><!-- doxytag: member="mysqlpp::BeecryptMutex::lock" ref="2b0c1d8a4fee0a0fbf43218d5652cf70" args="()" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1BeecryptMutex.html#2b0c1d8a4fee0a0fbf43218d5652cf70">lock</a> () throw (MutexFailed)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Acquire the mutex, blocking if it can't be acquired immediately. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c53868b6eff7b22a0701a879f222162f"></a><!-- doxytag: member="mysqlpp::BeecryptMutex::trylock" ref="c53868b6eff7b22a0701a879f222162f" args="()" -->
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1BeecryptMutex.html#c53868b6eff7b22a0701a879f222162f">trylock</a> () throw (MutexFailed)</td></tr>
<tr><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><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="0796cf13bbd8a52c222ff18dad80a48e"></a><!-- doxytag: member="mysqlpp::BeecryptMutex::unlock" ref="0796cf13bbd8a52c222ff18dad80a48e" args="()" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1BeecryptMutex.html#0796cf13bbd8a52c222ff18dad80a48e">unlock</a> () throw (MutexFailed)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Release the mutex. <br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Wrapper around platform-specific mutexes.
<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>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="f9736ae7ee203973197e0b8f1905b17e"></a><!-- doxytag: member="mysqlpp::BeecryptMutex::BeecryptMutex" ref="f9736ae7ee203973197e0b8f1905b17e" args="()" -->
<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 width="100%"> throw (<a class="el" href="classmysqlpp_1_1MutexFailed.html">MutexFailed</a>)</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Create the mutex object.
<p>
Throws a <a class="el" href="classmysqlpp_1_1MutexFailed.html">MutexFailed</a> exception if we can't acquire the lock for some reason. The exception contains a message saying why.
</div>
</div><p>
<a class="anchor" name="8f568cdd9ab9ea3ebebe88db934dd46a"></a><!-- doxytag: member="mysqlpp::BeecryptMutex::~BeecryptMutex" ref="8f568cdd9ab9ea3ebebe88db934dd46a" args="()" -->
<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 width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Destroy the mutex.
<p>
Failures are quietly ignored.
</div>
</div><p>
<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>beemutex.cpp</ul>
<hr size="1"><address style="align: right;"><small>Generated on Thu Jun 3 11:59:12 2010 for MySQL++ by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.7 </small></address>
</body>
</html>
|
