| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (14.0.1) on Tue Jun 15 20:48:08 PDT 2021 --> |
| <title>IFileTransferConnectStartEvent (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.filetransfer.events, interface: IFileTransferConnectStartEvent"> |
| <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}; |
| 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/IFileTransferConnectStartEvent.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.filetransfer.events</a></div> |
| <h1 title="Interface IFileTransferConnectStartEvent" class="title">Interface IFileTransferConnectStartEvent</h1> |
| </div> |
| <div class="contentContainer"> |
| <section class="description"> |
| <dl> |
| <dt>All Superinterfaces:</dt> |
| <dd><code><a href="../../core/util/Event.html" title="interface in org.eclipse.ecf.core.util">Event</a></code>, <code>org.eclipse.core.runtime.IAdaptable</code>, <code><a href="IFileTransferEvent.html" title="interface in org.eclipse.ecf.filetransfer.events">IFileTransferEvent</a></code></dd> |
| </dl> |
| <hr> |
| <pre>public interface <span class="typeNameLabel">IFileTransferConnectStartEvent</span> |
| extends org.eclipse.core.runtime.IAdaptable, <a href="IFileTransferEvent.html" title="interface in org.eclipse.ecf.filetransfer.events">IFileTransferEvent</a></pre> |
| <div class="block">Event sent to <a href="../IFileTransferListener.html" title="interface in org.eclipse.ecf.filetransfer"><code>IFileTransferListener</code></a> associated with |
| <a href="../IIncomingFileTransfer.html" title="interface in org.eclipse.ecf.filetransfer"><code>IIncomingFileTransfer</code></a> or |
| <a href="IOutgoingFileTransferEvent.html" title="interface in org.eclipse.ecf.filetransfer.events"><code>IOutgoingFileTransferEvent</code></a> or |
| <a href="../IRemoteFileSystemRequest.html" title="interface in org.eclipse.ecf.filetransfer"><code>IRemoteFileSystemRequest</code></a> instances. |
| <p> |
| The event is send before the first request is send to the server. |
| It allows the caller to get a handle to the transfer so that it can be |
| canceled. |
| A transfer may have to send several requests to one (or more |
| servers) until the retrieved or send data itself is send or received. |
| The entire phase before this is referred here as connect phase. |
| </p> |
| <p> |
| If <a href="#connectUsingJob(org.eclipse.ecf.filetransfer.FileTransferJob)"><code>connectUsingJob(FileTransferJob)</code></a> is called then the connect |
| phase is performed in a job. If not the caller may implement their own thread |
| in which it can cancel the request. The expectation is that the |
| cancellation will react with little delay, typically in less than 1 second. |
| </p> |
| <p> |
| Not all providers support this event. |
| </p></div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>3.0</dd> |
| </dl> |
| </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>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#cancel()">cancel</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Cancel file transfer.</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="#connectUsingJob(org.eclipse.ecf.filetransfer.FileTransferJob)">connectUsingJob</a></span>​(<a href="../FileTransferJob.html" title="class in org.eclipse.ecf.filetransfer">FileTransferJob</a> connectJob)</code></th> |
| <td class="colLast"> |
| <div class="block">Connect using a job.</div> |
| </td> |
| </tr> |
| <tr class="altColor" id="i2"> |
| <td class="colFirst"><code><a href="../identity/IFileID.html" title="interface in org.eclipse.ecf.filetransfer.identity">IFileID</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getFileID()">getFileID</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor" id="i3"> |
| <td class="colFirst"><code><a href="../FileTransferJob.html" title="class in org.eclipse.ecf.filetransfer">FileTransferJob</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#prepareConnectJob(org.eclipse.ecf.filetransfer.FileTransferJob)">prepareConnectJob</a></span>​(<a href="../FileTransferJob.html" title="class in org.eclipse.ecf.filetransfer">FileTransferJob</a> connectJob)</code></th> |
| <td class="colLast"> |
| <div class="block">Prepare custom connect job or get default connect job.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| </div> |
| <div class="inheritedList"> |
| <h3>Methods inherited from interface org.eclipse.core.runtime.IAdaptable</h3> |
| <a id="methods.inherited.from.class.org.eclipse.core.runtime.IAdaptable"> |
| <!-- --> |
| </a><code>getAdapter</code></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="getFileID()">getFileID</a></h3> |
| <div class="memberSignature"><span class="returnType"><a href="../identity/IFileID.html" title="interface in org.eclipse.ecf.filetransfer.identity">IFileID</a></span> <span class="memberName">getFileID</span>()</div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="cancel()">cancel</a></h3> |
| <div class="memberSignature"><span class="returnType">void</span> <span class="memberName">cancel</span>()</div> |
| <div class="block">Cancel file transfer.</div> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="prepareConnectJob(org.eclipse.ecf.filetransfer.FileTransferJob)">prepareConnectJob</a></h3> |
| <div class="memberSignature"><span class="returnType"><a href="../FileTransferJob.html" title="class in org.eclipse.ecf.filetransfer">FileTransferJob</a></span> <span class="memberName">prepareConnectJob</span>​(<span class="arguments"><a href="../FileTransferJob.html" title="class in org.eclipse.ecf.filetransfer">FileTransferJob</a> connectJob)</span></div> |
| <div class="block">Prepare custom connect job or get default connect job. |
| <p> |
| As a result the connect job will be tied to the transfer. Only if the |
| returned job is passed into |
| <a href="#connectUsingJob(org.eclipse.ecf.filetransfer.FileTransferJob)"><code>connectUsingJob(FileTransferJob)</code></a> will it actually be scheduled to |
| run. |
| </p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>connectJob</code> - A subclass of <a href="../FileTransferJob.html" title="class in org.eclipse.ecf.filetransfer"><code>FileTransferJob</code></a> to use to run the |
| connection process. If <code>null</code>, the provider will |
| use create and prepare a default connect job. |
| NOTE: the given job should *not* be |
| scheduled/started prior to being provided as a parameter to |
| this method.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>passed in job or default connect job if parameter connectJob was |
| null.</dd> |
| </dl> |
| </section> |
| </li> |
| <li class="blockList"> |
| <section class="detail"> |
| <h3><a id="connectUsingJob(org.eclipse.ecf.filetransfer.FileTransferJob)">connectUsingJob</a></h3> |
| <div class="memberSignature"><span class="returnType">void</span> <span class="memberName">connectUsingJob</span>​(<span class="arguments"><a href="../FileTransferJob.html" title="class in org.eclipse.ecf.filetransfer">FileTransferJob</a> connectJob)</span></div> |
| <div class="block">Connect using a job. |
| <p> |
| The passed in connectJob must have been prepared using |
| <a href="#prepareConnectJob(org.eclipse.ecf.filetransfer.FileTransferJob)"><code>prepareConnectJob(FileTransferJob)</code></a>. |
| The job may be scheduled after the caller returns from handling of |
| the <a href="IFileTransferConnectStartEvent.html" title="interface in org.eclipse.ecf.filetransfer.events"><code>IFileTransferConnectStartEvent</code></a>. As this is provider |
| implementation specific it must not relied on. |
| </p></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>connectJob</code> - A subclass of <a href="../FileTransferJob.html" title="class in org.eclipse.ecf.filetransfer"><code>FileTransferJob</code></a> to use to run the |
| connection process. Must not be <code>null</code>. |
| NOTE: the given job should *not* be |
| scheduled/started prior to being provided as a parameter to |
| this method.</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/IFileTransferConnectStartEvent.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> |
