com.atakmap.comms.missionpackage

Interface MPReceiveInitiator

All Known Implementing Classes:

MissionPackageReceiver

public interface MPReceiveInitiator

Method Summary

Modifier and Type	Method and Description
MPReceiver	initiateReceive(java.lang.String fileName, java.lang.String transferName, java.lang.String sha256hash, long expectedByteLen, java.lang.String senderCallsign) A new MP download request was received with the given details; the ReceiveInitiator should set set the system up to receive the MP and return an MPReceiver that will handle the download.

Method Detail

initiateReceive

MPReceiver initiateReceive(java.lang.String fileName,
                           java.lang.String transferName,
                           java.lang.String sha256hash,
                           long expectedByteLen,
                           java.lang.String senderCallsign)
                    throws java.io.IOException

A new MP download request was received with the given details; the ReceiveInitiator should set set the system up to receive the MP and return an MPReceiver that will handle the download. Return null if file already exists locally and system does not want to receive again. Throwing IOException will result in the transfer aborting. Both of these results in a nack being sent to the sender.

Parameters:

fileName - remote sender's preferred name for the file

transferName - remote sender's logical name for the transfer

sha256hash - sha256 hash of the file, as reported by the sender

expectedByteLen - length of file, as reported by sender. 0 if not given by sender.

senderCallsign - callsign of the sending device

Returns:

MPReceiver instance that will handle the file receive, or null to indicate that this system already has the file and does not want to receive again.

Throws:

java.io.IOException - if any error is encountered