File: Poco.ThreadPool.html

package info (click to toggle)
poco-doc 1.3.6-1
  • links: PTS
  • area: main
  • in suites: buster, jessie, jessie-kfreebsd, squeeze, stretch, wheezy
  • size: 10,076 kB
  • ctags: 9,611
  • sloc: makefile: 31
file content (143 lines) | stat: -rw-r--r-- 11,074 bytes parent folder | download | duplicates (2)
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
<!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::ThreadPool</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 ThreadPool</h1>
</div>
<div class="body">
<p>
<b>Library:</b> Foundation<br />
<b>Package:</b> Threading<br />
<b>Header:</b> Poco/ThreadPool.h</p>
<h2>Description</h2>
<div class="description">
<p>A thread pool always keeps a number of threads running, ready to accept work. Creating and starting a threads can impose a significant runtime overhead to an application. A thread pool helps to improve the performance of an application by reducing the number of threads that have to be created (and destroyed again). Threads in a thread pool are re-used once they become available again. The thread pool always keeps a minimum number of threads running. If the demans for threads increases, additional threads are created. Once the demand for threads sinks again, no-longer used threads are stopped and removed from the pool. </p>
</div>
<h2>Member Summary</h2>
<p><b>Member Functions: </b><a href="Poco.ThreadPool.html#10915" title="Poco::ThreadPool::addCapacity()">addCapacity</a>, <a href="Poco.ThreadPool.html#10922" title="Poco::ThreadPool::allocated()">allocated</a>, <a href="Poco.ThreadPool.html#10923" title="Poco::ThreadPool::available()">available</a>, <a href="Poco.ThreadPool.html#10917" title="Poco::ThreadPool::capacity()">capacity</a>, <a href="Poco.ThreadPool.html#10938" title="Poco::ThreadPool::collect()">collect</a>, <a href="Poco.ThreadPool.html#10941" title="Poco::ThreadPool::createThread()">createThread</a>, <a href="Poco.ThreadPool.html#10939" title="Poco::ThreadPool::defaultPool()">defaultPool</a>, <a href="Poco.ThreadPool.html#10920" title="Poco::ThreadPool::getStackSize()">getStackSize</a>, <a href="Poco.ThreadPool.html#10940" title="Poco::ThreadPool::getThread()">getThread</a>, <a href="Poco.ThreadPool.html#10942" title="Poco::ThreadPool::housekeep()">housekeep</a>, <a href="Poco.ThreadPool.html#10937" title="Poco::ThreadPool::joinAll()">joinAll</a>, <a href="Poco.ThreadPool.html#10918" title="Poco::ThreadPool::setStackSize()">setStackSize</a>, <a href="Poco.ThreadPool.html#10924" title="Poco::ThreadPool::start()">start</a>, <a href="Poco.ThreadPool.html#10929" title="Poco::ThreadPool::startWithPriority()">startWithPriority</a>, <a href="Poco.ThreadPool.html#10936" title="Poco::ThreadPool::stopAll()">stopAll</a>, <a href="Poco.ThreadPool.html#10921" title="Poco::ThreadPool::used()">used</a></p>
<h2>Constructors</h2>
<h3><a name="10903">ThreadPool</a></h3>
<p class="decl"><a href="Poco.ThreadPool.html" title="class Poco::ThreadPool">ThreadPool</a>(<br />&nbsp;&nbsp;&nbsp;&nbsp;int minCapacity = 2,<br />&nbsp;&nbsp;&nbsp;&nbsp;int maxCapacity = 16,<br />&nbsp;&nbsp;&nbsp;&nbsp;int idleTime = 60,<br />&nbsp;&nbsp;&nbsp;&nbsp;int stackSize = 0<br />);</p>
<div class="description">
<p></p>
</div>
<h3><a name="10908">ThreadPool</a></h3>
<p class="decl"><a href="Poco.ThreadPool.html" title="class Poco::ThreadPool">ThreadPool</a>(<br />&nbsp;&nbsp;&nbsp;&nbsp;const std::string &amp; name,<br />&nbsp;&nbsp;&nbsp;&nbsp;int minCapacity = 2,<br />&nbsp;&nbsp;&nbsp;&nbsp;int maxCapacity = 16,<br />&nbsp;&nbsp;&nbsp;&nbsp;int idleTime = 60,<br />&nbsp;&nbsp;&nbsp;&nbsp;int stackSize = 0<br />);</p>
<div class="description">
<p>Creates a thread pool with minCapacity threads. If required, up to maxCapacity threads are created a <a href="Poco.NoThreadAvailableException.html" title="class Poco::NoThreadAvailableException">NoThreadAvailableException</a> exception is thrown. If a thread is running idle for more than idleTime seconds, and more than minCapacity threads are running, the thread is killed. Threads are created with given stack size. </p>
</div>
<h2>Destructor</h2>
<h3><a name="10914">~ThreadPool</a></h3>
<p class="decl">~<a href="Poco.ThreadPool.html" title="class Poco::ThreadPool">ThreadPool</a>();</p>
<div class="description">
<p>Currently running threads will remain active until they complete.  </p>
</div>
<h2>Member Functions</h2>
<h3><a name="10915">addCapacity</a></h3>
<p class="decl">void addCapacity(<br />&nbsp;&nbsp;&nbsp;&nbsp;int n<br />);</p>
<div class="description">
<p>Increases (or decreases, if n is negative) the maximum number of threads. </p>
</div>
<h3><a name="10922">allocated</a></h3>
<p class="decl">int allocated() const;</p>
<div class="description">
<p>Returns the number of currently allocated threads. </p>
</div>
<h3><a name="10923">available</a></h3>
<p class="decl">int available() const;</p>
<div class="description">
<p>Returns the number available threads. </p>
</div>
<h3><a name="10917">capacity</a></h3>
<p class="decl">int capacity() const;</p>
<div class="description">
<p>Returns the maximum capacity of threads. </p>
</div>
<h3><a name="10938">collect</a></h3>
<p class="decl">void collect();</p>
<div class="description">
<p>Stops and removes no longer used threads from the thread pool. Can be called at various times in an application's life time to help the thread pool manage its threads. Calling this method is optional, as the thread pool is also implicitly managed in calls to <a href="Poco.ThreadPool.html#10924" title="Poco::ThreadPool::start()">start</a>(), <a href="Poco.ThreadPool.html#10915" title="Poco::ThreadPool::addCapacity()">addCapacity</a>() and <a href="Poco.ThreadPool.html#10937" title="Poco::ThreadPool::joinAll()">joinAll</a>(). </p>
</div>
<h3><a name="10939">defaultPool</a> <img src="images/static.gif" alt="static" title="static" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">static <a href="Poco.ThreadPool.html" title="class Poco::ThreadPool">ThreadPool</a> &amp; defaultPool();</p>
<div class="description">
<p>Returns a reference to the default thread pool. </p>
</div>
<h3><a name="10920">getStackSize</a> <img src="images/inline.gif" alt="inline" title="inline" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">int getStackSize() const;</p>
<div class="description">
<p>Returns the stack size used to create new threads. </p>
</div>
<h3><a name="10937">joinAll</a></h3>
<p class="decl">void joinAll();</p>
<div class="description">
<p>Waits for all threads to complete. </p>
</div>
<h3><a name="10918">setStackSize</a> <img src="images/inline.gif" alt="inline" title="inline" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">void setStackSize(<br />&nbsp;&nbsp;&nbsp;&nbsp;int stackSize<br />);</p>
<div class="description">
<p>Sets the stack size for threads. New stack size applies only for newly created threads. </p>
</div>
<h3><a name="10924">start</a></h3>
<p class="decl">void start(<br />&nbsp;&nbsp;&nbsp;&nbsp;<a href="Poco.Runnable.html" title="class Poco::Runnable">Runnable</a> &amp; target<br />);</p>
<div class="description">
<p>Obtains a thread and starts the target. Throws a <a href="Poco.NoThreadAvailableException.html" title="class Poco::NoThreadAvailableException">NoThreadAvailableException</a> if no more threads are available. </p>
</div>
<h3><a name="10926">start</a></h3>
<p class="decl">void start(<br />&nbsp;&nbsp;&nbsp;&nbsp;<a href="Poco.Runnable.html" title="class Poco::Runnable">Runnable</a> &amp; target,<br />&nbsp;&nbsp;&nbsp;&nbsp;const std::string &amp; name<br />);</p>
<div class="description">
<p>Obtains a thread and starts the target. Assigns the given name to the thread. Throws a <a href="Poco.NoThreadAvailableException.html" title="class Poco::NoThreadAvailableException">NoThreadAvailableException</a> if no more threads are available. </p>
</div>
<h3><a name="10929">startWithPriority</a></h3>
<p class="decl">void startWithPriority(<br />&nbsp;&nbsp;&nbsp;&nbsp;<a href="Poco.Thread.html#10815" title="enum  Poco::Thread::Priority">Thread::Priority</a> priority,<br />&nbsp;&nbsp;&nbsp;&nbsp;<a href="Poco.Runnable.html" title="class Poco::Runnable">Runnable</a> &amp; target<br />);</p>
<div class="description">
<p>Obtains a thread, adjusts the thread's priority, and starts the target. Throws a <a href="Poco.NoThreadAvailableException.html" title="class Poco::NoThreadAvailableException">NoThreadAvailableException</a> if no more threads are available. </p>
</div>
<h3><a name="10932">startWithPriority</a></h3>
<p class="decl">void startWithPriority(<br />&nbsp;&nbsp;&nbsp;&nbsp;<a href="Poco.Thread.html#10815" title="enum  Poco::Thread::Priority">Thread::Priority</a> priority,<br />&nbsp;&nbsp;&nbsp;&nbsp;<a href="Poco.Runnable.html" title="class Poco::Runnable">Runnable</a> &amp; target,<br />&nbsp;&nbsp;&nbsp;&nbsp;const std::string &amp; name<br />);</p>
<div class="description">
<p>Obtains a thread, adjusts the thread's priority, and starts the target. Assigns the given name to the thread. Throws a <a href="Poco.NoThreadAvailableException.html" title="class Poco::NoThreadAvailableException">NoThreadAvailableException</a> if no more threads are available. </p>
</div>
<h3><a name="10936">stopAll</a></h3>
<p class="decl">void stopAll();</p>
<div class="description">
<p>Stops all running threads. Will also delete all thread objects. If used, this method should be the last action before the thread pool is deleted. </p>
</div>
<h3><a name="10921">used</a></h3>
<p class="decl">int used() const;</p>
<div class="description">
<p>Returns the number of currently used threads. </p>
</div>
<h3><a name="10941">createThread</a> <img src="images/protected.gif" alt="protected" title="protected" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">PooledThread * createThread();</p>
<div class="description">
<p></p>
</div>
<h3><a name="10940">getThread</a> <img src="images/protected.gif" alt="protected" title="protected" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">PooledThread * getThread();</p>
<div class="description">
<p></p>
</div>
<h3><a name="10942">housekeep</a> <img src="images/protected.gif" alt="protected" title="protected" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">void housekeep();</p>
<div class="description">
<p></p>
</div>
<p class="footer">POCO C++ Libraries 1.3.6-all<br />
Copyright &copy; 2009, <a href="http://pocoproject.org/" target="_blank">Applied Informatics Software Engineering GmbH and Contributors</a></p>

</div>
</body>
</html>