/
_concurrent_pool_8cs_source.html
169 lines (167 loc) · 16.5 KB
/
_concurrent_pool_8cs_source.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
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.10.0"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>World Conquest: Assets/Mirror/Core/Threading/ConcurrentPool.cs Source File</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>
<script type="text/javascript" src="clipboard.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" src="cookie.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 id="projectrow">
<td id="projectalign">
<div id="projectname">World Conquest
</div>
<div id="projectbrief">Implementation of the Risk board game for our Software Engineering module.</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.10.0 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @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:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search');
$(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
$(function() { codefold.init(0); });
/* @license-end */
</script>
</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">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
$(function(){initNavTree('_concurrent_pool_8cs_source.html',''); initResizable(); });
/* @license-end */
</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">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div class="header">
<div class="headertitle"><div class="title">ConcurrentPool.cs</div></div>
</div><!--header-->
<div class="contents">
<a href="_concurrent_pool_8cs.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="comment">// Pool to avoid allocations (from libuv2k)</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="comment">// API consistent with Microsoft's ObjectPool<T>.</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="comment">// concurrent for thread safe access.</span></div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="comment">//</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="comment">// currently not in use. keep it in case we need it again.</span></div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="keyword">using </span>System;</div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="keyword">using </span>System.Collections.Concurrent;</div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="keyword">using </span>System.Runtime.CompilerServices;</div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span> </div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespace_mirror.html">Mirror</a></div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span>{</div>
<div class="foldopen" id="foldopen00012" data-start="{" data-end="};">
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"><a class="line" href="class_mirror_1_1_concurrent_pool.html"> 12</a></span> <span class="keyword">public</span> <span class="keyword">class </span><a class="code hl_class" href="class_mirror_1_1_concurrent_pool.html">ConcurrentPool</a><<a class="code hl_struct" href="struct_mirror_1_1_grid2_d.html">T</a>></div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span> {</div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span> <span class="comment">// Mirror is single threaded, no need for concurrent collections</span></div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span> <span class="comment">// concurrent bag is for items who's order doesn't matter.</span></div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span> <span class="comment">// just about right for our use case here.</span></div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span> <a class="code hl_struct" href="struct_mirror_1_1_grid2_d.html">readonly</a> <a class="code hl_struct" href="struct_mirror_1_1_grid2_d.html">ConcurrentBag<T></a> objects = <span class="keyword">new</span> <a class="code hl_struct" href="struct_mirror_1_1_grid2_d.html">ConcurrentBag<T></a>();</div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span> </div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span> <span class="comment">// some types might need additional parameters in their constructor, so</span></div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span> <span class="comment">// we use a Func<T> generator</span></div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span> <a class="code hl_struct" href="struct_mirror_1_1_grid2_d.html">readonly</a> <a class="code hl_struct" href="struct_mirror_1_1_grid2_d.html">Func<T></a> objectGenerator;</div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span> </div>
<div class="foldopen" id="foldopen00023" data-start="{" data-end="}">
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"><a class="line" href="class_mirror_1_1_concurrent_pool.html#a1f2588bc50ea9200e4872ac9d0021141"> 23</a></span> <span class="keyword">public</span> <a class="code hl_function" href="class_mirror_1_1_concurrent_pool.html#a1f2588bc50ea9200e4872ac9d0021141">ConcurrentPool</a>(<a class="code hl_struct" href="struct_mirror_1_1_grid2_d.html">Func<T></a> objectGenerator, <span class="keywordtype">int</span> <a class="code hl_struct" href="struct_mirror_1_1_grid2_d.html">initialCapacity</a>)</div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span> {</div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span> this.objectGenerator = objectGenerator;</div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span> </div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span> <span class="comment">// allocate an initial pool so we have fewer (if any)</span></div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span> <span class="comment">// allocations in the first few frames (or seconds).</span></div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span> <span class="keywordflow">for</span> (<span class="keywordtype">int</span> <a class="code hl_struct" href="struct_mirror_1_1_grid2_d.html">i</a> = 0; <a class="code hl_struct" href="struct_mirror_1_1_grid2_d.html">i</a> < <a class="code hl_struct" href="struct_mirror_1_1_grid2_d.html">initialCapacity</a>; ++<a class="code hl_struct" href="struct_mirror_1_1_grid2_d.html">i</a>)</div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span> objects.<a class="code hl_function" href="struct_mirror_1_1_grid2_d.html#a05b810f7466b59b26b243d83383d1274">Add</a>(objectGenerator());</div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span> }</div>
</div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span> </div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span> <span class="comment">// take an element from the pool, or create a new one if empty</span></div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span> [<a class="code hl_struct" href="struct_mirror_1_1_grid2_d.html">MethodImpl</a>(<a class="code hl_struct" href="struct_mirror_1_1_grid2_d.html">MethodImplOptions</a>.AggressiveInlining)]</div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"><a class="line" href="class_mirror_1_1_concurrent_pool.html#a2c3513b0aef71ff76af454a3a35db8a0"> 35</a></span> <span class="keyword">public</span> <a class="code hl_struct" href="struct_mirror_1_1_grid2_d.html">T</a> <a class="code hl_function" href="class_mirror_1_1_concurrent_pool.html#a2c3513b0aef71ff76af454a3a35db8a0">Get</a>() => objects.TryTake(<a class="code hl_struct" href="struct_mirror_1_1_grid2_d.html">out</a> <a class="code hl_struct" href="struct_mirror_1_1_grid2_d.html">T</a> <a class="code hl_struct" href="struct_mirror_1_1_grid2_d.html">obj</a>) ? <a class="code hl_struct" href="struct_mirror_1_1_grid2_d.html">obj</a> : objectGenerator();</div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span> </div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span> <span class="comment">// return an element to the pool</span></div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span> [<a class="code hl_struct" href="struct_mirror_1_1_grid2_d.html">MethodImpl</a>(<a class="code hl_struct" href="struct_mirror_1_1_grid2_d.html">MethodImplOptions</a>.AggressiveInlining)]</div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"><a class="line" href="class_mirror_1_1_concurrent_pool.html#ae6ba1185aa7c5cc285bc1da0ae3f1bc3"> 39</a></span> <span class="keyword">public</span> <span class="keywordtype">void</span> <a class="code hl_function" href="class_mirror_1_1_concurrent_pool.html#ae6ba1185aa7c5cc285bc1da0ae3f1bc3">Return</a>(<a class="code hl_struct" href="struct_mirror_1_1_grid2_d.html">T</a> item) => objects.<a class="code hl_function" href="struct_mirror_1_1_grid2_d.html#a05b810f7466b59b26b243d83383d1274">Add</a>(item);</div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span> </div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span> <span class="comment">// count to see how many objects are in the pool. useful for tests.</span></div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"><a class="line" href="class_mirror_1_1_concurrent_pool.html#a25fc747a3b49bf897a96a65b906270d6"> 42</a></span> <span class="keyword">public</span> <span class="keywordtype">int</span> <a class="code hl_property" href="class_mirror_1_1_concurrent_pool.html#a25fc747a3b49bf897a96a65b906270d6">Count</a> => objects.Count;</div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span> }</div>
</div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span>}</div>
<div class="ttc" id="aclass_mirror_1_1_concurrent_pool_html"><div class="ttname"><a href="class_mirror_1_1_concurrent_pool.html">Mirror.ConcurrentPool</a></div><div class="ttdef"><b>Definition</b> <a href="#l00012">ConcurrentPool.cs:13</a></div></div>
<div class="ttc" id="aclass_mirror_1_1_concurrent_pool_html_a1f2588bc50ea9200e4872ac9d0021141"><div class="ttname"><a href="class_mirror_1_1_concurrent_pool.html#a1f2588bc50ea9200e4872ac9d0021141">Mirror.ConcurrentPool.ConcurrentPool</a></div><div class="ttdeci">ConcurrentPool(Func< T > objectGenerator, int initialCapacity)</div><div class="ttdef"><b>Definition</b> <a href="#l00023">ConcurrentPool.cs:23</a></div></div>
<div class="ttc" id="aclass_mirror_1_1_concurrent_pool_html_a25fc747a3b49bf897a96a65b906270d6"><div class="ttname"><a href="class_mirror_1_1_concurrent_pool.html#a25fc747a3b49bf897a96a65b906270d6">Mirror.ConcurrentPool.Count</a></div><div class="ttdeci">int Count</div><div class="ttdef"><b>Definition</b> <a href="#l00042">ConcurrentPool.cs:42</a></div></div>
<div class="ttc" id="aclass_mirror_1_1_concurrent_pool_html_a2c3513b0aef71ff76af454a3a35db8a0"><div class="ttname"><a href="class_mirror_1_1_concurrent_pool.html#a2c3513b0aef71ff76af454a3a35db8a0">Mirror.ConcurrentPool.Get</a></div><div class="ttdeci">T Get()</div></div>
<div class="ttc" id="aclass_mirror_1_1_concurrent_pool_html_ae6ba1185aa7c5cc285bc1da0ae3f1bc3"><div class="ttname"><a href="class_mirror_1_1_concurrent_pool.html#ae6ba1185aa7c5cc285bc1da0ae3f1bc3">Mirror.ConcurrentPool.Return</a></div><div class="ttdeci">void Return(T item)</div></div>
<div class="ttc" id="anamespace_mirror_html"><div class="ttname"><a href="namespace_mirror.html">Mirror</a></div><div class="ttdef"><b>Definition</b> <a href="_basic_authenticator_8cs_source.html#l00005">BasicAuthenticator.cs:6</a></div></div>
<div class="ttc" id="astruct_mirror_1_1_grid2_d_html"><div class="ttname"><a href="struct_mirror_1_1_grid2_d.html">Mirror.Grid2D</a></div><div class="ttdef"><b>Definition</b> <a href="_grid2_d_8cs_source.html#l00010">Grid2D.cs:11</a></div></div>
<div class="ttc" id="astruct_mirror_1_1_grid2_d_html_a05b810f7466b59b26b243d83383d1274"><div class="ttname"><a href="struct_mirror_1_1_grid2_d.html#a05b810f7466b59b26b243d83383d1274">Mirror.Grid2D.Add</a></div><div class="ttdeci">void Add(Vector2Int position, T value)</div><div class="ttdef"><b>Definition</b> <a href="_grid2_d_8cs_source.html#l00044">Grid2D.cs:44</a></div></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="dir_84bbf7b3c7f28a5a18725745e1505219.html">Assets</a></li><li class="navelem"><a class="el" href="dir_bf1dd3994e8f933eb733da65a1863113.html">Mirror</a></li><li class="navelem"><a class="el" href="dir_498e799cc6e42a51607844cb305aca07.html">Core</a></li><li class="navelem"><a class="el" href="dir_7d9830c00241f177d0ef11bc019552a9.html">Threading</a></li><li class="navelem"><a class="el" href="_concurrent_pool_8cs.html">ConcurrentPool.cs</a></li>
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.10.0 </li>
</ul>
</div>
</body>
</html>