blob: 7090afec21f4cef896a4f118da4683a6c4ff7424 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>CudaEvent (OpenJ9 CUDA Classes)</title>
<meta name="keywords" content="com.ibm.cuda.CudaEvent class">
<meta name="keywords" content="FLAG_DEFAULT">
<meta name="keywords" content="FLAG_BLOCKING_SYNC">
<meta name="keywords" content="FLAG_DISABLE_TIMING">
<meta name="keywords" content="FLAG_INTERPROCESS">
<meta name="keywords" content="close()">
<meta name="keywords" content="elapsedTimeSince()">
<meta name="keywords" content="query()">
<meta name="keywords" content="record()">
<meta name="keywords" content="synchronize()">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="CudaEvent (OpenJ9 CUDA Classes)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../com/ibm/cuda/package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/CudaEvent.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-all.html">Index</a></li>
<li><a href="../../../help-doc.html">Help</a></li>
</ul>
<div class="aboutLanguage"><strong>OpenJ9 CUDA Classes</strong></div>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../com/ibm/cuda/CudaError.html" title="interface in com.ibm.cuda"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../com/ibm/cuda/CudaException.html" title="class in com.ibm.cuda"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?com/ibm/cuda/CudaEvent.html" target="_top">Frames</a></li>
<li><a href="CudaEvent.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">com.ibm.cuda</div>
<h2 title="Class CudaEvent" class="title">Class CudaEvent</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" target="_blank" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li>com.ibm.cuda.CudaEvent</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/AutoCloseable.html?is-external=true" target="_blank" title="class or interface in java.lang">AutoCloseable</a></dd>
</dl>
<hr>
<br>
<pre>public final class <span class="typeNameLabel">CudaEvent</span>
extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" target="_blank" title="class or interface in java.lang">Object</a>
implements <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/AutoCloseable.html?is-external=true" target="_blank" title="class or interface in java.lang">AutoCloseable</a></pre>
<div class="block">The <code>CudaEvent</code> class represents an event that can be queued in a
stream on a CUDA-capable device.
<p>
When no longer required, an event must be <code>close</code>d.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/ibm/cuda/CudaEvent.html#FLAG_BLOCKING_SYNC">FLAG_BLOCKING_SYNC</a></span></code>
<div class="block">Use blocking synchronization.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/ibm/cuda/CudaEvent.html#FLAG_DEFAULT">FLAG_DEFAULT</a></span></code>
<div class="block">Default event creation flag.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/ibm/cuda/CudaEvent.html#FLAG_DISABLE_TIMING">FLAG_DISABLE_TIMING</a></span></code>
<div class="block">Do not record timing data.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/ibm/cuda/CudaEvent.html#FLAG_INTERPROCESS">FLAG_INTERPROCESS</a></span></code>
<div class="block">Event is suitable for interprocess use.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../com/ibm/cuda/CudaEvent.html#CudaEvent-com.ibm.cuda.CudaDevice-">CudaEvent</a></span>(<a href="../../../com/ibm/cuda/CudaDevice.html" title="class in com.ibm.cuda">CudaDevice</a>&nbsp;device)</code>
<div class="block">Creates a new event on the specified device with default flags.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../com/ibm/cuda/CudaEvent.html#CudaEvent-com.ibm.cuda.CudaDevice-int-">CudaEvent</a></span>(<a href="../../../com/ibm/cuda/CudaDevice.html" title="class in com.ibm.cuda">CudaDevice</a>&nbsp;device,
int&nbsp;flags)</code>
<div class="block">Creates a new event on the specified device with the specified <code>flags</code>.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/ibm/cuda/CudaEvent.html#close--">close</a></span>()</code>
<div class="block">Releases resources associated with this event.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>float</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/ibm/cuda/CudaEvent.html#elapsedTimeSince-com.ibm.cuda.CudaEvent-">elapsedTimeSince</a></span>(<a href="../../../com/ibm/cuda/CudaEvent.html" title="class in com.ibm.cuda">CudaEvent</a>&nbsp;priorEvent)</code>
<div class="block">Returns the elapsed time (in milliseconds) relative to the specified
<code>priorEvent</code>.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/ibm/cuda/CudaEvent.html#query--">query</a></span>()</code>
<div class="block">Queries the state of this event.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/ibm/cuda/CudaEvent.html#record-com.ibm.cuda.CudaDevice-">record</a></span>(<a href="../../../com/ibm/cuda/CudaDevice.html" title="class in com.ibm.cuda">CudaDevice</a>&nbsp;device)</code>
<div class="block">Records this event on the default stream of the specified device.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/ibm/cuda/CudaEvent.html#record-com.ibm.cuda.CudaStream-">record</a></span>(<a href="../../../com/ibm/cuda/CudaStream.html" title="class in com.ibm.cuda">CudaStream</a>&nbsp;stream)</code>
<div class="block">Records this event on the specified stream.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/ibm/cuda/CudaEvent.html#synchronize--">synchronize</a></span>()</code>
<div class="block">Synchronizes on this event.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" target="_blank" title="class or interface in java.lang">Object</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="FLAG_DEFAULT">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>FLAG_DEFAULT</h4>
<pre>public static final&nbsp;int FLAG_DEFAULT</pre>
<div class="block">Default event creation flag.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../constant-values.html#com.ibm.cuda.CudaEvent.FLAG_DEFAULT">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="FLAG_BLOCKING_SYNC">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>FLAG_BLOCKING_SYNC</h4>
<pre>public static final&nbsp;int FLAG_BLOCKING_SYNC</pre>
<div class="block">Use blocking synchronization.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../constant-values.html#com.ibm.cuda.CudaEvent.FLAG_BLOCKING_SYNC">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="FLAG_DISABLE_TIMING">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>FLAG_DISABLE_TIMING</h4>
<pre>public static final&nbsp;int FLAG_DISABLE_TIMING</pre>
<div class="block">Do not record timing data.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../constant-values.html#com.ibm.cuda.CudaEvent.FLAG_DISABLE_TIMING">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="FLAG_INTERPROCESS">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>FLAG_INTERPROCESS</h4>
<pre>public static final&nbsp;int FLAG_INTERPROCESS</pre>
<div class="block">Event is suitable for interprocess use. FLAG_DISABLE_TIMING must be set.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../constant-values.html#com.ibm.cuda.CudaEvent.FLAG_INTERPROCESS">Constant Field Values</a></dd>
</dl>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="CudaEvent-com.ibm.cuda.CudaDevice-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>CudaEvent</h4>
<pre>public&nbsp;CudaEvent(<a href="../../../com/ibm/cuda/CudaDevice.html" title="class in com.ibm.cuda">CudaDevice</a>&nbsp;device)
throws <a href="../../../com/ibm/cuda/CudaException.html" title="class in com.ibm.cuda">CudaException</a></pre>
<div class="block">Creates a new event on the specified device with default flags.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>device</code> - the specified device</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../com/ibm/cuda/CudaException.html" title="class in com.ibm.cuda">CudaException</a></code> - if a CUDA exception occurs</dd>
</dl>
</li>
</ul>
<a name="CudaEvent-com.ibm.cuda.CudaDevice-int-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>CudaEvent</h4>
<pre>public&nbsp;CudaEvent(<a href="../../../com/ibm/cuda/CudaDevice.html" title="class in com.ibm.cuda">CudaDevice</a>&nbsp;device,
int&nbsp;flags)
throws <a href="../../../com/ibm/cuda/CudaException.html" title="class in com.ibm.cuda">CudaException</a></pre>
<div class="block">Creates a new event on the specified device with the specified <code>flags</code>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>device</code> - the specified device</dd>
<dd><code>flags</code> - the desired flags</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../com/ibm/cuda/CudaException.html" title="class in com.ibm.cuda">CudaException</a></code> - if a CUDA exception occurs</dd>
</dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="close--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>close</h4>
<pre>public&nbsp;void&nbsp;close()
throws <a href="../../../com/ibm/cuda/CudaException.html" title="class in com.ibm.cuda">CudaException</a></pre>
<div class="block">Releases resources associated with this event.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/AutoCloseable.html?is-external=true#close--" title="class or interface in java.lang">close</a></code>&nbsp;in interface&nbsp;<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/AutoCloseable.html?is-external=true" target="_blank" title="class or interface in java.lang">AutoCloseable</a></code></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../com/ibm/cuda/CudaException.html" title="class in com.ibm.cuda">CudaException</a></code> - if a CUDA exception occurs</dd>
</dl>
</li>
</ul>
<a name="elapsedTimeSince-com.ibm.cuda.CudaEvent-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>elapsedTimeSince</h4>
<pre>public&nbsp;float&nbsp;elapsedTimeSince(<a href="../../../com/ibm/cuda/CudaEvent.html" title="class in com.ibm.cuda">CudaEvent</a>&nbsp;priorEvent)
throws <a href="../../../com/ibm/cuda/CudaException.html" title="class in com.ibm.cuda">CudaException</a></pre>
<div class="block">Returns the elapsed time (in milliseconds) relative to the specified
<code>priorEvent</code>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>priorEvent</code> - the prior event</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the elapsed time (in milliseconds) between the occurrence of
the prior event and this event</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../com/ibm/cuda/CudaException.html" title="class in com.ibm.cuda">CudaException</a></code> - if a CUDA exception occurs</dd>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalStateException.html?is-external=true" target="_blank" title="class or interface in java.lang">IllegalStateException</a></code> - if this event or the prior event has been closed (see <a href="../../../com/ibm/cuda/CudaEvent.html#close--"><code>close()</code></a>)</dd>
</dl>
</li>
</ul>
<a name="query--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>query</h4>
<pre>public&nbsp;int&nbsp;query()</pre>
<div class="block">Queries the state of this event.
The common normally occurring states are:
<ul>
<li>CudaError.Success - event has occurred</li>
<li>CudaError.NotReady - event has not occurred</li>
</ul></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the state of this event</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalStateException.html?is-external=true" target="_blank" title="class or interface in java.lang">IllegalStateException</a></code> - if this event has been closed (see <a href="../../../com/ibm/cuda/CudaEvent.html#close--"><code>close()</code></a>)</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../com/ibm/cuda/CudaError.html" title="interface in com.ibm.cuda"><code>CudaError</code></a></dd>
</dl>
</li>
</ul>
<a name="record-com.ibm.cuda.CudaDevice-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>record</h4>
<pre>public&nbsp;void&nbsp;record(<a href="../../../com/ibm/cuda/CudaDevice.html" title="class in com.ibm.cuda">CudaDevice</a>&nbsp;device)
throws <a href="../../../com/ibm/cuda/CudaException.html" title="class in com.ibm.cuda">CudaException</a></pre>
<div class="block">Records this event on the default stream of the specified device.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>device</code> - the specified device</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../com/ibm/cuda/CudaException.html" title="class in com.ibm.cuda">CudaException</a></code> - if a CUDA exception occurs</dd>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalStateException.html?is-external=true" target="_blank" title="class or interface in java.lang">IllegalStateException</a></code> - if this event has been closed (see <a href="../../../com/ibm/cuda/CudaEvent.html#close--"><code>close()</code></a>)</dd>
</dl>
</li>
</ul>
<a name="record-com.ibm.cuda.CudaStream-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>record</h4>
<pre>public&nbsp;void&nbsp;record(<a href="../../../com/ibm/cuda/CudaStream.html" title="class in com.ibm.cuda">CudaStream</a>&nbsp;stream)
throws <a href="../../../com/ibm/cuda/CudaException.html" title="class in com.ibm.cuda">CudaException</a></pre>
<div class="block">Records this event on the specified stream.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>stream</code> - the specified stream</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../com/ibm/cuda/CudaException.html" title="class in com.ibm.cuda">CudaException</a></code> - if a CUDA exception occurs</dd>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalStateException.html?is-external=true" target="_blank" title="class or interface in java.lang">IllegalStateException</a></code> - if this event has been closed (see <a href="../../../com/ibm/cuda/CudaEvent.html#close--"><code>close()</code></a>),
or the stream has been closed (see <a href="../../../com/ibm/cuda/CudaStream.html#close--"><code>CudaStream.close()</code></a>)</dd>
</dl>
</li>
</ul>
<a name="synchronize--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>synchronize</h4>
<pre>public&nbsp;void&nbsp;synchronize()
throws <a href="../../../com/ibm/cuda/CudaException.html" title="class in com.ibm.cuda">CudaException</a></pre>
<div class="block">Synchronizes on this event.
This method blocks until the associated event has occurred.</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../com/ibm/cuda/CudaException.html" title="class in com.ibm.cuda">CudaException</a></code> - if a CUDA exception occurs</dd>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalStateException.html?is-external=true" target="_blank" title="class or interface in java.lang">IllegalStateException</a></code> - if this event has been closed (see <a href="../../../com/ibm/cuda/CudaEvent.html#close--"><code>close()</code></a>)</dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../com/ibm/cuda/package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/CudaEvent.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-all.html">Index</a></li>
<li><a href="../../../help-doc.html">Help</a></li>
</ul>
<div class="aboutLanguage"><strong>OpenJ9 CUDA Classes</strong></div>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../com/ibm/cuda/CudaError.html" title="interface in com.ibm.cuda"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../com/ibm/cuda/CudaException.html" title="class in com.ibm.cuda"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?com/ibm/cuda/CudaEvent.html" target="_top">Frames</a></li>
<li><a href="CudaEvent.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small><a href="https://www.eclipse.org/openj9/" target="_blank">Eclipse OpenJ9 website.</a><br> To raise a bug report or suggest an improvement create an <a href="https://github.com/eclipse/openj9/issues" target="_blank">Eclipse OpenJ9 issue.</a><br> Copyright &copy; 2013, 2020, IBM Corp. and others.</small></p>
</body>
</html>