net.digger.protocol.xymodem

Class XYModem

java.lang.Object

net.digger.protocol.xymodem.XYModem

public class XYModem
extends Object

Implementation of client side of XModem and YModem protocols, for downloading files.

Supports XModem-Checksum, XModem-CRC, XModem-1k, YModem-Batch, YModem-G.
Implements just enough of ZModem to support AutoDownload, relying on automatic sender fallback to X/YModem, if available.

Based on X/YMODEM Protocol Reference, June 18 1988:
http://pauillac.inria.fr/~doligez/zmodem/ymodem.txt
ZModem AutoDownload support from
The ZMODEM Inter Application File Transfer Protocol, Oct-14-88
http://gallium.inria.fr/~doligez/zmodem/zmodem.txt
with values defined from
http://read.pudn.com/downloads/sourcecode/comm/984/ZMODEM.H__.htm

Author:

walton

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	XYModem.OverrunOption Behavior options for data received past the end of a downloaded file, when file length is provided by sender in YModem protocol.

Constructor Summary

Constructors

Constructor and Description
XYModem(IOHandler ioHandler) Create new instance of XYModem.

Method Summary

Modifier and Type	Method and Description
boolean	autoDownloadDetect(char ch) Examines sequence of characters for the ZModem ZRQINIT frame requesting start of download, and indicates whether it is seen.
void	download() Begin download of file(s).
static String	formatBPS(long bytes, Duration elapsed) Format the given number of bytes per second in friendly Bps, KBps, MBps, GBps, TBps format.
static String	formatBytes(long bytes) Format the given number of bytes in friendly B, KB, MB, GB, TB format.
static String	formatElapsedTime(Duration elapsed) Return the given duration in the format HH:MM:SS.
void	setOverrunOption(XYModem.OverrunOption option)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

XYModem

public XYModem(IOHandler ioHandler)

Create new instance of XYModem.

Parameters:

ioHandler - IOHandler instance to use.

Method Detail

setOverrunOption

public void setOverrunOption(XYModem.OverrunOption option)

autoDownloadDetect

public boolean autoDownloadDetect(char ch)

Examines sequence of characters for the ZModem ZRQINIT frame requesting start of download, and indicates whether it is seen.

Parameters:

ch - Next character in the sequence.

Returns:

True if ZRQINIT has been received, false otherwise.

download

public void download()

Begin download of file(s). Returns when download is complete, or has been cancelled.

formatElapsedTime

public static String formatElapsedTime(Duration elapsed)

Return the given duration in the format HH:MM:SS.

Parameters:

elapsed - Duration to format.

Returns:

Formatted string.

formatBPS

public static String formatBPS(long bytes,
                               Duration elapsed)

Format the given number of bytes per second in friendly Bps, KBps, MBps, GBps, TBps format.

Parameters:

bytes - Number of bytes.

elapsed - Number of seconds elapsed.

Returns:

Formatted string of bps.

formatBytes

public static String formatBytes(long bytes)

Format the given number of bytes in friendly B, KB, MB, GB, TB format.

Parameters:

bytes - Number of bytes to format.

Returns:

Formatted string.