com.serialpundit.serial.ftp.ISerialComXmodemProgress Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of sp-tty Show documentation
Serial port APIs of SerialPundit
The newest version!
/*
 * This file is part of SerialPundit.
 * 
 * Copyright (C) 2014-2016, Rishi Gupta. All rights reserved.
 *
 * The SerialPundit is DUAL LICENSED. It is made available under the terms of the GNU Affero 
 * General Public License (AGPL) v3.0 for non-commercial use and under the terms of a commercial 
 * license for commercial use of this software. 
 * 
 * The SerialPundit is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; 
 * without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 */

package com.serialpundit.serial.ftp;

import com.serialpundit.serial.internal.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
 */
public interface ISerialComXmodemProgress extends ISerialComFTPProgress {

    /**
     * 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.
     * 
     * @param 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.
     * @param percentOfBlocksSent update in terms of percentage.
     */
    public abstract void onXmodemSentProgressUpdate(long numBlock, int percentOfBlocksSent);

    /**
     * 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.
     * 
     * @param 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.
     */
    public abstract void onXmodemReceiveProgressUpdate(long numBlock);
}