HCoop / hcoop / debian / mlton.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
Import Upstream version 20180207
[hcoop/debian/mlton.git] / doc / guide / localhost / ConcurrentML
CommitLineData
7f918cf1
CE		 1<!DOCTYPE html>\r
2<html lang="en">\r
3<head>\r
4<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">\r
5<meta name="generator" content="AsciiDoc 8.6.9">\r
6<title>ConcurrentML</title>\r
7<link rel="stylesheet" href="./asciidoc.css" type="text/css">\r
8<link rel="stylesheet" href="./pygments.css" type="text/css">\r
9\r
10\r
11<script type="text/javascript" src="./asciidoc.js"></script>\r
12<script type="text/javascript">\r
13/*<![CDATA[*/\r
14asciidoc.install();\r
15/*]]>*/\r
16</script>\r
17<link rel="stylesheet" href="./mlton.css" type="text/css">\r
18</head>\r
19<body class="article">\r
20<div id="banner">\r
21<div id="banner-home">\r
22<a href="./Home">MLton 20180207</a>\r
23</div>\r
24</div>\r
25<div id="header">\r
26<h1>ConcurrentML</h1>\r
27</div>\r
28<div id="content">\r
29<div id="preamble">\r
30<div class="sectionbody">\r
31<div class="paragraph"><p><a href="http://cml.cs.uchicago.edu/">Concurrent ML</a> is an SML concurrency\r
32library based on synchronous message passing. MLton has an initial\r
33port of CML from SML/NJ, but is missing a thread-safe wrapper around\r
34the Basis Library and event-based equivalents to <span class="monospaced">IO</span> and <span class="monospaced">OS</span>\r
35functions.</p></div>\r
36<div class="paragraph"><p>All of the core CML functionality is present.</p></div>\r
37<div class="listingblock">\r
38<div class="content"><div class="highlight"><pre><span class="k">structure</span><span class="w"> </span><span class="n">CML</span><span class="p">:</span><span class="w"> </span><span class="n">CML</span><span class="w"></span>\r
39<span class="k">structure</span><span class="w"> </span><span class="n">SyncVar</span><span class="p">:</span><span class="w"> </span><span class="n">SYNC_VAR</span><span class="w"></span>\r
40<span class="k">structure</span><span class="w"> </span><span class="n">Mailbox</span><span class="p">:</span><span class="w"> </span><span class="n">MAILBOX</span><span class="w"></span>\r
41<span class="k">structure</span><span class="w"> </span><span class="n">Multicast</span><span class="p">:</span><span class="w"> </span><span class="n">MULTICAST</span><span class="w"></span>\r
42<span class="k">structure</span><span class="w"> </span><span class="n">SimpleRPC</span><span class="p">:</span><span class="w"> </span><span class="n">SIMPLE_RPC</span><span class="w"></span>\r
43<span class="k">structure</span><span class="w"> </span><span class="n">RunCML</span><span class="p">:</span><span class="w"> </span><span class="n">RUN_CML</span><span class="w"></span>\r
44</pre></div></div></div>\r
45<div class="paragraph"><p>The <span class="monospaced">RUN_CML</span> signature is minimal.</p></div>\r
46<div class="listingblock">\r
47<div class="content"><div class="highlight"><pre><span class="k">signature</span><span class="w"> </span><span class="n">RUN_CML</span><span class="w"> </span><span class="p">=</span><span class="w"></span>\r
48<span class="w"> </span><span class="k">sig</span><span class="w"></span>\r
49<span class="w"> </span><span class="k">val</span><span class="w"> </span><span class="n">isRunning</span><span class="p">:</span><span class="w"> </span><span class="n">unit</span><span class="w"> </span><span class="p">-&gt;</span><span class="w"> </span><span class="n">bool</span><span class="w"></span>\r
50<span class="w"> </span><span class="k">val</span><span class="w"> </span><span class="n">doit</span><span class="p">:</span><span class="w"> </span><span class="p">(</span><span class="n">unit</span><span class="w"> </span><span class="p">-&gt;</span><span class="w"> </span><span class="n">unit</span><span class="p">)</span><span class="w"> </span><span class="n">*</span><span class="w"> </span><span class="n">Time</span><span class="p">.</span><span class="n">time</span><span class="w"> </span><span class="n">option</span><span class="w"> </span><span class="p">-&gt;</span><span class="w"> </span><span class="n">OS</span><span class="p">.</span><span class="n">Process</span><span class="p">.</span><span class="n">status</span><span class="w"></span>\r
51<span class="w"> </span><span class="k">val</span><span class="w"> </span><span class="n">shutdown</span><span class="p">:</span><span class="w"> </span><span class="n">OS</span><span class="p">.</span><span class="n">Process</span><span class="p">.</span><span class="n">status</span><span class="w"> </span><span class="p">-&gt;</span><span class="w"> </span><span class="n">&#39;a</span><span class="w"></span>\r
52<span class="w"> </span><span class="k">end</span><span class="w"></span>\r
53</pre></div></div></div>\r
54<div class="paragraph"><p>MLton&#8217;s <span class="monospaced">RunCML</span> structure does not include all of the cleanup and\r
55logging operations of SML/NJ&#8217;s <span class="monospaced">RunCML</span> structure. However, the\r
56implementation does include the <span class="monospaced">CML.timeOutEvt</span> and <span class="monospaced">CML.atTimeEvt</span>\r
57functions, and a preemptive scheduler that knows to sleep when there\r
58are no ready threads and some threads blocked on time events.</p></div>\r
59<div class="paragraph"><p>Because MLton does not wrap the Basis Library for CML, the "right" way\r
60to call a Basis Library function that is stateful is to wrap the call\r
61with <span class="monospaced">MLton.Thread.atomically</span>.</p></div>\r
62</div>\r
63</div>\r
64<div class="sect1">\r
65<h2 id="_usage">Usage</h2>\r
66<div class="sectionbody">\r
67<div class="ulist"><ul>\r
68<li>\r
69<p>\r
70You can import the CML Library into an MLB file with:\r
71</p>\r
72<table class="tableblock frame-all grid-all"\r
73style="\r
74width:100%;\r
75">\r
76<col style="width:50%;">\r
77<col style="width:50%;">\r
78<thead>\r
79<tr>\r
80<th class="tableblock halign-left valign-top" >MLB file</th>\r
81<th class="tableblock halign-left valign-top" >Description</th>\r
82</tr>\r
83</thead>\r
84<tbody>\r
85<tr>\r
86<td class="tableblock halign-left valign-top" ><p class="tableblock"><span class="monospaced">$(SML_LIB)/cml/cml.mlb</span></p></td>\r
87<td class="tableblock halign-left valign-top" ><p class="tableblock"></p></td>\r
88</tr>\r
89</tbody>\r
90</table>\r
91</li>\r
92<li>\r
93<p>\r
94If you are porting a project from SML/NJ&#8217;s <a href="CompilationManager">CompilationManager</a> to\r
95MLton&#8217;s <a href="MLBasis"> ML Basis system</a> using <span class="monospaced">cm2mlb</span>, note that the\r
96following map is included by default:\r
97</p>\r
98<div class="listingblock">\r
99<div class="content monospaced">\r
100<pre># CML Library\r
101$cml $(SML_LIB)/cml\r
102$cml/cml.cm $(SML_LIB)/cml/cml.mlb</pre>\r
103</div></div>\r
104<div class="paragraph"><p>This will automatically convert a <span class="monospaced">$cml/cml.cm</span> import in an input <span class="monospaced">.cm</span> file into a <span class="monospaced">$(SML_LIB)/cml/cml.mlb</span> import in the output <span class="monospaced">.mlb</span> file.</p></div>\r
105</li>\r
106</ul></div>\r
107</div>\r
108</div>\r
109<div class="sect1">\r
110<h2 id="_also_see">Also see</h2>\r
111<div class="sectionbody">\r
112<div class="ulist"><ul>\r
113<li>\r
114<p>\r
115<a href="ConcurrentMLImplementation">ConcurrentMLImplementation</a>\r
116</p>\r
117</li>\r
118<li>\r
119<p>\r
120<a href="eXene">eXene</a>\r
121</p>\r
122</li>\r
123</ul></div>\r
124</div>\r
125</div>\r
126</div>\r
127<div id="footnotes"><hr></div>\r
128<div id="footer">\r
129<div id="footer-text">\r
130</div>\r
131<div id="footer-badges">\r
132</div>\r
133</div>\r
134</body>\r
135</html>\r
mlton packaging