com.serialpundit.serial.ftp.SerialComFTPCMDAbort 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;

/** 
 * Acts as a messenger between application and serialpundit to specify 
 * whether sending/receiving file should continue or be aborted.
 * 
 * @author Rishi Gupta
 */
public final class SerialComFTPCMDAbort {

    private volatile boolean abortTransferNow;

    /**
     * Allocates a new SerialComFTPCMDAbort object with initial state as continue to 
     * transfer.
     */
    public SerialComFTPCMDAbort() {
        abortTransferNow = false; // initial state.
    }

    /** 
     * Instructs this library to stop sending file if called by file sender,
     *  or to stop receiving file if called by file receiver using Xmodem or 
     *  its variant protocols.
     */
    public void abortTransfer() {
        abortTransferNow = true;
    }

    /** 
     * Checks whether file transfer or reception should be aborted or not.
     * 
     * @return true if it should be aborted otherwise false if file transfer 
     *         should continue.
     */
    public boolean isTransferToBeAborted() {
        return abortTransferNow;
    }
}