/usr/share/doc/libjets3t-java/api/org/jets3t/service/multi/ThreadWatcher.html is in libjets3t-java-doc 0.8.1+dfsg-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc (build 1.6.0_18) on Sat Apr 16 04:24:16 UTC 2011 -->
<TITLE>
ThreadWatcher
</TITLE>
<META NAME="date" CONTENT="2011-04-16">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="ThreadWatcher";
}
}
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>
</HEAD>
<BODY BGCOLOR="white" onload="windowTitle();">
<HR>
<!-- ========= START OF TOP NAVBAR ======= -->
<A NAME="navbar_top"><!-- --></A>
<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../org/jets3t/service/multi/ThreadedStorageService.html" title="class in org.jets3t.service.multi"><B>PREV CLASS</B></A>
NEXT CLASS</FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../index.html?org/jets3t/service/multi/ThreadWatcher.html" target="_top"><B>FRAMES</B></A>
<A HREF="ThreadWatcher.html" target="_top"><B>NO FRAMES</B></A>
<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>
<!-- ========= END OF TOP NAVBAR ========= -->
<HR>
<!-- ======== START OF CLASS DATA ======== -->
<H2>
<FONT SIZE="-1">
org.jets3t.service.multi</FONT>
<BR>
Class ThreadWatcher</H2>
<PRE>
<A HREF="/usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</A>
<IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>org.jets3t.service.multi.ThreadWatcher</B>
</PRE>
<DL>
<DT><B>Direct Known Subclasses:</B> <DD><A HREF="../../../../org/jets3t/service/multithread/ThreadWatcher.html" title="class in org.jets3t.service.multithread">ThreadWatcher</A></DD>
</DL>
<HR>
<DL>
<DT><PRE>public class <B>ThreadWatcher</B><DT>extends <A HREF="/usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></DL>
</PRE>
<P>
A thread watcher is associated with a multi-threaded operation and contains information about
the progress of the operation.
<p>
As a minimum, this object will contain a count of the total number of threads involved in the operation
(via <A HREF="../../../../org/jets3t/service/multi/ThreadWatcher.html#getThreadCount()"><CODE>getThreadCount()</CODE></A>) and the count of threads that have already finished
(via <A HREF="../../../../org/jets3t/service/multi/ThreadWatcher.html#getCompletedThreads()"><CODE>getCompletedThreads()</CODE></A>).
<p>
For operations involving data transfer, such as uploads or downloads, this object may
also include a count of the total bytes being transferred (via <A HREF="../../../../org/jets3t/service/multi/ThreadWatcher.html#getBytesTotal()"><CODE>getBytesTotal()</CODE></A>) and a count
of how many bytes have already been transferred (via <A HREF="../../../../org/jets3t/service/multi/ThreadWatcher.html#getBytesTransferred()"><CODE>getBytesTransferred()</CODE></A>). The
availability of this information is indicated by the result of <A HREF="../../../../org/jets3t/service/multi/ThreadWatcher.html#isBytesTransferredInfoAvailable()"><CODE>isBytesTransferredInfoAvailable()</CODE></A>.
<p>
Further data tranfer information may be also available, such as the current transfer rate (via
<A HREF="../../../../org/jets3t/service/multi/ThreadWatcher.html#getBytesPerSecond()"><CODE>getBytesPerSecond()</CODE></A>) and an estimate of the time remaining until the transfer is
completed (via <A HREF="../../../../org/jets3t/service/multi/ThreadWatcher.html#getTimeRemaining()"><CODE>getTimeRemaining()</CODE></A>). The availability of this information is indicated
by the result of <A HREF="../../../../org/jets3t/service/multi/ThreadWatcher.html#isTimeRemainingAvailable()"><CODE>isTimeRemainingAvailable()</CODE></A>.
<p>
It is possible to cancel some operations. If an operation may be cancelled, this object will
include a <A HREF="../../../../org/jets3t/service/multi/CancelEventTrigger.html" title="interface in org.jets3t.service.multi"><CODE>CancelEventTrigger</CODE></A> (available from <A HREF="../../../../org/jets3t/service/multi/ThreadWatcher.html#getCancelEventListener()"><CODE>getCancelEventListener()</CODE></A>) which can
be used to trigger a cancellation. Whether the operation can be cancelled is indicated by
<A HREF="../../../../org/jets3t/service/multi/ThreadWatcher.html#isCancelTaskSupported()"><CODE>isCancelTaskSupported()</CODE></A>.
<P>
<P>
<DL>
<DT><B>Author:</B></DT>
<DD>James Murty</DD>
</DL>
<HR>
<P>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<A NAME="constructor_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Constructor Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><B><A HREF="../../../../org/jets3t/service/multi/ThreadWatcher.html#ThreadWatcher(org.jets3t.service.io.BytesProgressWatcher[])">ThreadWatcher</A></B>(<A HREF="../../../../org/jets3t/service/io/BytesProgressWatcher.html" title="class in org.jets3t.service.io">BytesProgressWatcher</A>[] progressWatchers)</CODE>
<BR>
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><B><A HREF="../../../../org/jets3t/service/multi/ThreadWatcher.html#ThreadWatcher(long)">ThreadWatcher</A></B>(long threadCount)</CODE>
<BR>
</TD>
</TR>
</TABLE>
<!-- ========== METHOD SUMMARY =========== -->
<A NAME="method_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Method Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/jets3t/service/multi/ThreadWatcher.html#cancelTask()">cancelTask</A></B>()</CODE>
<BR>
Convenience method to trigger an event cancellation via <A HREF="../../../../org/jets3t/service/multi/CancelEventTrigger.html#cancelTask(java.lang.Object)"><CODE>CancelEventTrigger.cancelTask(java.lang.Object)</CODE></A>
if this thread watcher is associated with an operation that can be cancelled.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> long</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/jets3t/service/multi/ThreadWatcher.html#getBytesPerSecond()">getBytesPerSecond</A></B>()</CODE>
<BR>
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> long</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/jets3t/service/multi/ThreadWatcher.html#getBytesTotal()">getBytesTotal</A></B>()</CODE>
<BR>
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> long</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/jets3t/service/multi/ThreadWatcher.html#getBytesTransferred()">getBytesTransferred</A></B>()</CODE>
<BR>
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../../org/jets3t/service/multi/CancelEventTrigger.html" title="interface in org.jets3t.service.multi">CancelEventTrigger</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/jets3t/service/multi/ThreadWatcher.html#getCancelEventListener()">getCancelEventListener</A></B>()</CODE>
<BR>
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> long</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/jets3t/service/multi/ThreadWatcher.html#getCompletedThreads()">getCompletedThreads</A></B>()</CODE>
<BR>
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> long</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/jets3t/service/multi/ThreadWatcher.html#getThreadCount()">getThreadCount</A></B>()</CODE>
<BR>
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> long</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/jets3t/service/multi/ThreadWatcher.html#getTimeRemaining()">getTimeRemaining</A></B>()</CODE>
<BR>
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/jets3t/service/multi/ThreadWatcher.html#isBytesTransferredInfoAvailable()">isBytesTransferredInfoAvailable</A></B>()</CODE>
<BR>
If this method returns true, the methods <A HREF="../../../../org/jets3t/service/multi/ThreadWatcher.html#getBytesTotal()"><CODE>getBytesTotal()</CODE></A> and <A HREF="../../../../org/jets3t/service/multi/ThreadWatcher.html#getBytesTransferred()"><CODE>getBytesTransferred()</CODE></A>
will contain information about the amount of data being transferred by the watched threads.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/jets3t/service/multi/ThreadWatcher.html#isCancelTaskSupported()">isCancelTaskSupported</A></B>()</CODE>
<BR>
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/jets3t/service/multi/ThreadWatcher.html#isTimeRemainingAvailable()">isTimeRemainingAvailable</A></B>()</CODE>
<BR>
If this method returns true, the method <A HREF="../../../../org/jets3t/service/multi/ThreadWatcher.html#getTimeRemaining()"><CODE>getTimeRemaining()</CODE></A> will contain
an estimate of the completion time for the data transfer.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/jets3t/service/multi/ThreadWatcher.html#updateThreadsCompletedCount(long)">updateThreadsCompletedCount</A></B>(long completedThreads)</CODE>
<BR>
Sets information about the number of threads completed and the total number of threads.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/jets3t/service/multi/ThreadWatcher.html#updateThreadsCompletedCount(long, org.jets3t.service.multi.CancelEventTrigger)">updateThreadsCompletedCount</A></B>(long completedThreads,
<A HREF="../../../../org/jets3t/service/multi/CancelEventTrigger.html" title="interface in org.jets3t.service.multi">CancelEventTrigger</A> cancelEventListener)</CODE>
<BR>
Sets information about the number of threads completed and the total number of threads,
as well as setting the cancellation listener that will be notified if the event is cancelled.</TD>
</TR>
</TABLE>
<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Methods inherited from class java.lang.<A HREF="/usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="/usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</A>, <A HREF="/usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</A>, <A HREF="/usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</A>, <A HREF="/usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</A>, <A HREF="/usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</A>, <A HREF="/usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</A>, <A HREF="/usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</A>, <A HREF="/usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</A>, <A HREF="/usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</A></CODE></TD>
</TR>
</TABLE>
<P>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<A NAME="constructor_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Constructor Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="ThreadWatcher(org.jets3t.service.io.BytesProgressWatcher[])"><!-- --></A><H3>
ThreadWatcher</H3>
<PRE>
public <B>ThreadWatcher</B>(<A HREF="../../../../org/jets3t/service/io/BytesProgressWatcher.html" title="class in org.jets3t.service.io">BytesProgressWatcher</A>[] progressWatchers)</PRE>
<DL>
</DL>
<HR>
<A NAME="ThreadWatcher(long)"><!-- --></A><H3>
ThreadWatcher</H3>
<PRE>
public <B>ThreadWatcher</B>(long threadCount)</PRE>
<DL>
</DL>
<!-- ============ METHOD DETAIL ========== -->
<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Method Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="updateThreadsCompletedCount(long)"><!-- --></A><H3>
updateThreadsCompletedCount</H3>
<PRE>
public void <B>updateThreadsCompletedCount</B>(long completedThreads)</PRE>
<DL>
<DD>Sets information about the number of threads completed and the total number of threads.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>completedThreads</CODE> - the number of threads that have completed.</DL>
</DD>
</DL>
<HR>
<A NAME="updateThreadsCompletedCount(long, org.jets3t.service.multi.CancelEventTrigger)"><!-- --></A><H3>
updateThreadsCompletedCount</H3>
<PRE>
public void <B>updateThreadsCompletedCount</B>(long completedThreads,
<A HREF="../../../../org/jets3t/service/multi/CancelEventTrigger.html" title="interface in org.jets3t.service.multi">CancelEventTrigger</A> cancelEventListener)</PRE>
<DL>
<DD>Sets information about the number of threads completed and the total number of threads,
as well as setting the cancellation listener that will be notified if the event is cancelled.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>completedThreads</CODE> - the number of threads that have completed.<DD><CODE>cancelEventListener</CODE> - the listener to notify of cancellation events.</DL>
</DD>
</DL>
<HR>
<A NAME="getCompletedThreads()"><!-- --></A><H3>
getCompletedThreads</H3>
<PRE>
public long <B>getCompletedThreads</B>()</PRE>
<DL>
<DD><DL>
<DT><B>Returns:</B><DD>the number of threads that have completed.</DL>
</DD>
</DL>
<HR>
<A NAME="getThreadCount()"><!-- --></A><H3>
getThreadCount</H3>
<PRE>
public long <B>getThreadCount</B>()</PRE>
<DL>
<DD><DL>
<DT><B>Returns:</B><DD>the total number of threads involved in an operation.</DL>
</DD>
</DL>
<HR>
<A NAME="isBytesTransferredInfoAvailable()"><!-- --></A><H3>
isBytesTransferredInfoAvailable</H3>
<PRE>
public boolean <B>isBytesTransferredInfoAvailable</B>()</PRE>
<DL>
<DD>If this method returns true, the methods <A HREF="../../../../org/jets3t/service/multi/ThreadWatcher.html#getBytesTotal()"><CODE>getBytesTotal()</CODE></A> and <A HREF="../../../../org/jets3t/service/multi/ThreadWatcher.html#getBytesTransferred()"><CODE>getBytesTransferred()</CODE></A>
will contain information about the amount of data being transferred by the watched threads.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>true if this watcher contains information about the bytes transferred by
the threads it is watching.</DL>
</DD>
</DL>
<HR>
<A NAME="getBytesTotal()"><!-- --></A><H3>
getBytesTotal</H3>
<PRE>
public long <B>getBytesTotal</B>()
throws <A HREF="/usr/share/doc/default-jdk-doc/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang">IllegalStateException</A></PRE>
<DL>
<DD><DL>
<DT><B>Returns:</B><DD>the expected total of bytes that will be transferred by the watched threads.
<DT><B>Throws:</B>
<DD><CODE><A HREF="/usr/share/doc/default-jdk-doc/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang">IllegalStateException</A></CODE> - if the bytes transferred information is not available - check this availability
with the <A HREF="../../../../org/jets3t/service/multi/ThreadWatcher.html#isBytesTransferredInfoAvailable()"><CODE>isBytesTransferredInfoAvailable()</CODE></A> method.</DL>
</DD>
</DL>
<HR>
<A NAME="getBytesTransferred()"><!-- --></A><H3>
getBytesTransferred</H3>
<PRE>
public long <B>getBytesTransferred</B>()</PRE>
<DL>
<DD><DL>
<DT><B>Returns:</B><DD>the count of bytes that have been transferred by the watched threads.
<DT><B>Throws:</B>
<DD><CODE><A HREF="/usr/share/doc/default-jdk-doc/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang">IllegalStateException</A></CODE> - if the bytes transferred information is not available - check this availability
with the <A HREF="../../../../org/jets3t/service/multi/ThreadWatcher.html#isBytesTransferredInfoAvailable()"><CODE>isBytesTransferredInfoAvailable()</CODE></A> method.</DL>
</DD>
</DL>
<HR>
<A NAME="getBytesPerSecond()"><!-- --></A><H3>
getBytesPerSecond</H3>
<PRE>
public long <B>getBytesPerSecond</B>()</PRE>
<DL>
<DD><DL>
<DT><B>Returns:</B><DD>an estimate of the recent rate of bytes/second transfer speed.</DL>
</DD>
</DL>
<HR>
<A NAME="isTimeRemainingAvailable()"><!-- --></A><H3>
isTimeRemainingAvailable</H3>
<PRE>
public boolean <B>isTimeRemainingAvailable</B>()</PRE>
<DL>
<DD>If this method returns true, the method <A HREF="../../../../org/jets3t/service/multi/ThreadWatcher.html#getTimeRemaining()"><CODE>getTimeRemaining()</CODE></A> will contain
an estimate of the completion time for the data transfer.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>true if this watcher contains an estimate of the completion time for the data transfer.</DL>
</DD>
</DL>
<HR>
<A NAME="getTimeRemaining()"><!-- --></A><H3>
getTimeRemaining</H3>
<PRE>
public long <B>getTimeRemaining</B>()</PRE>
<DL>
<DD><DL>
<DT><B>Returns:</B><DD>an estimate of the how many <b>seconds</b> until the data transfer completes, based on the
overall byte rate of the transmission.
<DT><B>Throws:</B>
<DD><CODE><A HREF="/usr/share/doc/default-jdk-doc/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang">IllegalStateException</A></CODE> - if the time remaining estimave is not available - check this availability
with the <A HREF="../../../../org/jets3t/service/multi/ThreadWatcher.html#isTimeRemainingAvailable()"><CODE>isTimeRemainingAvailable()</CODE></A> method.</DL>
</DD>
</DL>
<HR>
<A NAME="isCancelTaskSupported()"><!-- --></A><H3>
isCancelTaskSupported</H3>
<PRE>
public boolean <B>isCancelTaskSupported</B>()</PRE>
<DL>
<DD><DL>
<DT><B>Returns:</B><DD>true if the operation this object is associated with can be cancelled, and a
<A HREF="../../../../org/jets3t/service/multi/CancelEventTrigger.html" title="interface in org.jets3t.service.multi"><CODE>CancelEventTrigger</CODE></A> is available.</DL>
</DD>
</DL>
<HR>
<A NAME="cancelTask()"><!-- --></A><H3>
cancelTask</H3>
<PRE>
public void <B>cancelTask</B>()</PRE>
<DL>
<DD>Convenience method to trigger an event cancellation via <A HREF="../../../../org/jets3t/service/multi/CancelEventTrigger.html#cancelTask(java.lang.Object)"><CODE>CancelEventTrigger.cancelTask(java.lang.Object)</CODE></A>
if this thread watcher is associated with an operation that can be cancelled.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="getCancelEventListener()"><!-- --></A><H3>
getCancelEventListener</H3>
<PRE>
public <A HREF="../../../../org/jets3t/service/multi/CancelEventTrigger.html" title="interface in org.jets3t.service.multi">CancelEventTrigger</A> <B>getCancelEventListener</B>()</PRE>
<DL>
<DD><DL>
<DT><B>Returns:</B><DD>the cancel event trigger associated with an operation, if any.</DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../org/jets3t/service/multi/ThreadedStorageService.html" title="class in org.jets3t.service.multi"><B>PREV CLASS</B></A>
NEXT CLASS</FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../index.html?org/jets3t/service/multi/ThreadWatcher.html" target="_top"><B>FRAMES</B></A>
<A HREF="ThreadWatcher.html" target="_top"><B>NO FRAMES</B></A>
<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
</BODY>
</HTML>
|