doc/bundles/org.eclipse.ecf.doc/html/reference/api/org/eclipse/ecf/filetransfer/IOutgoingFileTransfer.html - gerrit/ecf/org.eclipse.ecf - Git at Google

 <!DOCTYPE HTML>
 <!-- NewPage -->
 <html lang="en">
 <head>
 <!-- Generated by javadoc (14.0.1) on Tue Jun 15 21:55:05 PDT 2021 -->
 <title>IOutgoingFileTransfer (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, interface: IOutgoingFileTransfer">
 <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};
 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/IOutgoingFileTransfer.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:&nbsp;</li>
 <li>Nested&nbsp;|&nbsp;</li>
 <li>Field&nbsp;|&nbsp;</li>
 <li>Constr&nbsp;|&nbsp;</li>
 <li><a href="#method.summary">Method</a></li>
 </ul>
 <ul class="subNavList">
 <li>Detail:&nbsp;</li>
 <li>Field&nbsp;|&nbsp;</li>
 <li>Constr&nbsp;|&nbsp;</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>&nbsp;<a href="package-summary.html">org.eclipse.ecf.filetransfer</a></div>
 <h1 title="Interface IOutgoingFileTransfer" class="title">Interface IOutgoingFileTransfer</h1>
 </div>
 <div class="contentContainer">
 <section class="description">
 <dl>
 <dt>All Superinterfaces:</dt>
 <dd><code>org.eclipse.core.runtime.IAdaptable</code>, <code><a href="IFileTransfer.html" title="interface in org.eclipse.ecf.filetransfer">IFileTransfer</a></code>, <code><a href="../core/identity/IIdentifiable.html" title="interface in org.eclipse.ecf.core.identity">IIdentifiable</a></code></dd>
 </dl>
 <dl>
 <dt>All Known Implementing Classes:</dt>
 <dd><code><a href="../provider/filetransfer/outgoing/AbstractOutgoingFileTransfer.html" title="class in org.eclipse.ecf.provider.filetransfer.outgoing">AbstractOutgoingFileTransfer</a></code>, <code><a href="../provider/filetransfer/outgoing/AbstractUrlConnectionOutgoingFileTransfer.html" title="class in org.eclipse.ecf.provider.filetransfer.outgoing">AbstractUrlConnectionOutgoingFileTransfer</a></code>, <code><a href="../provider/filetransfer/outgoing/LocalFileOutgoingFileTransfer.html" title="class in org.eclipse.ecf.provider.filetransfer.outgoing">LocalFileOutgoingFileTransfer</a></code></dd>
 </dl>
 <hr>
 <pre>public interface <span class="typeNameLabel">IOutgoingFileTransfer</span>
 extends <a href="IFileTransfer.html" title="interface in org.eclipse.ecf.filetransfer">IFileTransfer</a></pre>
 <div class="block">Outgoing file transfer.</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>long</code></td>
 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getBytesSent()">getBytesSent</a></span>()</code></th>
 <td class="colLast">
 <div class="block">Get the number of bytes sent for this outgoing file transfer.</div>
 </td>
 </tr>
 </tbody>
 </table>
 </div>
 </div>
 <div class="inheritedList">
 <h3>Methods inherited from interface&nbsp;org.eclipse.core.runtime.IAdaptable</h3>
 <a id="methods.inherited.from.class.org.eclipse.core.runtime.IAdaptable">
 <!--   -->
 </a><code>getAdapter</code></div>
 <div class="inheritedList">
 <h3>Methods inherited from interface&nbsp;org.eclipse.ecf.filetransfer.<a href="IFileTransfer.html" title="interface in org.eclipse.ecf.filetransfer">IFileTransfer</a></h3>
 <a id="methods.inherited.from.class.org.eclipse.ecf.filetransfer.IFileTransfer">
 <!--   -->
 </a><code><a href="IFileTransfer.html#cancel()">cancel</a>, <a href="IFileTransfer.html#getException()">getException</a>, <a href="IFileTransfer.html#getFileLength()">getFileLength</a>, <a href="IFileTransfer.html#getPercentComplete()">getPercentComplete</a>, <a href="IFileTransfer.html#isDone()">isDone</a></code></div>
 <div class="inheritedList">
 <h3>Methods inherited from interface&nbsp;org.eclipse.ecf.core.identity.<a href="../core/identity/IIdentifiable.html" title="interface in org.eclipse.ecf.core.identity">IIdentifiable</a></h3>
 <a id="methods.inherited.from.class.org.eclipse.ecf.core.identity.IIdentifiable">
 <!--   -->
 </a><code><a href="../core/identity/IIdentifiable.html#getID()">getID</a></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="getBytesSent()">getBytesSent</a></h3>
 <div class="memberSignature"><span class="returnType">long</span>&nbsp;<span class="memberName">getBytesSent</span>()</div>
 <div class="block">Get the number of bytes sent for this outgoing file transfer. Returns 0
  if transfer has not be started, and -1 if underlying provider does not
  support reporting number of bytes sent during transfer.</div>
 <dl>
 <dt><span class="returnLabel">Returns:</span></dt>
 <dd>number of bytes sent. Returns 0 if the outgoing file transfer has
          not been started, and -1 if provider does not support reporting
          of number of bytes received during transfer</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/IOutgoingFileTransfer.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:&nbsp;</li>
 <li>Nested&nbsp;|&nbsp;</li>
 <li>Field&nbsp;|&nbsp;</li>
 <li>Constr&nbsp;|&nbsp;</li>
 <li><a href="#method.summary">Method</a></li>
 </ul>
 <ul class="subNavList">
 <li>Detail:&nbsp;</li>
 <li>Field&nbsp;|&nbsp;</li>
 <li>Constr&nbsp;|&nbsp;</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 &#169; 2004&#x2013;2020 <a href="https://www.eclipse.org/">Eclipse Foundation</a>. All rights reserved.</small></p>
 </footer>
 </div>
 </div>
 </body>
 </html>
	<!DOCTYPE HTML>
	<!-- NewPage -->
	<html lang="en">
	<head>
	<!-- Generated by javadoc (14.0.1) on Tue Jun 15 21:55:05 PDT 2021 -->
	<title>IOutgoingFileTransfer (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, interface: IOutgoingFileTransfer">
	<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};
	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/IOutgoingFileTransfer.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</a></div>
	<h1 title="Interface IOutgoingFileTransfer" class="title">Interface IOutgoingFileTransfer</h1>
	</div>
	<div class="contentContainer">
	<section class="description">
	<dl>
	<dt>All Superinterfaces:</dt>
	<dd><code>org.eclipse.core.runtime.IAdaptable</code>, <code><a href="IFileTransfer.html" title="interface in org.eclipse.ecf.filetransfer">IFileTransfer</a></code>, <code><a href="../core/identity/IIdentifiable.html" title="interface in org.eclipse.ecf.core.identity">IIdentifiable</a></code></dd>
	</dl>
	<dl>
	<dt>All Known Implementing Classes:</dt>
	<dd><code><a href="../provider/filetransfer/outgoing/AbstractOutgoingFileTransfer.html" title="class in org.eclipse.ecf.provider.filetransfer.outgoing">AbstractOutgoingFileTransfer</a></code>, <code><a href="../provider/filetransfer/outgoing/AbstractUrlConnectionOutgoingFileTransfer.html" title="class in org.eclipse.ecf.provider.filetransfer.outgoing">AbstractUrlConnectionOutgoingFileTransfer</a></code>, <code><a href="../provider/filetransfer/outgoing/LocalFileOutgoingFileTransfer.html" title="class in org.eclipse.ecf.provider.filetransfer.outgoing">LocalFileOutgoingFileTransfer</a></code></dd>
	</dl>
	<hr>
	<pre>public interface <span class="typeNameLabel">IOutgoingFileTransfer</span>
	extends <a href="IFileTransfer.html" title="interface in org.eclipse.ecf.filetransfer">IFileTransfer</a></pre>
	<div class="block">Outgoing file transfer.</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>long</code></td>
	<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getBytesSent()">getBytesSent</a></span>()</code></th>
	<td class="colLast">
	<div class="block">Get the number of bytes sent for this outgoing file transfer.</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>
	<div class="inheritedList">
	<h3>Methods inherited from interface org.eclipse.ecf.filetransfer.<a href="IFileTransfer.html" title="interface in org.eclipse.ecf.filetransfer">IFileTransfer</a></h3>
	<a id="methods.inherited.from.class.org.eclipse.ecf.filetransfer.IFileTransfer">
	<!-- -->
	</a><code><a href="IFileTransfer.html#cancel()">cancel</a>, <a href="IFileTransfer.html#getException()">getException</a>, <a href="IFileTransfer.html#getFileLength()">getFileLength</a>, <a href="IFileTransfer.html#getPercentComplete()">getPercentComplete</a>, <a href="IFileTransfer.html#isDone()">isDone</a></code></div>
	<div class="inheritedList">
	<h3>Methods inherited from interface org.eclipse.ecf.core.identity.<a href="../core/identity/IIdentifiable.html" title="interface in org.eclipse.ecf.core.identity">IIdentifiable</a></h3>
	<a id="methods.inherited.from.class.org.eclipse.ecf.core.identity.IIdentifiable">
	<!-- -->
	</a><code><a href="../core/identity/IIdentifiable.html#getID()">getID</a></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="getBytesSent()">getBytesSent</a></h3>
	<div class="memberSignature"><span class="returnType">long</span> <span class="memberName">getBytesSent</span>()</div>
	<div class="block">Get the number of bytes sent for this outgoing file transfer. Returns 0
	if transfer has not be started, and -1 if underlying provider does not
	support reporting number of bytes sent during transfer.</div>
	<dl>
	<dt><span class="returnLabel">Returns:</span></dt>
	<dd>number of bytes sent. Returns 0 if the outgoing file transfer has
	not been started, and -1 if provider does not support reporting
	of number of bytes received during transfer</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/IOutgoingFileTransfer.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>