-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathclasserpc_1_1_mutex.html
246 lines (236 loc) · 11.5 KB
/
classerpc_1_1_mutex.html
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
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
<!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>
<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.11"/>
<title>eRPC API Reference: erpc::Mutex Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
$(window).load(resizeHeight);
</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>
<script type="text/javascript">
$(document).ready(function() { init_search(); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="customdoxygen.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="projectlogo"><img alt="Logo" src="nxp_logo_small.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">eRPC API Reference
 <span id="projectnumber">Rev. 1.13.0</span>
</div>
<div id="projectbrief">NXP Semiconductors</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.11 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="modules.html"><span>API Reference</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>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</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="classes.html"><span>Class Index</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><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('classerpc_1_1_mutex.html','');});
</script>
<div id="doc-content">
<!-- 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="summary">
<a href="#nested-classes">Classes</a> |
<a href="#pub-methods">Public Member Functions</a> |
<a href="classerpc_1_1_mutex-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">erpc::Mutex Class Reference<div class="ingroups"><a class="el" href="group__port.html">Porting</a> » <a class="el" href="group__port__threads.html">Threads</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p><a class="el" href="classerpc_1_1_mutex.html" title="Mutex. ">Mutex</a>.
<a href="classerpc_1_1_mutex.html#details">More...</a></p>
<p><code>#include <<a class="el" href="erpc__threading_8h_source.html">erpc_threading.h</a>></code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classerpc_1_1_mutex_1_1_guard.html">Guard</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
</table><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:a00b2ff557451955a905ecdca2855389b"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a00b2ff557451955a905ecdca2855389b"></a>
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classerpc_1_1_mutex.html#a00b2ff557451955a905ecdca2855389b">Mutex</a> (void)</td></tr>
<tr class="memdesc:a00b2ff557451955a905ecdca2855389b"><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <br /></td></tr>
<tr class="separator:a00b2ff557451955a905ecdca2855389b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a115e8bae072b7d0767f75bc3369d521d"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a115e8bae072b7d0767f75bc3369d521d"></a>
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classerpc_1_1_mutex.html#a115e8bae072b7d0767f75bc3369d521d">~Mutex</a> (void)</td></tr>
<tr class="memdesc:a115e8bae072b7d0767f75bc3369d521d"><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <br /></td></tr>
<tr class="separator:a115e8bae072b7d0767f75bc3369d521d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a69702e86e24cbb72cb144a626bae07bb"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classerpc_1_1_mutex.html#a69702e86e24cbb72cb144a626bae07bb">tryLock</a> (void)</td></tr>
<tr class="memdesc:a69702e86e24cbb72cb144a626bae07bb"><td class="mdescLeft"> </td><td class="mdescRight">This function try lock mutex. <a href="#a69702e86e24cbb72cb144a626bae07bb">More...</a><br /></td></tr>
<tr class="separator:a69702e86e24cbb72cb144a626bae07bb"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a23dc76a396337f3f29f8ad4239c46658"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classerpc_1_1_mutex.html#a23dc76a396337f3f29f8ad4239c46658">lock</a> (void)</td></tr>
<tr class="memdesc:a23dc76a396337f3f29f8ad4239c46658"><td class="mdescLeft"> </td><td class="mdescRight">This function lock mutex. <a href="#a23dc76a396337f3f29f8ad4239c46658">More...</a><br /></td></tr>
<tr class="separator:a23dc76a396337f3f29f8ad4239c46658"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8a936aa1a83f74e1ad224982af2d9792"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classerpc_1_1_mutex.html#a8a936aa1a83f74e1ad224982af2d9792">unlock</a> (void)</td></tr>
<tr class="memdesc:a8a936aa1a83f74e1ad224982af2d9792"><td class="mdescLeft"> </td><td class="mdescRight">This function unlock mutex. <a href="#a8a936aa1a83f74e1ad224982af2d9792">More...</a><br /></td></tr>
<tr class="separator:a8a936aa1a83f74e1ad224982af2d9792"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p><a class="el" href="classerpc_1_1_mutex.html" title="Mutex. ">Mutex</a>. </p>
<p>If the OS supports it, the mutex will be recursive. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a69702e86e24cbb72cb144a626bae07bb"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Mutex::tryLock </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>This function try lock mutex. </p>
<dl class="retval"><dt>Return values</dt><dd>
<table class="retval">
<tr><td class="paramname">true</td><td>When mutex locked successfully. </td></tr>
<tr><td class="paramname">false</td><td>When mutex didn't locked. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a23dc76a396337f3f29f8ad4239c46658"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Mutex::lock </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>This function lock mutex. </p>
<dl class="retval"><dt>Return values</dt><dd>
<table class="retval">
<tr><td class="paramname">true</td><td>When mutex locked successfully. </td></tr>
<tr><td class="paramname">false</td><td>When mutex didn't locked. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a8a936aa1a83f74e1ad224982af2d9792"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Mutex::unlock </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>This function unlock mutex. </p>
<dl class="retval"><dt>Return values</dt><dd>
<table class="retval">
<tr><td class="paramname">true</td><td>When mutex unlocked successfully. </td></tr>
<tr><td class="paramname">false</td><td>When mutex didn't unlocked. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="erpc__threading_8h_source.html">erpc_threading.h</a></li>
<li>erpc_threading_pthreads.cpp</li>
<li>erpc_threading_win32.cpp</li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- HTML footer for doxygen 1.8.5-->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul class="foot">
<li class="footer">Copyright 2016-2020 NXP Semiconductors. All rights reserved.
</li>
</ul>
</div>
</body>
</html>