com.serialpundit.serial.ftp

Interface ISerialComYmodemProgress

All Superinterfaces:

ISerialComFTPProgress

public interface ISerialComYmodemProgress
extends ISerialComFTPProgress

The interface ISerialComYmodemProgress should be implemented by class who wish to know how many blocks have been sent or received using Ymodem protocol.

The graphical user interface applications may want to show progress for example using a progress bar to inform user about how much data have been sent to receiver end. Such applications can use this interface for this purpose.

Author:

Rishi Gupta

Method Summary

Methods

Modifier and Type	Method and Description
void	onYmodemReceiveProgressUpdate(String fileName, long numBlock, int percentOfBlocksReceived) The class implementing this interface is expected to override onYmodemReceiveProgressUpdate() method.
void	onYmodemSentProgressUpdate(String fileName, long numBlock, int percentOfBlocksSent) The class implementing this interface is expected to override onYmodemSentProgressUpdate() method.

Method Detail

onYmodemSentProgressUpdate

void onYmodemSentProgressUpdate(String fileName,
                              long numBlock,
                              int percentOfBlocksSent)

The class implementing this interface is expected to override onYmodemSentProgressUpdate() method. This method gets called whenever a block is sent using Ymodem protocol.

This method should return as early as possible. Application might schedule GUI update for future.

Parameters:

fileName - name of file that is currently getting sent.

numBlock - number of the block sent by this application till the time this method is called. It includes both newly sent and re-sent blocks i.e. it represent total number of blocks sent from sender to receiver.

percentOfBlocksSent - update in terms of percentage.

onYmodemReceiveProgressUpdate

void onYmodemReceiveProgressUpdate(String fileName,
                                 long numBlock,
                                 int percentOfBlocksReceived)

The class implementing this interface is expected to override onYmodemReceiveProgressUpdate() method. This method gets called whenever a block is sent using Ymodem protocol.

This method should return as early as possible. Application might schedule GUI update for future.

Parameters:

fileName - name of file currently being received from sender.

numBlock - number of the block received by this application till the time this method is called. It includes both new blocks and resent blocks i.e. it represent total number of blocks received from file sender.

percentOfBlocksReceived - update in terms of percentage.