com.embeddedunveiled.serial.ftp.ISerialComYmodemProgress Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of scm Show documentation
serial communication in java
The newest version!
/*
 * Author : Rishi Gupta
 * 
 * This file is part of 'serial communication manager' library.
 * Copyright (C) <2014-2016>  
 *
 * This 'serial communication manager' is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as published by the Free Software 
 * Foundation, either version 3 of the License, or (at your option) any later version.
 *
 * The 'serial communication manager' 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.  See the GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with 'serial communication manager'.  If not, see .
 */

package com.embeddedunveiled.serial.ftp;

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

    /**
     * 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.
     * 
     * @param fileName name of file that is currently getting sent.
     * @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 onYmodemSentProgressUpdate(String fileName, long numBlock, int percentOfBlocksSent);

    /**
     * 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.
     * 
     * @param fileName name of file currently being received from sender.
     * @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.
     * @param percentOfBlocksReceived update in terms of percentage.
     */
    public abstract void onYmodemReceiveProgressUpdate(String fileName, long numBlock, int percentOfBlocksReceived);
}