com.atakmap.comms.missionpackage

Interface MPReceiver

public interface MPReceiver

Method Summary

Modifier and Type	Method and Description
void	attemptFailed(java.lang.String reason, int attemptNum, int maxAttempts) Called by the transfer engine to indicate a download attempt failed.
java.io.File	getDestinationFile() Returns a valid, writable file to where the MP being received should be written.
void	receiveComplete(boolean success, java.lang.String failReason, int attempt) Called by the transfer engine to indicate a download is finished and no additional attempts will be made; this is called for successful and unsuccessful completions, indicating no additional attempts will be made! For failed transfers, failReason may give more info as to why, but generally speaking the per-attempt error detail from attemptFailed() will be more informative.
void	receiveProgress(long bytesTransferred, long totalBytesExpected, int attemptNum, int maxAttempts) Called by the transfer engine to indicate progress on receiving the MP.

Method Detail

getDestinationFile

java.io.File getDestinationFile()
                         throws java.io.IOException

Returns a valid, writable file to where the MP being received should be written. This must return the same value for every call made against a a particular MPReceiver instance. The File will be overwritten if it exists. Throwing an IOException from this causes the transfer to be aborted; no progress callbacks will be made, nor will receiveComplete() be called.

Returns:

File to write the received MP out to

Throws:

java.io.IOException - if an error occurs

receiveProgress

void receiveProgress(long bytesTransferred,
                     long totalBytesExpected,
                     int attemptNum,
                     int maxAttempts)

Called by the transfer engine to indicate progress on receiving the MP.

Parameters:

bytesTransferred - total number of bytes transferred in this download attempt

totalBytesExpected - total number of bytes expected in the transfer; 0 if unknown

attemptNum - attempt number this progress is for (starting from 1)

maxAttempts - total number of attempts that may be made (constant for any given transfer)

attemptFailed

void attemptFailed(java.lang.String reason,
                   int attemptNum,
                   int maxAttempts)

Called by the transfer engine to indicate a download attempt failed.

Parameters:

reason - a description of why the transfer failed, if known, or null

attemptNum - attempt number that failed (starting from 1)

maxAttempts - total number of attempts that will be made (constant for any given transfer)

receiveComplete

void receiveComplete(boolean success,
                     java.lang.String failReason,
                     int attempt)

Called by the transfer engine to indicate a download is finished and no additional attempts will be made; this is called for successful and unsuccessful completions, indicating no additional attempts will be made! For failed transfers, failReason may give more info as to why, but generally speaking the per-attempt error detail from attemptFailed() will be more informative.

Parameters:

success - true if the transfer was successful, false if failed

failReason - reason why the download failed, if known, else null

attempt - the attempt the download completed on