net.digger.protocol.xymodem

Interface IOHandler

public interface IOHandler

Interface for handling various events during a download.

Author:

walton

Method Summary

Modifier and Type	Method and Description
void	log(String message) Called during download with logging messages.
void	progress(long bytes, long total) Called during download with progress data.
Byte	read(int msTimeout) Called during download to read the next input byte.
void	received(Download download) Called at end of successful download with details of downloaded file.
void	write(char ch) Called during download to send a byte to the sender.

Method Detail

read

Byte read(int msTimeout)
   throws UserCancelException

Called during download to read the next input byte.

Blocks until the next byte is available. If timeout is reached, return null. If user cancels the download while blocked, throw DownloadCancelException.

Parameters:

msTimeout - Milliseconds to wait before timing out.

Returns:

Next data byte, or null if timed out.

Throws:

UserCancelException - If user cancelled the download.

write

void write(char ch)

Called during download to send a byte to the sender.

Parameters:

ch - Byte to transmit.

log

void log(String message)

Called during download with logging messages.

Parameters:

message - Message to log.

progress

void progress(long bytes,
              long total)

Called during download with progress data.

Parameters:

bytes - Number of bytes downloaded so far.

total - Total size of file being downloaded (0 if unknown).

received

void received(Download download)

Called at end of successful download with details of downloaded file.

Parameters:

download - Download object with details of downloaded file, including a reference to it.