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
|
<!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>Class Poco::AtomicCounter</title>
<meta http-equiv="content-type" content="text/html; charset=utf-8"/>
<meta name="author" content="Applied Informatics Software Engineering GmbH and Contributors"/>
<meta name="publisher" content="Applied Informatics Software Engineering GmbH and Contributors"/>
<meta name="copyright" content="Copyright (c) 2009, Applied Informatics Software Engineering GmbH and Contributors"/>
<meta name="language" content="en"/>
<meta name="date" content="2009-11-24"/>
<meta name="generator" content="PocoDoc"/>
<link rel="stylesheet" href="css/styles.css" type="text/css"/>
</head>
<body bgcolor="#ffffff" leftmargin="0" topmargin="0">
<div class="header">
<h1 class="namespace"><a href="Poco.html" class="namespace">Poco</a></h1>
<h1 class="symbol">class AtomicCounter</h1>
</div>
<div class="body">
<p>
<b>Library:</b> Foundation<br />
<b>Package:</b> Core<br />
<b>Header:</b> Poco/AtomicCounter.h</p>
<h2>Description</h2>
<div class="description">
<p>This class implements a simple counter, which provides atomic operations that are safe to use in a multithreaded environment. </p>
<p>Typical usage of <a href="Poco.AtomicCounter.html" title="class Poco::AtomicCounter">AtomicCounter</a> is for implementing reference counting and similar things. </p>
<p>On some platforms, the implementation of <a href="Poco.AtomicCounter.html" title="class Poco::AtomicCounter">AtomicCounter</a> is based on atomic primitives specific to the platform (such as InterlockedIncrement, etc. on Windows), and thus very efficient. On platforms that do not support atomic primitives, operations are guarded by a <a href="Poco.FastMutex.html" title="class Poco::FastMutex">FastMutex</a>. </p>
<p>The following platforms currently have atomic primitives: </p>
<ul>
<li>Windows </li>
<li>Mac OS X </li>
</ul>
</div>
<h2>Member Summary</h2>
<p><b>Member Functions: </b><a href="Poco.AtomicCounter.html#3635" title="Poco::AtomicCounter::operator !()">operator !</a>, <a href="Poco.AtomicCounter.html#3629" title="Poco::AtomicCounter::operator ++()">operator ++</a>, <a href="Poco.AtomicCounter.html#3632" title="Poco::AtomicCounter::operator --()">operator --</a>, <a href="Poco.AtomicCounter.html#3623" title="Poco::AtomicCounter::operator =()">operator =</a>, <a href="Poco.AtomicCounter.html#3627" title="Poco::AtomicCounter::operator ValueType()">operator ValueType</a>, <a href="Poco.AtomicCounter.html#3628" title="Poco::AtomicCounter::value()">value</a></p>
<h2>Types</h2>
<h3><a name="3616">ValueType</a></h3>
<p class="decl">typedef int <a href="Poco.AtomicCounter.html#3616" title="Poco::AtomicCounter::ValueType">ValueType</a>;</p>
<div class="description">
<p>The underlying integer type. </p>
</div>
<h2>Constructors</h2>
<h3><a name="3617">AtomicCounter</a></h3>
<p class="decl"><a href="Poco.AtomicCounter.html" title="class Poco::AtomicCounter">AtomicCounter</a>();</p>
<div class="description">
<p>Creates a new <a href="Poco.AtomicCounter.html" title="class Poco::AtomicCounter">AtomicCounter</a> and initializes it to zero. </p>
</div>
<h3><a name="3618">AtomicCounter</a></h3>
<p class="decl">explicit <a href="Poco.AtomicCounter.html" title="class Poco::AtomicCounter">AtomicCounter</a>(<br /> <a href="Poco.AtomicCounter.html#3616" title="Poco::AtomicCounter::ValueType">ValueType</a> initialValue<br />);</p>
<div class="description">
<p>Creates a new <a href="Poco.AtomicCounter.html" title="class Poco::AtomicCounter">AtomicCounter</a> and initializes it with the given value. </p>
</div>
<h3><a name="3620">AtomicCounter</a></h3>
<p class="decl"><a href="Poco.AtomicCounter.html" title="class Poco::AtomicCounter">AtomicCounter</a>(<br /> const <a href="Poco.AtomicCounter.html" title="class Poco::AtomicCounter">AtomicCounter</a> & counter<br />);</p>
<div class="description">
<p>Creates the counter by copying another one. </p>
</div>
<h2>Destructor</h2>
<h3><a name="3622">~AtomicCounter</a></h3>
<p class="decl">~<a href="Poco.AtomicCounter.html" title="class Poco::AtomicCounter">AtomicCounter</a>();</p>
<div class="description">
<p>Destroys the <a href="Poco.AtomicCounter.html" title="class Poco::AtomicCounter">AtomicCounter</a>. </p>
</div>
<h2>Member Functions</h2>
<h3><a name="3635">operator !</a> <img src="images/inline.gif" alt="inline" title="inline" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">bool operator ! () const;</p>
<div class="description">
<p>Returns true if the counter is zero, false otherwise. </p>
</div>
<h3><a name="3629">operator ++</a> <img src="images/inline.gif" alt="inline" title="inline" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl"><a href="Poco.AtomicCounter.html#3616" title="Poco::AtomicCounter::ValueType">ValueType</a> operator ++ ();</p>
<div class="description">
<p>Increments the counter and returns the result. </p>
</div>
<h3><a name="3630">operator ++</a></h3>
<p class="decl"><a href="Poco.AtomicCounter.html#3616" title="Poco::AtomicCounter::ValueType">ValueType</a> operator ++ (<br /> int<br />);</p>
<div class="description">
<p>Increments the counter and returns the previous value. </p>
</div>
<h3><a name="3632">operator --</a> <img src="images/inline.gif" alt="inline" title="inline" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl"><a href="Poco.AtomicCounter.html#3616" title="Poco::AtomicCounter::ValueType">ValueType</a> operator -- ();</p>
<div class="description">
<p>Decrements the counter and returns the result. </p>
</div>
<h3><a name="3633">operator --</a></h3>
<p class="decl"><a href="Poco.AtomicCounter.html#3616" title="Poco::AtomicCounter::ValueType">ValueType</a> operator -- (<br /> int<br />);</p>
<div class="description">
<p>Decrements the counter and returns the previous value. </p>
</div>
<h3><a name="3623">operator =</a></h3>
<p class="decl"><a href="Poco.AtomicCounter.html" title="class Poco::AtomicCounter">AtomicCounter</a> & operator = (<br /> const <a href="Poco.AtomicCounter.html" title="class Poco::AtomicCounter">AtomicCounter</a> & counter<br />);</p>
<div class="description">
<p>Assigns the value of another <a href="Poco.AtomicCounter.html" title="class Poco::AtomicCounter">AtomicCounter</a>. </p>
</div>
<h3><a name="3625">operator =</a></h3>
<p class="decl"><a href="Poco.AtomicCounter.html" title="class Poco::AtomicCounter">AtomicCounter</a> & operator = (<br /> <a href="Poco.AtomicCounter.html#3616" title="Poco::AtomicCounter::ValueType">ValueType</a> value<br />);</p>
<div class="description">
<p>Assigns a value to the counter. </p>
</div>
<h3><a name="3627">operator ValueType</a></h3>
<p class="decl">operator <a href="Poco.AtomicCounter.html#3616" title="Poco::AtomicCounter::ValueType">ValueType</a>() const;</p>
<div class="description">
<p>Returns the value of the counter. </p>
</div>
<h3><a name="3628">value</a> <img src="images/inline.gif" alt="inline" title="inline" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl"><a href="Poco.AtomicCounter.html#3616" title="Poco::AtomicCounter::ValueType">ValueType</a> value() const;</p>
<div class="description">
<p>Returns the value of the counter. </p>
</div>
<p class="footer">POCO C++ Libraries 1.3.6-all<br />
Copyright © 2009, <a href="http://pocoproject.org/" target="_blank">Applied Informatics Software Engineering GmbH and Contributors</a></p>
</div>
</body>
</html>
|
