| <!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 (1.8.0_272) on Thu Nov 12 16:27:22 PST 2020 --> |
| <title>Execution (Apache Geode 1.13.1)</title> |
| <meta name="date" content="2020-11-12"> |
| <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="Execution (Apache Geode 1.13.1)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":38,"i6":6,"i7":6}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],32:["t6","Deprecated 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="../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</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> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../org/apache/geode/cache/execute/EmptyRegionFunctionException.html" title="class in org.apache.geode.cache.execute"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/geode/cache/execute/Function.html" title="interface in org.apache.geode.cache.execute"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/geode/cache/execute/Execution.html" target="_top">Frames</a></li> |
| <li><a href="Execution.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../../allclasses-noframe.html">All 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: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </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">org.apache.geode.cache.execute</div> |
| <h2 title="Interface Execution" class="title">Interface Execution<IN,OUT,AGG></h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt><span class="paramLabel">Type Parameters:</span></dt> |
| <dd><code>IN</code> - The type of the argument passed into the function, if any</dd> |
| <dd><code>OUT</code> - The type of results sent by the function</dd> |
| <dd><code>AGG</code> - The type of the aggregated result returned by the ResultCollector</dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public interface <span class="typeNameLabel">Execution<IN,OUT,AGG></span></pre> |
| <div class="block">Provides methods to build the context for the execution of a <a href="../../../../../org/apache/geode/cache/execute/Function.html" title="interface in org.apache.geode.cache.execute"><code>Function</code></a> . A Context |
| describes the environment in which the <a href="../../../../../org/apache/geode/cache/execute/Execution.html" title="interface in org.apache.geode.cache.execute"><code>Execution</code></a> will take place. |
| <p> |
| This interface is implemented by GemFire. To obtain an instance of it use |
| <a href="../../../../../org/apache/geode/cache/execute/FunctionService.html" title="class in org.apache.geode.cache.execute"><code>FunctionService</code></a>.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>GemFire 6.0</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../org/apache/geode/cache/execute/FunctionService.html" title="class in org.apache.geode.cache.execute"><code>FunctionService</code></a>, |
| <a href="../../../../../org/apache/geode/cache/execute/Function.html" title="interface in org.apache.geode.cache.execute"><code>Function</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========== 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"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated Methods</a></span><span class="tabEnd"> </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><a href="../../../../../org/apache/geode/cache/execute/ResultCollector.html" title="interface in org.apache.geode.cache.execute">ResultCollector</a><<a href="../../../../../org/apache/geode/cache/execute/Execution.html" title="type parameter in Execution">OUT</a>,<a href="../../../../../org/apache/geode/cache/execute/Execution.html" title="type parameter in Execution">AGG</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/geode/cache/execute/Execution.html#execute-org.apache.geode.cache.execute.Function-">execute</a></span>(<a href="../../../../../org/apache/geode/cache/execute/Function.html" title="interface in org.apache.geode.cache.execute">Function</a> function)</code> |
| <div class="block">Executes the function instance provided.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/geode/cache/execute/ResultCollector.html" title="interface in org.apache.geode.cache.execute">ResultCollector</a><<a href="../../../../../org/apache/geode/cache/execute/Execution.html" title="type parameter in Execution">OUT</a>,<a href="../../../../../org/apache/geode/cache/execute/Execution.html" title="type parameter in Execution">AGG</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/geode/cache/execute/Execution.html#execute-org.apache.geode.cache.execute.Function-long-java.util.concurrent.TimeUnit-">execute</a></span>(<a href="../../../../../org/apache/geode/cache/execute/Function.html" title="interface in org.apache.geode.cache.execute">Function</a> function, |
| long timeout, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/TimeUnit.html?is-external=true" title="class or interface in java.util.concurrent">TimeUnit</a> unit)</code> |
| <div class="block">Executes the function instance provided.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/geode/cache/execute/ResultCollector.html" title="interface in org.apache.geode.cache.execute">ResultCollector</a><<a href="../../../../../org/apache/geode/cache/execute/Execution.html" title="type parameter in Execution">OUT</a>,<a href="../../../../../org/apache/geode/cache/execute/Execution.html" title="type parameter in Execution">AGG</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/geode/cache/execute/Execution.html#execute-java.lang.String-">execute</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> functionId)</code> |
| <div class="block">Executes the function using its <a href="../../../../../org/apache/geode/cache/execute/Function.html#getId--">id</a>.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/geode/cache/execute/ResultCollector.html" title="interface in org.apache.geode.cache.execute">ResultCollector</a><<a href="../../../../../org/apache/geode/cache/execute/Execution.html" title="type parameter in Execution">OUT</a>,<a href="../../../../../org/apache/geode/cache/execute/Execution.html" title="type parameter in Execution">AGG</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/geode/cache/execute/Execution.html#execute-java.lang.String-long-java.util.concurrent.TimeUnit-">execute</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> functionId, |
| long timeout, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/TimeUnit.html?is-external=true" title="class or interface in java.util.concurrent">TimeUnit</a> unit)</code> |
| <div class="block">Executes the function using its <a href="../../../../../org/apache/geode/cache/execute/Function.html#getId--">id</a> with the specified timeout.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/geode/cache/execute/Execution.html" title="interface in org.apache.geode.cache.execute">Execution</a><<a href="../../../../../org/apache/geode/cache/execute/Execution.html" title="type parameter in Execution">IN</a>,<a href="../../../../../org/apache/geode/cache/execute/Execution.html" title="type parameter in Execution">OUT</a>,<a href="../../../../../org/apache/geode/cache/execute/Execution.html" title="type parameter in Execution">AGG</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/geode/cache/execute/Execution.html#setArguments-IN-">setArguments</a></span>(<a href="../../../../../org/apache/geode/cache/execute/Execution.html" title="type parameter in Execution">IN</a> args)</code> |
| <div class="block">Specifies the user data passed to the function when it is executed.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/geode/cache/execute/Execution.html" title="interface in org.apache.geode.cache.execute">Execution</a><<a href="../../../../../org/apache/geode/cache/execute/Execution.html" title="type parameter in Execution">IN</a>,<a href="../../../../../org/apache/geode/cache/execute/Execution.html" title="type parameter in Execution">OUT</a>,<a href="../../../../../org/apache/geode/cache/execute/Execution.html" title="type parameter in Execution">AGG</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/geode/cache/execute/Execution.html#withArgs-IN-">withArgs</a></span>(<a href="../../../../../org/apache/geode/cache/execute/Execution.html" title="type parameter in Execution">IN</a> args)</code> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="block"><span class="deprecationComment">use <a href="../../../../../org/apache/geode/cache/execute/Execution.html#setArguments-IN-"><code>setArguments(Object)</code></a> instead</span></div> |
| </div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/geode/cache/execute/Execution.html" title="interface in org.apache.geode.cache.execute">Execution</a><<a href="../../../../../org/apache/geode/cache/execute/Execution.html" title="type parameter in Execution">IN</a>,<a href="../../../../../org/apache/geode/cache/execute/Execution.html" title="type parameter in Execution">OUT</a>,<a href="../../../../../org/apache/geode/cache/execute/Execution.html" title="type parameter in Execution">AGG</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/geode/cache/execute/Execution.html#withCollector-org.apache.geode.cache.execute.ResultCollector-">withCollector</a></span>(<a href="../../../../../org/apache/geode/cache/execute/ResultCollector.html" title="interface in org.apache.geode.cache.execute">ResultCollector</a><<a href="../../../../../org/apache/geode/cache/execute/Execution.html" title="type parameter in Execution">OUT</a>,<a href="../../../../../org/apache/geode/cache/execute/Execution.html" title="type parameter in Execution">AGG</a>> rc)</code> |
| <div class="block">Specifies the <a href="../../../../../org/apache/geode/cache/execute/ResultCollector.html" title="interface in org.apache.geode.cache.execute"><code>ResultCollector</code></a> that will receive the results after the function has been |
| executed.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/geode/cache/execute/Execution.html" title="interface in org.apache.geode.cache.execute">Execution</a><<a href="../../../../../org/apache/geode/cache/execute/Execution.html" title="type parameter in Execution">IN</a>,<a href="../../../../../org/apache/geode/cache/execute/Execution.html" title="type parameter in Execution">OUT</a>,<a href="../../../../../org/apache/geode/cache/execute/Execution.html" title="type parameter in Execution">AGG</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/geode/cache/execute/Execution.html#withFilter-java.util.Set-">withFilter</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><?> filter)</code> |
| <div class="block">Specifies a data filter of routing objects for selecting the GemFire members to execute the |
| function on.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="withFilter-java.util.Set-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>withFilter</h4> |
| <pre><a href="../../../../../org/apache/geode/cache/execute/Execution.html" title="interface in org.apache.geode.cache.execute">Execution</a><<a href="../../../../../org/apache/geode/cache/execute/Execution.html" title="type parameter in Execution">IN</a>,<a href="../../../../../org/apache/geode/cache/execute/Execution.html" title="type parameter in Execution">OUT</a>,<a href="../../../../../org/apache/geode/cache/execute/Execution.html" title="type parameter in Execution">AGG</a>> withFilter(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><?> filter)</pre> |
| <div class="block">Specifies a data filter of routing objects for selecting the GemFire members to execute the |
| function on. |
| <p> |
| Applicable only for regions with <a href="../../../../../org/apache/geode/cache/DataPolicy.html#PARTITION"><code>DataPolicy.PARTITION</code></a> DataPolicy. If the filter is |
| null, it will execute on all data of the region.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>filter</code> - Set defining the data filter to be used for executing the function</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>an Execution with the filter</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - if filter passed is null.</dd> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/UnsupportedOperationException.html?is-external=true" title="class or interface in java.lang">UnsupportedOperationException</a></code> - if not called after |
| <a href="../../../../../org/apache/geode/cache/execute/FunctionService.html#onRegion-org.apache.geode.cache.Region-"><code>FunctionService.onRegion(org.apache.geode.cache.Region)</code></a></dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>GemFire 6.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setArguments-java.lang.Object-"> |
| <!-- --> |
| </a><a name="setArguments-IN-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setArguments</h4> |
| <pre><a href="../../../../../org/apache/geode/cache/execute/Execution.html" title="interface in org.apache.geode.cache.execute">Execution</a><<a href="../../../../../org/apache/geode/cache/execute/Execution.html" title="type parameter in Execution">IN</a>,<a href="../../../../../org/apache/geode/cache/execute/Execution.html" title="type parameter in Execution">OUT</a>,<a href="../../../../../org/apache/geode/cache/execute/Execution.html" title="type parameter in Execution">AGG</a>> setArguments(<a href="../../../../../org/apache/geode/cache/execute/Execution.html" title="type parameter in Execution">IN</a> args)</pre> |
| <div class="block">Specifies the user data passed to the function when it is executed. The function can retrieve |
| these arguments using <a href="../../../../../org/apache/geode/cache/execute/FunctionContext.html#getArguments--"><code>FunctionContext.getArguments()</code></a></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>args</code> - user data passed to the function execution</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>an Execution with args</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - if the input parameter is null</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>Geode 1.2</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="withArgs-java.lang.Object-"> |
| <!-- --> |
| </a><a name="withArgs-IN-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>withArgs</h4> |
| <pre><a href="../../../../../org/apache/geode/cache/execute/Execution.html" title="interface in org.apache.geode.cache.execute">Execution</a><<a href="../../../../../org/apache/geode/cache/execute/Execution.html" title="type parameter in Execution">IN</a>,<a href="../../../../../org/apache/geode/cache/execute/Execution.html" title="type parameter in Execution">OUT</a>,<a href="../../../../../org/apache/geode/cache/execute/Execution.html" title="type parameter in Execution">AGG</a>> withArgs(<a href="../../../../../org/apache/geode/cache/execute/Execution.html" title="type parameter in Execution">IN</a> args)</pre> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">use <a href="../../../../../org/apache/geode/cache/execute/Execution.html#setArguments-IN-"><code>setArguments(Object)</code></a> instead</span></div> |
| <div class="block">Specifies the user data passed to the function when it is executed. The function can retrieve |
| these arguments using <a href="../../../../../org/apache/geode/cache/execute/FunctionContext.html#getArguments--"><code>FunctionContext.getArguments()</code></a></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>args</code> - user data passed to the function execution</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>an Execution with args</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - if the input parameter is null</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>GemFire 6.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="withCollector-org.apache.geode.cache.execute.ResultCollector-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>withCollector</h4> |
| <pre><a href="../../../../../org/apache/geode/cache/execute/Execution.html" title="interface in org.apache.geode.cache.execute">Execution</a><<a href="../../../../../org/apache/geode/cache/execute/Execution.html" title="type parameter in Execution">IN</a>,<a href="../../../../../org/apache/geode/cache/execute/Execution.html" title="type parameter in Execution">OUT</a>,<a href="../../../../../org/apache/geode/cache/execute/Execution.html" title="type parameter in Execution">AGG</a>> withCollector(<a href="../../../../../org/apache/geode/cache/execute/ResultCollector.html" title="interface in org.apache.geode.cache.execute">ResultCollector</a><<a href="../../../../../org/apache/geode/cache/execute/Execution.html" title="type parameter in Execution">OUT</a>,<a href="../../../../../org/apache/geode/cache/execute/Execution.html" title="type parameter in Execution">AGG</a>> rc)</pre> |
| <div class="block">Specifies the <a href="../../../../../org/apache/geode/cache/execute/ResultCollector.html" title="interface in org.apache.geode.cache.execute"><code>ResultCollector</code></a> that will receive the results after the function has been |
| executed. Collector will receive results as they are sent from the |
| <a href="../../../../../org/apache/geode/cache/execute/Function.html#execute-org.apache.geode.cache.execute.FunctionContext-"><code>Function.execute(FunctionContext)</code></a> using <a href="../../../../../org/apache/geode/cache/execute/ResultSender.html" title="interface in org.apache.geode.cache.execute"><code>ResultSender</code></a>.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>an Execution with a collector</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - if <a href="../../../../../org/apache/geode/cache/execute/ResultCollector.html" title="interface in org.apache.geode.cache.execute"><code>ResultCollector</code></a> is null</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>GemFire 6.0</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../org/apache/geode/cache/execute/ResultCollector.html" title="interface in org.apache.geode.cache.execute"><code>ResultCollector</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="execute-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>execute</h4> |
| <pre><a href="../../../../../org/apache/geode/cache/execute/ResultCollector.html" title="interface in org.apache.geode.cache.execute">ResultCollector</a><<a href="../../../../../org/apache/geode/cache/execute/Execution.html" title="type parameter in Execution">OUT</a>,<a href="../../../../../org/apache/geode/cache/execute/Execution.html" title="type parameter in Execution">AGG</a>> execute(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> functionId) |
| throws <a href="../../../../../org/apache/geode/cache/execute/FunctionException.html" title="class in org.apache.geode.cache.execute">FunctionException</a></pre> |
| <div class="block">Executes the function using its <a href="../../../../../org/apache/geode/cache/execute/Function.html#getId--">id</a>. |
| When executed from a client, it blocks until all results have been received |
| or the global timeout (gemfire.CLIENT_FUNCTION_TIMEOUT Java property), if set, has expired. |
| <p> |
| <a href="../../../../../org/apache/geode/cache/execute/Function.html#execute-org.apache.geode.cache.execute.FunctionContext-"><code>Function.execute(FunctionContext)</code></a> is called on the instance retrieved using |
| <a href="../../../../../org/apache/geode/cache/execute/FunctionService.html#getFunction-java.lang.String-"><code>FunctionService.getFunction(String)</code></a> on the executing member.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>functionId</code> - id of the function to execute</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>ResultCollector to retrieve the results received. This is different object than the |
| ResultCollector provided in <a href="../../../../../org/apache/geode/cache/execute/Execution.html#withCollector-org.apache.geode.cache.execute.ResultCollector-"><code>withCollector(ResultCollector)</code></a>. User has |
| to use this reference to retrieve results.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../../org/apache/geode/cache/LowMemoryException.html" title="class in org.apache.geode.cache">LowMemoryException</a></code> - if the <a href="../../../../../org/apache/geode/cache/execute/Function.html#optimizeForWrite--"><code>Function.optimizeForWrite()</code></a> returns true and there is |
| a low memory condition</dd> |
| <dd><code><a href="../../../../../org/apache/geode/cache/execute/FunctionException.html" title="class in org.apache.geode.cache.execute">FunctionException</a></code></dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>GemFire 6.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="execute-java.lang.String-long-java.util.concurrent.TimeUnit-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>execute</h4> |
| <pre><a href="../../../../../org/apache/geode/cache/execute/ResultCollector.html" title="interface in org.apache.geode.cache.execute">ResultCollector</a><<a href="../../../../../org/apache/geode/cache/execute/Execution.html" title="type parameter in Execution">OUT</a>,<a href="../../../../../org/apache/geode/cache/execute/Execution.html" title="type parameter in Execution">AGG</a>> execute(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> functionId, |
| long timeout, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/TimeUnit.html?is-external=true" title="class or interface in java.util.concurrent">TimeUnit</a> unit) |
| throws <a href="../../../../../org/apache/geode/cache/execute/FunctionException.html" title="class in org.apache.geode.cache.execute">FunctionException</a></pre> |
| <div class="block">Executes the function using its <a href="../../../../../org/apache/geode/cache/execute/Function.html#getId--">id</a> with the specified timeout. |
| It blocks until all results have been received or the timeout has expired. |
| <p> |
| <a href="../../../../../org/apache/geode/cache/execute/Function.html#execute-org.apache.geode.cache.execute.FunctionContext-"><code>Function.execute(FunctionContext)</code></a> is called on the instance retrieved using |
| <a href="../../../../../org/apache/geode/cache/execute/FunctionService.html#getFunction-java.lang.String-"><code>FunctionService.getFunction(String)</code></a> on the executing member.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>functionId</code> - id of the function to execute</dd> |
| <dd><code>timeout</code> - time to wait for the operation to finish before timing out</dd> |
| <dd><code>unit</code> - timeout unit</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>ResultCollector to retrieve the results received. This is different object than the |
| ResultCollector provided in <a href="../../../../../org/apache/geode/cache/execute/Execution.html#withCollector-org.apache.geode.cache.execute.ResultCollector-"><code>withCollector(ResultCollector)</code></a>. User has |
| to use this reference to retrieve results.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../../org/apache/geode/cache/execute/FunctionException.html" title="class in org.apache.geode.cache.execute">FunctionException</a></code></dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>Geode 1.11</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="execute-org.apache.geode.cache.execute.Function-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>execute</h4> |
| <pre><a href="../../../../../org/apache/geode/cache/execute/ResultCollector.html" title="interface in org.apache.geode.cache.execute">ResultCollector</a><<a href="../../../../../org/apache/geode/cache/execute/Execution.html" title="type parameter in Execution">OUT</a>,<a href="../../../../../org/apache/geode/cache/execute/Execution.html" title="type parameter in Execution">AGG</a>> execute(<a href="../../../../../org/apache/geode/cache/execute/Function.html" title="interface in org.apache.geode.cache.execute">Function</a> function) |
| throws <a href="../../../../../org/apache/geode/cache/execute/FunctionException.html" title="class in org.apache.geode.cache.execute">FunctionException</a></pre> |
| <div class="block">Executes the function instance provided. |
| When executed from a client, it blocks until all results have been received |
| or the global timeout (gemfire.CLIENT_FUNCTION_TIMEOUT Java property), if set, has expired. |
| <p> |
| <a href="../../../../../org/apache/geode/cache/execute/Function.html#execute-org.apache.geode.cache.execute.FunctionContext-"><code>Function.execute(FunctionContext)</code></a> is called on the de-serialized instance on the |
| executing member.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>function</code> - instance to execute</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>ResultCollector to retrieve the results received. This is different object than the |
| ResultCollector provided in <a href="../../../../../org/apache/geode/cache/execute/Execution.html#withCollector-org.apache.geode.cache.execute.ResultCollector-"><code>withCollector(ResultCollector)</code></a>. User has |
| to use this reference to retrieve results.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../../org/apache/geode/cache/LowMemoryException.html" title="class in org.apache.geode.cache">LowMemoryException</a></code> - if the <a href="../../../../../org/apache/geode/cache/execute/Function.html#optimizeForWrite--"><code>Function.optimizeForWrite()</code></a> returns true and there is |
| a low memory condition</dd> |
| <dd><code><a href="../../../../../org/apache/geode/cache/execute/FunctionException.html" title="class in org.apache.geode.cache.execute">FunctionException</a></code></dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>GemFire 6.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="execute-org.apache.geode.cache.execute.Function-long-java.util.concurrent.TimeUnit-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>execute</h4> |
| <pre><a href="../../../../../org/apache/geode/cache/execute/ResultCollector.html" title="interface in org.apache.geode.cache.execute">ResultCollector</a><<a href="../../../../../org/apache/geode/cache/execute/Execution.html" title="type parameter in Execution">OUT</a>,<a href="../../../../../org/apache/geode/cache/execute/Execution.html" title="type parameter in Execution">AGG</a>> execute(<a href="../../../../../org/apache/geode/cache/execute/Function.html" title="interface in org.apache.geode.cache.execute">Function</a> function, |
| long timeout, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/TimeUnit.html?is-external=true" title="class or interface in java.util.concurrent">TimeUnit</a> unit) |
| throws <a href="../../../../../org/apache/geode/cache/execute/FunctionException.html" title="class in org.apache.geode.cache.execute">FunctionException</a></pre> |
| <div class="block">Executes the function instance provided. |
| It blocks until all results have been received or the timeout has expired. |
| <p> |
| <a href="../../../../../org/apache/geode/cache/execute/Function.html#execute-org.apache.geode.cache.execute.FunctionContext-"><code>Function.execute(FunctionContext)</code></a> is called on the de-serialized instance on the |
| executing member.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>function</code> - instance to execute</dd> |
| <dd><code>timeout</code> - time to wait for the operation to finish before timing out</dd> |
| <dd><code>unit</code> - timeout unit</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>ResultCollector to retrieve the results received. This is different object than the |
| ResultCollector provided in <a href="../../../../../org/apache/geode/cache/execute/Execution.html#withCollector-org.apache.geode.cache.execute.ResultCollector-"><code>withCollector(ResultCollector)</code></a>. User has |
| to use this reference to retrieve results.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../../org/apache/geode/cache/LowMemoryException.html" title="class in org.apache.geode.cache">LowMemoryException</a></code> - if the <a href="../../../../../org/apache/geode/cache/execute/Function.html#optimizeForWrite--"><code>Function.optimizeForWrite()</code></a> returns true and there is |
| a low memory condition</dd> |
| <dd><code><a href="../../../../../org/apache/geode/cache/execute/FunctionException.html" title="class in org.apache.geode.cache.execute">FunctionException</a></code></dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>Geode 1.11</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="../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</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> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../org/apache/geode/cache/execute/EmptyRegionFunctionException.html" title="class in org.apache.geode.cache.execute"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/geode/cache/execute/Function.html" title="interface in org.apache.geode.cache.execute"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/geode/cache/execute/Execution.html" target="_top">Frames</a></li> |
| <li><a href="Execution.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../allclasses-noframe.html">All 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: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </body> |
| </html> |