com.serialpundit.serial.ftp

Interface ISerialComXmodemProgress

All Superinterfaces:

ISerialComFTPProgress

public interface ISerialComXmodemProgress
extends ISerialComFTPProgress

The interface ISerialComXmodemProgress should be implemented by class who wish to know how many blocks have been sent or received using Xmodem 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	onXmodemReceiveProgressUpdate(long numBlock) The class implementing this interface is expected to override onXmodemReceiveProgressUpdate() method.
void	onXmodemSentProgressUpdate(long numBlock, int percentOfBlocksSent) The class implementing this interface is expected to override onXmodemSentProgressUpdate() method.

Method Detail

onXmodemSentProgressUpdate

void onXmodemSentProgressUpdate(long numBlock,
                              int percentOfBlocksSent)

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

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

Parameters:

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.

onXmodemReceiveProgressUpdate

void onXmodemReceiveProgressUpdate(long numBlock)

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

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

Parameters:

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.