| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (14.0.1) on Tue Jun 15 21:55:05 PDT 2021 --> |
| <title>IRemoteService (Eclipse Communication Framework (ECF) 3.14.22 API)</title> |
| <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> |
| <meta name="dc.created" content="2021-06-15"> |
| <meta name="description" content="declaration: package: org.eclipse.ecf.remoteservice, interface: IRemoteService"> |
| <meta name="generator" content="javadoc/ClassWriterImpl"> |
| <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.css" title="Style"> |
| <script type="text/javascript" src="../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../script-dir/jszip/dist/jszip.min.js"></script> |
| <script type="text/javascript" src="../../../../script-dir/jszip-utils/dist/jszip-utils.min.js"></script> |
| <!--[if IE]> |
| <script type="text/javascript" src="../../../../script-dir/jszip-utils/dist/jszip-utils-ie.min.js"></script> |
| <![endif]--> |
| <script type="text/javascript" src="../../../../script-dir/jquery-3.4.1.js"></script> |
| <script type="text/javascript" src="../../../../script-dir/jquery-ui.js"></script> |
| </head> |
| <body class="class-declaration"> |
| <script type="text/javascript">var data = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| var pathtoroot = "../../../../"; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <div class="flexBox"> |
| <header role="banner" class="flexHeader"> |
| <nav role="navigation"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a id="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/IRemoteService.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-files/index-1.html">Index</a></li> |
| <li><a href="../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <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> |
| <div class="navListSearch"><label for="search">SEARCH:</label> |
| <input type="text" id="search" value="search" disabled="disabled"> |
| <input type="reset" id="reset" value="reset" disabled="disabled"> |
| </div> |
| </div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <div class="skipNav"><a id="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| </nav> |
| </header> |
| <div class="flexContent"> |
| <main role="main"> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle"><span class="packageLabelInType">Package</span> <a href="package-summary.html">org.eclipse.ecf.remoteservice</a></div> |
| <h1 title="Interface IRemoteService" class="title">Interface IRemoteService</h1> |
| </div> |
| <div class="contentContainer"> |
| <section class="description"> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><code><a href="client/AbstractClientService.html" title="class in org.eclipse.ecf.remoteservice.client">AbstractClientService</a></code>, <code><a href="AbstractRemoteService.html" title="class in org.eclipse.ecf.remoteservice">AbstractRemoteService</a></code>, <code><a href="rest/client/AbstractRestClientService.html" title="class in org.eclipse.ecf.remoteservice.rest.client">AbstractRestClientService</a></code>, <code><a href="client/AbstractRSAClientService.html" title="class in org.eclipse.ecf.remoteservice.client">AbstractRSAClientService</a></code>, <code><a href="../provider/remoteservice/generic/RemoteServiceImpl.html" title="class in org.eclipse.ecf.provider.remoteservice.generic">RemoteServiceImpl</a></code>, <code><a href="rest/client/RestClientService.html" title="class in org.eclipse.ecf.remoteservice.rest.client">RestClientService</a></code></dd> |
| </dl> |
| <hr> |
| <pre>public interface <span class="typeNameLabel">IRemoteService</span></pre> |
| <div class="block">Interface providing runtime access to a remote service. An instance |
| implementing this interface will be returned from the |
| IRemoteServiceContainerAdapter.getRemoteService(IRemoteServiceReference) and |
| may then be used to communicate with a remote service. The methods on this |
| interface support accessing the remote service in several ways:<br> |
| <ul> |
| <li>callSync -- A synchronous invocation that will block the calling thread |
| until complete (or timeout) and return the result from the remote or throw |
| exception if remote invocation fails or throws exception</li> |
| <li>callAsync/1 -- An asynchronous invocation that will not block the caller |
| thread but rather return a non-<code>null</code> <code>IFuture</code> instance |
| that can be polled for results. See <code>IFuture.get()</code>, |
| <code>IFuture.get(long)</code>, and <code>IFuture.isDone()</code>. |
| timeout, exception, or successful completion)</li> |
| <li>callAsync/2 -- An asynchronous invocation that will not block the caller |
| thread but rather notify the given listener asynchronously when complete (via |
| timeout, exception, or successful completion)</li> |
| <li>fireAsync -- An asynchronous invocation that will simply execute the |
| remote method asynchronously, but will not provide any response or remote |
| method failure information</li> |
| <li>getProxy -- Access to a local proxy for the remote service that will |
| expose the appropriate interface to the caller, and synchronously call the |
| remote methods when invoked. |
| </ul></div> |
| </section> |
| <section class="summary"> |
| <ul class="blockList"> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <li class="blockList"> |
| <section class="methodSummary"><a id="method.summary"> |
| <!-- --> |
| </a> |
| <h2>Method Summary</h2> |
| <div class="memberSummary"> |
| <div role="tablist" aria-orientation="horizontal"><button role="tab" aria-selected="true" aria-controls="memberSummary_tabpanel" tabindex="0" onkeydown="switchTab(event)" id="t0" class="activeTableTab">All Methods</button><button role="tab" aria-selected="false" aria-controls="memberSummary_tabpanel" tabindex="-1" onkeydown="switchTab(event)" id="t2" class="tableTab" onclick="show(2);">Instance Methods</button><button role="tab" aria-selected="false" aria-controls="memberSummary_tabpanel" tabindex="-1" onkeydown="switchTab(event)" id="t3" class="tableTab" onclick="show(4);">Abstract Methods</button></div> |
| <div id="memberSummary_tabpanel" role="tabpanel"> |
| <table aria-labelledby="t0"> |
| <thead> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colSecond" scope="col">Method</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr class="altColor" id="i0"> |
| <td class="colFirst"><code>org.eclipse.equinox.concurrent.future.IFuture</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#callAsync(org.eclipse.ecf.remoteservice.IRemoteCall)">callAsync</a></span>​(<a href="IRemoteCall.html" title="interface in org.eclipse.ecf.remoteservice">IRemoteCall</a> call)</code></th> |
| <td class="colLast"> |
| <div class="block">Call remote method specified by call parameter asynchronously, and immediately |
| return <code>IFuture</code> instance.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i1"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#callAsync(org.eclipse.ecf.remoteservice.IRemoteCall,org.eclipse.ecf.remoteservice.IRemoteCallListener)">callAsync</a></span>​(<a href="IRemoteCall.html" title="interface in org.eclipse.ecf.remoteservice">IRemoteCall</a> call, |
| <a href="IRemoteCallListener.html" title="interface in org.eclipse.ecf.remoteservice">IRemoteCallListener</a> listener)</code></th> |
| <td class="colLast"> |
| <div class="block">Call remote method specified by call parameter asynchronously, and notify |
| specified listener when call starts and completes.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i2"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#callSync(org.eclipse.ecf.remoteservice.IRemoteCall)">callSync</a></span>​(<a href="IRemoteCall.html" title="interface in org.eclipse.ecf.remoteservice">IRemoteCall</a> call)</code></th> |
| <td class="colLast"> |
| <div class="block">Call remote method specified by call parameter synchronously.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i3"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#fireAsync(org.eclipse.ecf.remoteservice.IRemoteCall)">fireAsync</a></span>​(<a href="IRemoteCall.html" title="interface in org.eclipse.ecf.remoteservice">IRemoteCall</a> call)</code></th> |
| <td class="colLast"> |
| <div class="block">Fire remote method specified by call parameter.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i4"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getProxy()">getProxy</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Get local proxy for remote interface.</div> |
| </td> |
| </tr> |
| <tr class="rowColor" id="i5"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getProxy(java.lang.ClassLoader,java.lang.Class%5B%5D)">getProxy</a></span>​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/ClassLoader.html?is-external=true" title="class or interface in java.lang" class="externalLink">ClassLoader</a> cl, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a>[] interfaceClasses)</code></th> |
| <td class="colLast"> |
| <div class="block">Get local proxy for remote interface.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="blockList"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <li class="blockList"> |
| <section class="methodDetails"><a id="method.detail"> |
| <!-- --> |
| </a> |
| <h2>Method Details</h2> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="callSync(org.eclipse.ecf.remoteservice.IRemoteCall)">callSync</a></h3> |
| <div class="memberSignature"><span class="returnType"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></span> <span class="memberName">callSync</span>​(<span class="arguments"><a href="IRemoteCall.html" title="interface in org.eclipse.ecf.remoteservice">IRemoteCall</a> call)</span> |
| throws <span class="exceptions"><a href="../core/util/ECFException.html" title="class in org.eclipse.ecf.core.util">ECFException</a></span></div> |
| <div class="block">Call remote method specified by call parameter synchronously.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>call</code> - the remote call to make</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Object the result of the call. Will be <code>null</code> if |
| remote provides <code>null</code> as result.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../core/util/ECFException.html" title="class in org.eclipse.ecf.core.util">ECFException</a></code> - thrown if disconnect occurs, caller not currently connected, |
| or remote throws Exception</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>3.0</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="callAsync(org.eclipse.ecf.remoteservice.IRemoteCall,org.eclipse.ecf.remoteservice.IRemoteCallListener)">callAsync</a></h3> |
| <div class="memberSignature"><span class="returnType">void</span> <span class="memberName">callAsync</span>​(<span class="arguments"><a href="IRemoteCall.html" title="interface in org.eclipse.ecf.remoteservice">IRemoteCall</a> call, |
| <a href="IRemoteCallListener.html" title="interface in org.eclipse.ecf.remoteservice">IRemoteCallListener</a> listener)</span></div> |
| <div class="block">Call remote method specified by call parameter asynchronously, and notify |
| specified listener when call starts and completes.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>call</code> - the remote call to make. Must not be <code>null</code> .</dd> |
| <dd><code>listener</code> - the listener to notify when call starts and is completed. The |
| listener will be notified via the two event types |
| IRemoteCallStartEvent and IRemoteCallCompleteEvent. Must not |
| be <code>null</code> .</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>3.0</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="events/IRemoteCallStartEvent.html" title="interface in org.eclipse.ecf.remoteservice.events"><code>IRemoteCallStartEvent</code></a>, |
| <a href="events/IRemoteCallCompleteEvent.html" title="interface in org.eclipse.ecf.remoteservice.events"><code>IRemoteCallCompleteEvent</code></a></dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="callAsync(org.eclipse.ecf.remoteservice.IRemoteCall)">callAsync</a></h3> |
| <div class="memberSignature"><span class="returnType">org.eclipse.equinox.concurrent.future.IFuture</span> <span class="memberName">callAsync</span>​(<span class="arguments"><a href="IRemoteCall.html" title="interface in org.eclipse.ecf.remoteservice">IRemoteCall</a> call)</span></div> |
| <div class="block">Call remote method specified by call parameter asynchronously, and immediately |
| return <code>IFuture</code> instance. Returned IFuture will not be <code>null</code>, |
| and allows the caller to retrieve the actual resulting value from the remote call |
| (or exception).</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>call</code> - the remote call to make. Must not be <code>null</code> .</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>IFuture the asynchronous result to allow the caller to poll |
| for whether the result <code>IFuture.isDone()</code>, and then to <code>IFuture.get()</code> |
| the actual result.</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>3.0</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="fireAsync(org.eclipse.ecf.remoteservice.IRemoteCall)">fireAsync</a></h3> |
| <div class="memberSignature"><span class="returnType">void</span> <span class="memberName">fireAsync</span>​(<span class="arguments"><a href="IRemoteCall.html" title="interface in org.eclipse.ecf.remoteservice">IRemoteCall</a> call)</span> |
| throws <span class="exceptions"><a href="../core/util/ECFException.html" title="class in org.eclipse.ecf.core.util">ECFException</a></span></div> |
| <div class="block">Fire remote method specified by call parameter. The remote method will be |
| invoked as a result of asynchronous message send, but no |
| failure/exception information will be returned, and no result will be |
| returned</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>call</code> - the remote call to make. Must not be <code>null</code> .</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../core/util/ECFException.html" title="class in org.eclipse.ecf.core.util">ECFException</a></code> - if caller not currently connected</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>3.0</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="getProxy()">getProxy</a></h3> |
| <div class="memberSignature"><span class="returnType"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></span> <span class="memberName">getProxy</span>() |
| throws <span class="exceptions"><a href="../core/util/ECFException.html" title="class in org.eclipse.ecf.core.util">ECFException</a></span></div> |
| <div class="block">Get local proxy for remote interface. The local proxy may then be used to |
| make remote method calls transparently by invoking the local proxy method</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Object that implements the interface specified in the |
| IRemoteServiceReference instance used to retrieve the |
| IRemoteService object. The result may then be cast to the |
| appropriate type. Will not be <code>null</code>.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../core/util/ECFException.html" title="class in org.eclipse.ecf.core.util">ECFException</a></code> - If some problem in creating the proxy. The underlying problem is |
| conveyed in the nested exception.</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="getProxy(java.lang.ClassLoader,java.lang.Class[])">getProxy</a></h3> |
| <div class="memberSignature"><span class="returnType"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></span> <span class="memberName">getProxy</span>​(<span class="arguments"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/ClassLoader.html?is-external=true" title="class or interface in java.lang" class="externalLink">ClassLoader</a> cl, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a>[] interfaceClasses)</span> |
| throws <span class="exceptions"><a href="../core/util/ECFException.html" title="class in org.eclipse.ecf.core.util">ECFException</a></span></div> |
| <div class="block">Get local proxy for remote interface. The local proxy may then be used to |
| make remote method calls transparently by invoking the local proxy method</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>cl</code> - ClassLoader to use to create the proxy class. |
| Must not be <code>null</code>.</dd> |
| <dd><code>interfaceClasses</code> - array of Class that has the loaded interface classes. |
| Must not be <code>null</code> and should have dimension of one or more.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Object that implements the given interfaceClasses. The result may then |
| be cast to the one of the types given in interfaceClasses. Will not be |
| <code>null</code></dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../core/util/ECFException.html" title="class in org.eclipse.ecf.core.util">ECFException</a></code> - If some problem in creating the proxy. The underlying problem is |
| conveyed in the nested exception.</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>6.0</dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </main> |
| <footer role="contentinfo"> |
| <nav role="navigation"> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a id="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/IRemoteService.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-files/index-1.html">Index</a></li> |
| <li><a href="../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <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> |
| </div> |
| <a id="skip.navbar.bottom"> |
| <!-- --> |
| </a> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </nav> |
| <p class="legalCopy"><small>Copyright © 2004–2020 <a href="https://www.eclipse.org/">Eclipse Foundation</a>. All rights reserved.</small></p> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |
