/usr/share/doc/racket/future-visualizer/futures-trace.html is in racket-doc 6.1-4.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html><head><meta http-equiv="content-type" content="text/html; charset=utf-8"/><title>3 Futures Tracing</title><link rel="stylesheet" type="text/css" href="../scribble.css" title="default"/><link rel="stylesheet" type="text/css" href="../racket.css" title="default"/><link rel="stylesheet" type="text/css" href="../manual-style.css" title="default"/><link rel="stylesheet" type="text/css" href="../manual-racket.css" title="default"/><link rel="stylesheet" type="text/css" href="../doc-site.css" title="default"/><script type="text/javascript" src="../scribble-common.js"></script><script type="text/javascript" src="../manual-racket.js"></script><script type="text/javascript" src="../doc-site.js"></script><script type="text/javascript" src="../local-redirect/local-redirect.js"></script><script type="text/javascript" src="../local-redirect/local-user-redirect.js"></script><!--[if IE 6]><style type="text/css">.SIEHidden { overflow: hidden; }</style><![endif]--></head><body id="doc-racket-lang-org"><div class="tocset"><div class="tocview"><div class="tocviewlist tocviewlisttopspace"><div class="tocviewtitle"><table cellspacing="0" cellpadding="0"><tr><td style="width: 1em;"><a href="javascript:void(0);" title="Expand/Collapse" class="tocviewtoggle" onclick="TocviewToggle(this,"tocview_0");">▼</a></td><td></td><td><a href="index.html" class="tocviewlink" data-pltdoc="x">Futures Visualizer</a></td></tr></table></div><div class="tocviewsublistonly" style="display: block;" id="tocview_0"><table cellspacing="0" cellpadding="0"><tr><td align="right">1 </td><td><a href="future-visualizer-timeline.html" class="tocviewlink" data-pltdoc="x">Execution Timeline</a></td></tr><tr><td align="right">2 </td><td><a href="future-visualizer-tree.html" class="tocviewlink" data-pltdoc="x">Future Creation Tree</a></td></tr><tr><td align="right">3 </td><td><a href="" class="tocviewselflink" data-pltdoc="x">Futures Tracing</a></td></tr></table></div></div></div><div class="tocsub"><div class="tocsubtitle">On this page:</div><table class="tocsublist" cellspacing="0"><tr><td><a href="#%28form._%28%28lib._future-visualizer%2Ftrace..rkt%29._trace-futures%29%29" class="tocsublink" data-pltdoc="x"><span class="RktSym"><span class="RktStxLink">trace-<wbr></wbr>futures</span></span></a></td></tr><tr><td><a href="#%28def._%28%28lib._future-visualizer%2Ftrace..rkt%29._trace-futures-thunk%29%29" class="tocsublink" data-pltdoc="x"><span class="RktSym"><span class="RktValLink">trace-<wbr></wbr>futures-<wbr></wbr>thunk</span></span></a></td></tr><tr><td><a href="#%28def._%28%28lib._future-visualizer%2Ftrace..rkt%29._start-future-tracing%21%29%29" class="tocsublink" data-pltdoc="x"><span class="RktSym"><span class="RktValLink">start-<wbr></wbr>future-<wbr></wbr>tracing!</span></span></a></td></tr><tr><td><a href="#%28def._%28%28lib._future-visualizer%2Ftrace..rkt%29._stop-future-tracing%21%29%29" class="tocsublink" data-pltdoc="x"><span class="RktSym"><span class="RktValLink">stop-<wbr></wbr>future-<wbr></wbr>tracing!</span></span></a></td></tr><tr><td><a href="#%28def._%28%28lib._future-visualizer%2Ftrace..rkt%29._timeline-events%29%29" class="tocsublink" data-pltdoc="x"><span class="RktSym"><span class="RktValLink">timeline-<wbr></wbr>events</span></span></a></td></tr><tr><td><a href="#%28def._%28%28lib._future-visualizer%2Ftrace..rkt%29._indexed-future-event%29%29" class="tocsublink" data-pltdoc="x"><span class="RktSym"><span class="RktValLink">indexed-<wbr></wbr>future-<wbr></wbr>event</span></span></a></td></tr><tr><td><a href="#%28def._%28%28lib._future-visualizer%2Ftrace..rkt%29._future-event%29%29" class="tocsublink" data-pltdoc="x"><span class="RktSym"><span class="RktValLink">future-<wbr></wbr>event</span></span></a></td></tr></table></div></div><div class="maincolumn"><div class="main"><div class="navsettop"><span class="navleft"><form class="searchform"><input class="searchbox" style="color: #888;" type="text" value="...search manuals..." title="Enter a search string to search the manuals" onkeypress="return DoSearchKey(event, this, "6.1", "../");" onfocus="this.style.color="black"; this.style.textAlign="left"; if (this.value == "...search manuals...") this.value="";" onblur="if (this.value.match(/^ *$/)) { this.style.color="#888"; this.style.textAlign="center"; this.value="...search manuals..."; }"/></form> <a href="../index.html" title="up to the documentation top" data-pltdoc="x" onclick="return GotoPLTRoot("6.1");">top</a></span><span class="navright"> <a href="future-visualizer-tree.html" title="backward to "2 Future Creation Tree"" data-pltdoc="x">← prev</a> <a href="index.html" title="up to "Futures Visualizer"" data-pltdoc="x">up</a> <span class="nonavigation">next →</span></span> </div><h3 x-source-module="(lib "future-visualizer/scribblings/future-visualizer.scrbl")" x-part-tag=""futures-trace"">3<tt> </tt><a name="(part._futures-trace)"></a><a name="(mod-path._future-visualizer/trace)"></a>Futures Tracing</h3><p><table cellspacing="0" cellpadding="0" class="defmodule"><tr><td align="left" colspan="2"><span class="hspace"> </span><span class="RktPn">(</span><span class="RktSym"><a href="http://download.racket-lang.org/docs/6.1/html/local-redirect/index.html?doc=reference&rel=require.html%23%2528form._%2528%2528lib._racket%252Fprivate%252Fbase..rkt%2529._require%2529%2529&version=6.1" class="RktStxLink Sq" data-pltdoc="x">require</a></span><span class="stt"> </span><a href="" class="RktModLink" data-pltdoc="x"><span class="RktSym">future-visualizer/trace</span></a><span class="RktPn">)</span></td></tr><tr><td align="left"> </td><td align="right"><span class="RpackageSpec"><span class="Smaller"> package:</span> <span class="stt">future-visualizer</span></span></td></tr></table></p><p>The <a name="(tech._futures._trace)"></a><span style="font-style: italic">futures trace</span> module exposes low-level information about
the execution of parallel programs written using <span class="RktSym"><a href="http://download.racket-lang.org/docs/6.1/html/local-redirect/index.html?doc=reference&rel=futures.html%23%2528def._%2528%2528lib._racket%252Ffuture..rkt%2529._future%2529%2529&version=6.1" class="RktValLink Sq" data-pltdoc="x">future</a></span>.</p><p><div class="SIntrapara"><blockquote class="SVInsetFlow"><table cellspacing="0" cellpadding="0" class="boxed RBoxed"><tr><td><table cellspacing="0" cellpadding="0" class="together"><tr><td><blockquote class="SubFlow"><div class="RBackgroundLabel SIEHidden"><div class="RBackgroundLabelInner"><p>syntax</p></div></div><p class="RForeground"><span class="RktPn">(</span><a name="(form._((lib._future-visualizer/trace..rkt)._trace-futures))"></a><span title="Provided from: future-visualizer/trace | Package: future-visualizer"><span class="RktSym"><a href="#%28form._%28%28lib._future-visualizer%2Ftrace..rkt%29._trace-futures%29%29" class="RktStxDef RktStxLink" data-pltdoc="x">trace-futures</a></span></span><span class="hspace"> </span><span class="RktVar">e</span><span class="hspace"> </span><span class="RktMeta">...</span><span class="RktPn">)</span></p></blockquote></td></tr></table></td></tr><tr><td><table cellspacing="0" cellpadding="0" class="together"><tr><td><blockquote class="SubFlow"><div class="RBackgroundLabel SIEHidden"><div class="RBackgroundLabelInner"><p>procedure</p></div></div><p class="RForeground"><span class="RktPn">(</span><a name="(def._((lib._future-visualizer/trace..rkt)._trace-futures-thunk))"></a><span title="Provided from: future-visualizer/trace | Package: future-visualizer"><span class="RktSym"><a href="#%28def._%28%28lib._future-visualizer%2Ftrace..rkt%29._trace-futures-thunk%29%29" class="RktValDef RktValLink" data-pltdoc="x">trace-futures-thunk</a></span></span><span class="hspace"> </span><span class="RktVar">thunk</span><span class="RktPn">)</span><span class="hspace"> </span>→<span class="hspace"> </span><span class="RktPn">(</span><span class="RktSym">listof</span><span class="hspace"> </span><span class="RktSym"><a href="#%28def._%28%28lib._future-visualizer%2Ftrace..rkt%29._indexed-future-event~3f%29%29" class="RktValLink" data-pltdoc="x">indexed-future-event?</a></span><span class="RktPn">)</span></p></blockquote></td></tr><tr><td><span class="hspace"> </span><span class="RktVar">thunk</span><span class="hspace"> </span>:<span class="hspace"> </span><span class="RktPn">(</span><span class="RktSym"><span class="nobreak">-></span></span><span class="hspace"> </span><span class="RktSym">any</span><span class="RktPn">)</span></td></tr></table></td></tr></table></blockquote></div><div class="SIntrapara">The <span class="RktSym"><a href="#%28form._%28%28lib._future-visualizer%2Ftrace..rkt%29._trace-futures%29%29" class="RktStxLink" data-pltdoc="x">trace-futures</a></span> macro and <span class="RktSym"><a href="#%28def._%28%28lib._future-visualizer%2Ftrace..rkt%29._trace-futures-thunk%29%29" class="RktValLink" data-pltdoc="x">trace-futures-thunk</a></span> function
track the execution of a program using futures and return the program
trace as a list of <span class="RktSym"><a href="#%28def._%28%28lib._future-visualizer%2Ftrace..rkt%29._indexed-future-event%29%29" class="RktValLink" data-pltdoc="x">indexed-future-event</a></span> structures.</div></p><p>This program:</p><blockquote class="SCodeFlow"><table cellspacing="0" cellpadding="0" class="RktBlk"><tr><td><span class="RktPn">(</span><span class="RktSym"><a href="http://download.racket-lang.org/docs/6.1/html/local-redirect/index.html?doc=reference&rel=require.html%23%2528form._%2528%2528lib._racket%252Fprivate%252Fbase..rkt%2529._require%2529%2529&version=6.1" class="RktStxLink Sq" data-pltdoc="x">require</a></span><span class="hspace"> </span><span class="RktSym">racket/future</span></td></tr><tr><td><span class="hspace"> </span><span class="RktSym">future-visualizer/trace</span><span class="RktPn">)</span></td></tr><tr><td><span class="hspace"> </span></td></tr><tr><td><span class="RktPn">(</span><span class="RktSym"><a href="#%28form._%28%28lib._future-visualizer%2Ftrace..rkt%29._trace-futures%29%29" class="RktStxLink" data-pltdoc="x">trace-futures</a></span></td></tr><tr><td><span class="hspace"> </span><span class="RktPn">(</span><span class="RktSym"><a href="http://download.racket-lang.org/docs/6.1/html/local-redirect/index.html?doc=reference&rel=let.html%23%2528form._%2528%2528lib._racket%252Fprivate%252Fletstx-scheme..rkt%2529._let%2529%2529&version=6.1" class="RktStxLink Sq" data-pltdoc="x">let</a></span><span class="hspace"> </span><span class="RktPn">(</span><span class="RktPn">[</span><span class="RktSym">f</span><span class="hspace"> </span><span class="RktPn">(</span><span class="RktSym"><a href="http://download.racket-lang.org/docs/6.1/html/local-redirect/index.html?doc=reference&rel=futures.html%23%2528def._%2528%2528lib._racket%252Ffuture..rkt%2529._future%2529%2529&version=6.1" class="RktValLink Sq" data-pltdoc="x">future</a></span><span class="hspace"> </span><span class="RktPn">(</span><span class="RktSym"><a href="http://download.racket-lang.org/docs/6.1/html/local-redirect/index.html?doc=reference&rel=lambda.html%23%2528form._%2528%2528lib._racket%252Fprivate%252Fbase..rkt%2529._lambda%2529%2529&version=6.1" class="RktStxLink Sq" data-pltdoc="x">lambda</a></span><span class="hspace"> </span><span class="RktPn">(</span><span class="RktPn">)</span><span class="hspace"> </span><span class="RktSym"><a href="http://download.racket-lang.org/docs/6.1/html/local-redirect/index.html?doc=reference&rel=stx-patterns.html%23%2528form._%2528%2528lib._racket%252Fprivate%252Fstxcase-scheme..rkt%2529._......%2529%2529&version=6.1" class="RktStxLink Sq" data-pltdoc="x">...</a></span><span class="RktPn">)</span><span class="RktPn">)</span><span class="RktPn">]</span><span class="RktPn">)</span></td></tr><tr><td><span class="hspace"> </span><span class="RktSym"><a href="http://download.racket-lang.org/docs/6.1/html/local-redirect/index.html?doc=reference&rel=stx-patterns.html%23%2528form._%2528%2528lib._racket%252Fprivate%252Fstxcase-scheme..rkt%2529._......%2529%2529&version=6.1" class="RktStxLink Sq" data-pltdoc="x">...</a></span></td></tr><tr><td><span class="hspace"> </span><span class="RktPn">(</span><span class="RktSym"><a href="http://download.racket-lang.org/docs/6.1/html/local-redirect/index.html?doc=reference&rel=futures.html%23%2528def._%2528%2528lib._racket%252Ffuture..rkt%2529._touch%2529%2529&version=6.1" class="RktValLink Sq" data-pltdoc="x">touch</a></span><span class="hspace"> </span><span class="RktSym">f</span><span class="RktPn">)</span><span class="RktPn">)</span><span class="RktPn">)</span></td></tr></table></blockquote><p>Is equivalent to:</p><blockquote class="SCodeFlow"><table cellspacing="0" cellpadding="0" class="RktBlk"><tr><td><span class="RktPn">(</span><span class="RktSym"><a href="http://download.racket-lang.org/docs/6.1/html/local-redirect/index.html?doc=reference&rel=require.html%23%2528form._%2528%2528lib._racket%252Fprivate%252Fbase..rkt%2529._require%2529%2529&version=6.1" class="RktStxLink Sq" data-pltdoc="x">require</a></span><span class="hspace"> </span><span class="RktSym">racket/future</span></td></tr><tr><td><span class="hspace"> </span><span class="RktSym">future-visualizer/trace</span><span class="RktPn">)</span></td></tr><tr><td><span class="hspace"> </span></td></tr><tr><td><span class="RktPn">(</span><span class="RktSym"><a href="#%28def._%28%28lib._future-visualizer%2Ftrace..rkt%29._start-future-tracing%21%29%29" class="RktValLink" data-pltdoc="x">start-future-tracing!</a></span><span class="RktPn">)</span></td></tr><tr><td><span class="RktPn">(</span><span class="RktSym"><a href="http://download.racket-lang.org/docs/6.1/html/local-redirect/index.html?doc=reference&rel=let.html%23%2528form._%2528%2528lib._racket%252Fprivate%252Fletstx-scheme..rkt%2529._let%2529%2529&version=6.1" class="RktStxLink Sq" data-pltdoc="x">let</a></span><span class="hspace"> </span><span class="RktPn">(</span><span class="RktPn">[</span><span class="RktSym">f</span><span class="hspace"> </span><span class="RktPn">(</span><span class="RktSym"><a href="http://download.racket-lang.org/docs/6.1/html/local-redirect/index.html?doc=reference&rel=futures.html%23%2528def._%2528%2528lib._racket%252Ffuture..rkt%2529._future%2529%2529&version=6.1" class="RktValLink Sq" data-pltdoc="x">future</a></span><span class="hspace"> </span><span class="RktPn">(</span><span class="RktSym"><a href="http://download.racket-lang.org/docs/6.1/html/local-redirect/index.html?doc=reference&rel=lambda.html%23%2528form._%2528%2528lib._racket%252Fprivate%252Fbase..rkt%2529._lambda%2529%2529&version=6.1" class="RktStxLink Sq" data-pltdoc="x">lambda</a></span><span class="hspace"> </span><span class="RktPn">(</span><span class="RktPn">)</span><span class="hspace"> </span><span class="RktSym"><a href="http://download.racket-lang.org/docs/6.1/html/local-redirect/index.html?doc=reference&rel=stx-patterns.html%23%2528form._%2528%2528lib._racket%252Fprivate%252Fstxcase-scheme..rkt%2529._......%2529%2529&version=6.1" class="RktStxLink Sq" data-pltdoc="x">...</a></span><span class="RktPn">)</span><span class="RktPn">)</span><span class="RktPn">]</span><span class="RktPn">)</span></td></tr><tr><td><span class="hspace"> </span><span class="RktSym"><a href="http://download.racket-lang.org/docs/6.1/html/local-redirect/index.html?doc=reference&rel=stx-patterns.html%23%2528form._%2528%2528lib._racket%252Fprivate%252Fstxcase-scheme..rkt%2529._......%2529%2529&version=6.1" class="RktStxLink Sq" data-pltdoc="x">...</a></span></td></tr><tr><td><span class="hspace"> </span><span class="RktPn">(</span><span class="RktSym"><a href="http://download.racket-lang.org/docs/6.1/html/local-redirect/index.html?doc=reference&rel=futures.html%23%2528def._%2528%2528lib._racket%252Ffuture..rkt%2529._touch%2529%2529&version=6.1" class="RktValLink Sq" data-pltdoc="x">touch</a></span><span class="hspace"> </span><span class="RktSym">f</span><span class="RktPn">)</span><span class="RktPn">)</span></td></tr><tr><td><span class="RktPn">(</span><span class="RktSym"><a href="#%28def._%28%28lib._future-visualizer%2Ftrace..rkt%29._stop-future-tracing%21%29%29" class="RktValLink" data-pltdoc="x">stop-future-tracing!</a></span><span class="RktPn">)</span></td></tr><tr><td><span class="RktPn">(</span><span class="RktSym"><a href="#%28def._%28%28lib._future-visualizer%2Ftrace..rkt%29._timeline-events%29%29" class="RktValLink" data-pltdoc="x">timeline-events</a></span><span class="RktPn">)</span></td></tr></table></blockquote><p><div class="SIntrapara"><blockquote class="SVInsetFlow"><table cellspacing="0" cellpadding="0" class="boxed RBoxed"><tr><td><table cellspacing="0" cellpadding="0" class="together"><tr><td><blockquote class="SubFlow"><div class="RBackgroundLabel SIEHidden"><div class="RBackgroundLabelInner"><p>procedure</p></div></div><p class="RForeground"><span class="RktPn">(</span><a name="(def._((lib._future-visualizer/trace..rkt)._start-future-tracing!))"></a><span title="Provided from: future-visualizer/trace | Package: future-visualizer"><span class="RktSym"><a href="#%28def._%28%28lib._future-visualizer%2Ftrace..rkt%29._start-future-tracing%21%29%29" class="RktValDef RktValLink" data-pltdoc="x">start-future-tracing!</a></span></span><span class="RktPn"></span><span class="RktPn">)</span><span class="hspace"> </span>→<span class="hspace"> </span><span class="RktSym"><a href="http://download.racket-lang.org/docs/6.1/html/local-redirect/index.html?doc=reference&rel=void.html%23%2528def._%2528%2528quote._%7E23%7E25kernel%2529._void%7E3f%2529%2529&version=6.1" class="RktValLink Sq" data-pltdoc="x">void?</a></span></p></blockquote></td></tr></table></td></tr><tr><td><table cellspacing="0" cellpadding="0" class="together"><tr><td><blockquote class="SubFlow"><div class="RBackgroundLabel SIEHidden"><div class="RBackgroundLabelInner"><p>procedure</p></div></div><p class="RForeground"><span class="RktPn">(</span><a name="(def._((lib._future-visualizer/trace..rkt)._stop-future-tracing!))"></a><span title="Provided from: future-visualizer/trace | Package: future-visualizer"><span class="RktSym"><a href="#%28def._%28%28lib._future-visualizer%2Ftrace..rkt%29._stop-future-tracing%21%29%29" class="RktValDef RktValLink" data-pltdoc="x">stop-future-tracing!</a></span></span><span class="RktPn"></span><span class="RktPn">)</span><span class="hspace"> </span>→<span class="hspace"> </span><span class="RktSym"><a href="http://download.racket-lang.org/docs/6.1/html/local-redirect/index.html?doc=reference&rel=void.html%23%2528def._%2528%2528quote._%7E23%7E25kernel%2529._void%7E3f%2529%2529&version=6.1" class="RktValLink Sq" data-pltdoc="x">void?</a></span></p></blockquote></td></tr></table></td></tr><tr><td><table cellspacing="0" cellpadding="0" class="together"><tr><td><blockquote class="SubFlow"><div class="RBackgroundLabel SIEHidden"><div class="RBackgroundLabelInner"><p>procedure</p></div></div><p class="RForeground"><span class="RktPn">(</span><a name="(def._((lib._future-visualizer/trace..rkt)._timeline-events))"></a><span title="Provided from: future-visualizer/trace | Package: future-visualizer"><span class="RktSym"><a href="#%28def._%28%28lib._future-visualizer%2Ftrace..rkt%29._timeline-events%29%29" class="RktValDef RktValLink" data-pltdoc="x">timeline-events</a></span></span><span class="RktPn"></span><span class="RktPn">)</span><span class="hspace"> </span>→<span class="hspace"> </span><span class="RktPn">(</span><span class="RktSym">listof</span><span class="hspace"> </span><span class="RktSym"><a href="#%28def._%28%28lib._future-visualizer%2Ftrace..rkt%29._indexed-future-event~3f%29%29" class="RktValLink" data-pltdoc="x">indexed-future-event?</a></span><span class="RktPn">)</span></p></blockquote></td></tr></table></td></tr></table></blockquote></div><div class="SIntrapara">The <span class="RktSym"><a href="#%28def._%28%28lib._future-visualizer%2Ftrace..rkt%29._start-future-tracing%21%29%29" class="RktValLink" data-pltdoc="x">start-future-tracing!</a></span> procedure enables the collection
of future-related execution data. This function should be called immediately
prior to executing code the programmer wishes to profile.</div></p><p>The <span class="RktSym"><a href="#%28def._%28%28lib._future-visualizer%2Ftrace..rkt%29._stop-future-tracing%21%29%29" class="RktValLink" data-pltdoc="x">stop-future-tracing!</a></span> procedure must be used to indicate the
end of code the programmer wishes to trace. Tracing works by simply using a
log receiver to record all future-related log events; this procedure logs a
special message that is well-known to the log receiver to mean ’stop recording’.</p><p>The <span class="RktSym"><a href="#%28def._%28%28lib._future-visualizer%2Ftrace..rkt%29._timeline-events%29%29" class="RktValLink" data-pltdoc="x">timeline-events</a></span> procedure returns the program trace as
a list of <span class="RktSym"><a href="#%28def._%28%28lib._future-visualizer%2Ftrace..rkt%29._indexed-future-event%29%29" class="RktValLink" data-pltdoc="x">indexed-future-event</a></span> structures.</p><p><div class="SIntrapara"><blockquote class="SVInsetFlow"><table cellspacing="0" cellpadding="0" class="boxed RBoxed"><tr><td><blockquote class="SubFlow"><div class="RBackgroundLabel SIEHidden"><div class="RBackgroundLabelInner"><p>struct</p></div></div><table cellspacing="0" cellpadding="0" class="RForeground"><tr><td><span class="RktPn">(</span><span class="RktSym"><a href="http://download.racket-lang.org/docs/6.1/html/local-redirect/index.html?doc=reference&rel=define-struct.html%23%2528form._%2528%2528lib._racket%252Fprivate%252Fbase..rkt%2529._struct%2529%2529&version=6.1" class="RktStxLink Sq" data-pltdoc="x">struct</a></span></td><td><span class="hspace"> </span></td><td><a name="(def._((lib._future-visualizer/trace..rkt)._indexed-future-event-event))"></a><a name="(def._((lib._future-visualizer/trace..rkt)._indexed-future-event-index))"></a><a name="(def._((lib._future-visualizer/trace..rkt)._make-indexed-future-event))"></a><a name="(def._((lib._future-visualizer/trace..rkt)._indexed-future-event~3f))"></a><a name="(def._((lib._future-visualizer/trace..rkt)._struct~3aindexed-future-event))"></a><a name="(def._((lib._future-visualizer/trace..rkt)._indexed-future-event))"></a><span title="Provided from: future-visualizer/trace | Package: future-visualizer"><span class="RktSym"><a href="#%28def._%28%28lib._future-visualizer%2Ftrace..rkt%29._indexed-future-event%29%29" class="RktValDef RktValLink" data-pltdoc="x">indexed-future-event</a></span></span><span class="hspace"> </span><span class="RktPn">(</span><span class="RktSym">index</span><span class="stt"> </span><span class="RktSym">event</span><span class="RktPn">)</span></td></tr></table></blockquote></td></tr><tr><td><span class="hspace"> </span><span class="RktPn">#:extra-constructor-name</span><span class="hspace"> </span><span class="RktSym">make-indexed-future-event</span><span class="RktPn">)</span></td></tr><tr><td><span class="hspace"> </span><span class="RktSym">index</span><span class="hspace"> </span>:<span class="hspace"> </span><span class="RktSym"><a href="http://download.racket-lang.org/docs/6.1/html/local-redirect/index.html?doc=reference&rel=number-types.html%23%2528def._%2528%2528quote._%7E23%7E25kernel%2529._exact-nonnegative-integer%7E3f%2529%2529&version=6.1" class="RktValLink Sq" data-pltdoc="x">exact-nonnegative-integer?</a></span></td></tr><tr><td><span class="hspace"> </span><span class="RktSym">event</span><span class="hspace"> </span>:<span class="hspace"> </span><span class="RktSym">any</span></td></tr></table></blockquote></div><div class="SIntrapara">Represents an individual log message in a program trace. In addition to
future events, the tracing code also records garbage collection events; hence
the <span class="RktSym">event</span> field may contain either a <span class="RktSym"><a href="#%28def._%28%28lib._future-visualizer%2Ftrace..rkt%29._future-event%29%29" class="RktValLink" data-pltdoc="x">future-event</a></span> or gc-info
<a href="http://download.racket-lang.org/docs/6.1/html/local-redirect/index.html?doc=reference&rel=structures.html%23%2528tech._prefab%2529&version=6.1" class="techoutside Sq" data-pltdoc="x"><span class="techinside">prefab</span></a> struct (see <a href="http://download.racket-lang.org/docs/6.1/html/local-redirect/index.html?doc=reference&rel=garbagecollection.html&version=6.1" class="Sq" data-pltdoc="x">Garbage Collection</a>),
where the latter describes a GC operation. Because multiple
<span class="RktSym"><a href="#%28def._%28%28lib._future-visualizer%2Ftrace..rkt%29._future-event%29%29" class="RktValLink" data-pltdoc="x">future-event</a></span> structures may contain identical timestamps, the
<span class="RktSym">index</span> field ranks them in the order in which they were recorded
in the log output.</div></p><p><div class="SIntrapara"><blockquote class="SVInsetFlow"><table cellspacing="0" cellpadding="0" class="boxed RBoxed"><tr><td><blockquote class="SubFlow"><div class="RBackgroundLabel SIEHidden"><div class="RBackgroundLabelInner"><p>struct</p></div></div><table cellspacing="0" cellpadding="0" class="RForeground"><tr><td><span class="RktPn">(</span><span class="RktSym"><a href="http://download.racket-lang.org/docs/6.1/html/local-redirect/index.html?doc=reference&rel=define-struct.html%23%2528form._%2528%2528lib._racket%252Fprivate%252Fbase..rkt%2529._struct%2529%2529&version=6.1" class="RktStxLink Sq" data-pltdoc="x">struct</a></span></td><td><span class="hspace"> </span></td><td><span class="nobreak"><a name="(def._((lib._future-visualizer/trace..rkt)._future-event-user-data))"></a><a name="(def._((lib._future-visualizer/trace..rkt)._future-event-prim-name))"></a><a name="(def._((lib._future-visualizer/trace..rkt)._future-event-time-id))"></a><a name="(def._((lib._future-visualizer/trace..rkt)._future-event-action))"></a><a name="(def._((lib._future-visualizer/trace..rkt)._future-event-proc-id))"></a><a name="(def._((lib._future-visualizer/trace..rkt)._future-event-future-id))"></a><a name="(def._((lib._future-visualizer/trace..rkt)._make-future-event))"></a><a name="(def._((lib._future-visualizer/trace..rkt)._future-event~3f))"></a><a name="(def._((lib._future-visualizer/trace..rkt)._struct~3afuture-event))"></a><a name="(def._((lib._future-visualizer/trace..rkt)._future-event))"></a><span title="Provided from: future-visualizer/trace | Package: future-visualizer"><span class="RktSym"><a href="#%28def._%28%28lib._future-visualizer%2Ftrace..rkt%29._future-event%29%29" class="RktValDef RktValLink" data-pltdoc="x">future-event</a></span></span></span></td><td><span class="hspace"> </span><span class="RktPn">(</span></td><td><span class="nobreak"><span class="RktSym">future-id</span></span></td></tr><tr><td><span class="hspace"> </span></td><td><span class="hspace"> </span></td><td><span class="hspace"> </span></td><td><span class="hspace"> </span></td><td><span class="RktSym">proc-id</span></td></tr><tr><td><span class="hspace"> </span></td><td><span class="hspace"> </span></td><td><span class="hspace"> </span></td><td><span class="hspace"> </span></td><td><span class="RktSym">action</span></td></tr><tr><td><span class="hspace"> </span></td><td><span class="hspace"> </span></td><td><span class="hspace"> </span></td><td><span class="hspace"> </span></td><td><span class="RktSym">time-id</span></td></tr><tr><td><span class="hspace"> </span></td><td><span class="hspace"> </span></td><td><span class="hspace"> </span></td><td><span class="hspace"> </span></td><td><span class="RktSym">prim-name</span></td></tr><tr><td><span class="hspace"> </span></td><td><span class="hspace"> </span></td><td><span class="hspace"> </span></td><td><span class="hspace"> </span></td><td><span class="RktSym">user-data</span><span class="RktPn">)</span></td></tr></table></blockquote></td></tr><tr><td><span class="hspace"> </span><span class="RktPn">#:extra-constructor-name</span><span class="hspace"> </span><span class="RktSym"><a href="#%28def._%28%28lib._future-visualizer%2Ftrace..rkt%29._make-future-event%29%29" class="RktValLink" data-pltdoc="x">make-future-event</a></span></td></tr><tr><td><span class="hspace"> </span><span class="RktPn">#:prefab</span><span class="RktPn">)</span></td></tr><tr><td><span class="hspace"> </span><span class="RktSym">future-id</span><span class="hspace"> </span>:<span class="hspace"> </span><span class="RktPn">(</span><span class="RktSym"><a href="http://download.racket-lang.org/docs/6.1/html/local-redirect/index.html?doc=reference&rel=if.html%23%2528form._%2528%2528lib._racket%252Fprivate%252Fletstx-scheme..rkt%2529._or%2529%2529&version=6.1" class="RktStxLink Sq" data-pltdoc="x">or</a></span><span class="hspace"> </span><span class="RktSym"><a href="http://download.racket-lang.org/docs/6.1/html/local-redirect/index.html?doc=reference&rel=number-types.html%23%2528def._%2528%2528quote._%7E23%7E25kernel%2529._exact-nonnegative-integer%7E3f%2529%2529&version=6.1" class="RktValLink Sq" data-pltdoc="x">exact-nonnegative-integer?</a></span><span class="hspace"> </span><span class="RktVal">#f</span><span class="RktPn">)</span></td></tr><tr><td><span class="hspace"> </span><span class="RktSym">proc-id</span><span class="hspace"> </span>:<span class="hspace"> </span><span class="RktSym"><a href="http://download.racket-lang.org/docs/6.1/html/local-redirect/index.html?doc=reference&rel=number-types.html%23%2528def._%2528%2528quote._%7E23%7E25kernel%2529._exact-nonnegative-integer%7E3f%2529%2529&version=6.1" class="RktValLink Sq" data-pltdoc="x">exact-nonnegative-integer?</a></span></td></tr><tr><td><span class="hspace"> </span><span class="RktSym">action</span><span class="hspace"> </span>:<span class="hspace"> </span><span class="RktSym"><a href="http://download.racket-lang.org/docs/6.1/html/local-redirect/index.html?doc=reference&rel=symbols.html%23%2528def._%2528%2528quote._%7E23%7E25kernel%2529._symbol%7E3f%2529%2529&version=6.1" class="RktValLink Sq" data-pltdoc="x">symbol?</a></span></td></tr><tr><td><span class="hspace"> </span><span class="RktSym">time-id</span><span class="hspace"> </span>:<span class="hspace"> </span><span class="RktSym"><a href="http://download.racket-lang.org/docs/6.1/html/local-redirect/index.html?doc=reference&rel=number-types.html%23%2528def._%2528%2528quote._%7E23%7E25kernel%2529._real%7E3f%2529%2529&version=6.1" class="RktValLink Sq" data-pltdoc="x">real?</a></span></td></tr><tr><td><span class="hspace"> </span><span class="RktSym">prim-name</span><span class="hspace"> </span>:<span class="hspace"> </span><span class="RktPn">(</span><span class="RktSym"><a href="http://download.racket-lang.org/docs/6.1/html/local-redirect/index.html?doc=reference&rel=if.html%23%2528form._%2528%2528lib._racket%252Fprivate%252Fletstx-scheme..rkt%2529._or%2529%2529&version=6.1" class="RktStxLink Sq" data-pltdoc="x">or</a></span><span class="hspace"> </span><span class="RktSym"><a href="http://download.racket-lang.org/docs/6.1/html/local-redirect/index.html?doc=reference&rel=symbols.html%23%2528def._%2528%2528quote._%7E23%7E25kernel%2529._symbol%7E3f%2529%2529&version=6.1" class="RktValLink Sq" data-pltdoc="x">symbol?</a></span><span class="hspace"> </span><span class="RktVal">#f</span><span class="RktPn">)</span></td></tr><tr><td><span class="hspace"> </span><span class="RktSym">user-data</span><span class="hspace"> </span>:<span class="hspace"> </span><span class="RktPn">(</span><span class="RktSym"><a href="http://download.racket-lang.org/docs/6.1/html/local-redirect/index.html?doc=reference&rel=if.html%23%2528form._%2528%2528lib._racket%252Fprivate%252Fletstx-scheme..rkt%2529._or%2529%2529&version=6.1" class="RktStxLink Sq" data-pltdoc="x">or</a></span><span class="hspace"> </span><span class="RktVal">#f</span><span class="hspace"> </span><span class="RktSym"><a href="http://download.racket-lang.org/docs/6.1/html/local-redirect/index.html?doc=reference&rel=symbols.html%23%2528def._%2528%2528quote._%7E23%7E25kernel%2529._symbol%7E3f%2529%2529&version=6.1" class="RktValLink Sq" data-pltdoc="x">symbol?</a></span><span class="hspace"> </span><span class="RktSym"><a href="http://download.racket-lang.org/docs/6.1/html/local-redirect/index.html?doc=reference&rel=number-types.html%23%2528def._%2528%2528quote._%7E23%7E25kernel%2529._exact-nonnegative-integer%7E3f%2529%2529&version=6.1" class="RktValLink Sq" data-pltdoc="x">exact-nonnegative-integer?</a></span><span class="RktPn">)</span></td></tr></table></blockquote></div><div class="SIntrapara">Represents a future event as logged by the run-time system. See
<a href="http://download.racket-lang.org/docs/6.1/html/local-redirect/index.html?doc=reference&rel=futures.html%23%2528part._future-logging%2529&version=6.1" class="Sq" data-pltdoc="x">Future Performance Logging</a> for more information.</div></p><div class="navsetbottom"><span class="navleft"><form class="searchform"><input class="searchbox" style="color: #888;" type="text" value="...search manuals..." title="Enter a search string to search the manuals" onkeypress="return DoSearchKey(event, this, "6.1", "../");" onfocus="this.style.color="black"; this.style.textAlign="left"; if (this.value == "...search manuals...") this.value="";" onblur="if (this.value.match(/^ *$/)) { this.style.color="#888"; this.style.textAlign="center"; this.value="...search manuals..."; }"/></form> <a href="../index.html" title="up to the documentation top" data-pltdoc="x" onclick="return GotoPLTRoot("6.1");">top</a></span><span class="navright"> <a href="future-visualizer-tree.html" title="backward to "2 Future Creation Tree"" data-pltdoc="x">← prev</a> <a href="index.html" title="up to "Futures Visualizer"" data-pltdoc="x">up</a> <span class="nonavigation">next →</span></span> </div></div></div><div id="contextindicator"> </div></body></html>
|