com.embeddedunveiled.serial

Class SerialComXModem

java.lang.Object

com.embeddedunveiled.serial.SerialComXModem

public final class SerialComXModem
extends Object

Implements state machine for XMODEM-128 file transfer protocol in Java.

Author:

Rishi Gupta

Constructor Summary

Constructors

Constructor and Description
SerialComXModem(SerialComManager scm, long handle, File fileToProcess, boolean textMode, ISerialComXmodemProgress progressListener, SerialComXModemAbort transferState, int osType) Allocates a new SerialComXModem object with given details and associate it with the given instance of SerialComManager class.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	receiveFileX() Represents actions to execute in state machine to implement xmodem protocol for receiving files.
boolean	sendFileX() Represents actions to execute in state machine to implement xmodem protocol for sending files.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SerialComXModem

public SerialComXModem(SerialComManager scm,
               long handle,
               File fileToProcess,
               boolean textMode,
               ISerialComXmodemProgress progressListener,
               SerialComXModemAbort transferState,
               int osType)

Allocates a new SerialComXModem object with given details and associate it with the given instance of SerialComManager class.

Parameters:

scm - SerialComManager instance associated with this handle.

handle - of the port on which file is to be communicated.

fileToProcess - File instance representing file to be communicated.

textMode - if true file will be sent as text file (ASCII mode), if false file will be sent as binary file.

progressListener - object of class which implements ISerialComXmodemProgress interface and is interested in knowing how many blocks have been sent/received till now.

transferState - if application wish to abort sending/receiving file at instant of time due to any reason, it can call abortTransfer method on this object. It can be null of application does not wish to abort sending/receiving file explicitly.

osType - operating system on which this application is running.

Method Detail

sendFileX

public boolean sendFileX()
                  throws SecurityException,
                         IOException,
                         SerialComException

Represents actions to execute in state machine to implement xmodem protocol for sending files.

Returns:

true on success, false if application instructed to abort.

Throws:

SecurityException - if unable to read from file to be sent.

IOException - if any I/O error occurs.

SerialComException - if any I/0 error on serial port communication occurs.

receiveFileX

public boolean receiveFileX()
                     throws IOException,
                            SerialComException

Represents actions to execute in state machine to implement xmodem protocol for receiving files.

Returns:

true on success, false if application instructed to abort.

Throws:

IOException - if any I/O error occurs.

SerialComException - if any I/0 error on serial port communication occurs.