Module org.yamcs.core

Package org.yamcs.cfdp

Class OngoingCfdpTransfer

java.lang.Object

org.yamcs.cfdp.OngoingCfdpTransfer

All Implemented Interfaces:

CfdpFileTransfer, FileTransfer

Direct Known Subclasses:

CfdpIncomingTransfer, CfdpOutgoingTransfer

public abstract class OngoingCfdpTransfer
extends Object
implements CfdpFileTransfer

Nested Class Summary

Nested classes/interfaces inherited from interface org.yamcs.cfdp.CfdpFileTransfer

CfdpFileTransfer.PredefinedTransferTypes

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	acknowledged
protected final CfdpTransactionId	cfdpTransactionId
protected final long	creationTime
protected final EventProducer	eventProducer
protected final ScheduledThreadPoolExecutor	executor
protected ScheduledFuture<?>	inactivityFuture
protected final Log	log
protected final long	startTime
protected org.yamcs.protobuf.TransferState	state
protected String	transferType
protected final long	wallclockStartTime

Constructor Summary

Constructors

Constructor	Description
OngoingCfdpTransfer(String yamcsInstance, long id, long creationTime, ScheduledThreadPoolExecutor executor, YConfiguration config, CfdpTransactionId cfdpTransactionId, long destinationId, Stream cfdpOut, EventProducer eventProducer, TransferMonitor monitor, Map<ConditionCode,org.yamcs.cfdp.OngoingCfdpTransfer.FaultHandlingAction> faultHandlerActions)

Method Summary

Modifier and Type	Method	Description
OngoingCfdpTransfer	abandonTransfer(String reason)
protected abstract void	cancel(ConditionCode code)
protected void	cancelInactivityTimer()
boolean	cancellable()
CompletableFuture<OngoingCfdpTransfer>	cancelTransfer()
protected void	changeState(org.yamcs.protobuf.TransferState newState)
protected void	failTransfer(String failureReason)
long	getCreationTime()
long	getDestinationId()	Return the entity id of the Receiver
String	getFailuredReason()
protected org.yamcs.cfdp.OngoingCfdpTransfer.FaultHandlingAction	getFaultHandlingAction(ConditionCode code)
long	getId()
long	getInitiatorEntityId()	Return the entity id of the Sender
long	getStartTime()
CfdpTransactionId	getTransactionId()	Get the CFDP transaction id.
final org.yamcs.protobuf.TransferState	getTransferState()
String	getTransferType()
protected static String	getTransferType(MetadataPacket metadata)	Sets the transfer type fom the metadata packet
final boolean	isOngoing()
boolean	isReliable()
protected abstract void	onInactivityTimerExpiration()
boolean	pausable()
CompletableFuture<OngoingCfdpTransfer>	pauseTransfer()
abstract void	processPacket(CfdpPacket packet)
protected void	pushError(String err)
protected void	rescheduleInactivityTimer()
protected abstract void	resume()
CompletableFuture<OngoingCfdpTransfer>	resumeTransfer()
protected void	sendInfoEvent(String type, String msg)
protected void	sendPacket(CfdpPacket packet)
protected void	sendWarnEvent(String type, String msg)
protected abstract void	suspend()
protected String	toEventMsg(MetadataPacket packet)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.yamcs.cfdp.CfdpFileTransfer

getLocalEntityId, getRemoteEntityId

Methods inherited from interface org.yamcs.filetransfer.FileTransfer

getBucketName, getDirection, getObjectName, getRemotePath, getTotalSize, getTransferredSize

Field Details

cfdpTransactionId

protected final CfdpTransactionId cfdpTransactionId

state

protected org.yamcs.protobuf.TransferState state

executor

protected final ScheduledThreadPoolExecutor executor

eventProducer

protected final EventProducer eventProducer

acknowledged

protected boolean acknowledged

log

protected final Log log

startTime

protected final long startTime

wallclockStartTime

protected final long wallclockStartTime

creationTime

protected final long creationTime

transferType

protected String transferType

inactivityFuture

protected ScheduledFuture<?> inactivityFuture

Constructor Details

OngoingCfdpTransfer

public OngoingCfdpTransfer(String yamcsInstance,
 long id,
 long creationTime,
 ScheduledThreadPoolExecutor executor,
 YConfiguration config,
 CfdpTransactionId cfdpTransactionId,
 long destinationId,
 Stream cfdpOut,
 EventProducer eventProducer,
 TransferMonitor monitor,
 Map<ConditionCode,org.yamcs.cfdp.OngoingCfdpTransfer.FaultHandlingAction> faultHandlerActions)

Method Details

getTransferType

protected static String getTransferType(MetadataPacket metadata)

Sets the transfer type fom the metadata packet

Parameters:

metadata - Metadata packet

processPacket

public abstract void processPacket(CfdpPacket packet)

pushError

protected void pushError(String err)

sendPacket

protected void sendPacket(CfdpPacket packet)

isOngoing

public final boolean isOngoing()

getTransferState

public final org.yamcs.protobuf.TransferState getTransferState()

Specified by:

getTransferState in interface FileTransfer

cancellable

public boolean cancellable()

Specified by:

cancellable in interface FileTransfer

pausable

public boolean pausable()

Specified by:

pausable in interface FileTransfer

onInactivityTimerExpiration

protected abstract void onInactivityTimerExpiration()

cancelInactivityTimer

protected void cancelInactivityTimer()

rescheduleInactivityTimer

protected void rescheduleInactivityTimer()

pauseTransfer

public CompletableFuture<OngoingCfdpTransfer> pauseTransfer()

suspend

protected abstract void suspend()

resumeTransfer

public CompletableFuture<OngoingCfdpTransfer> resumeTransfer()

resume

protected abstract void resume()

cancelTransfer

public CompletableFuture<OngoingCfdpTransfer> cancelTransfer()

cancel

protected abstract void cancel(ConditionCode code)

abandonTransfer

public OngoingCfdpTransfer abandonTransfer(String reason)

getTransactionId

public CfdpTransactionId getTransactionId()

Description copied from interface: CfdpFileTransfer

Get the CFDP transaction id. Returns null for queued transfers.

Specified by:

getTransactionId in interface CfdpFileTransfer

isReliable

public boolean isReliable()

Specified by:

isReliable in interface FileTransfer

getStartTime

public long getStartTime()

Specified by:

getStartTime in interface FileTransfer

failTransfer

protected void failTransfer(String failureReason)

changeState

protected void changeState(org.yamcs.protobuf.TransferState newState)

getFailuredReason

public String getFailuredReason()

Specified by:

getFailuredReason in interface FileTransfer

getId

public long getId()

Specified by:

getId in interface FileTransfer

getFaultHandlingAction

protected org.yamcs.cfdp.OngoingCfdpTransfer.FaultHandlingAction getFaultHandlingAction(ConditionCode code)

getInitiatorEntityId

public long getInitiatorEntityId()

Return the entity id of the Sender

Specified by:

getInitiatorEntityId in interface CfdpFileTransfer

getDestinationId

public long getDestinationId()

Return the entity id of the Receiver

Specified by:

getDestinationId in interface CfdpFileTransfer

getTransferType

public String getTransferType()

Specified by:

getTransferType in interface FileTransfer

sendInfoEvent

protected void sendInfoEvent(String type,
 String msg)

sendWarnEvent

protected void sendWarnEvent(String type,
 String msg)

toEventMsg

protected String toEventMsg(MetadataPacket packet)

getCreationTime

public long getCreationTime()

Specified by:

getCreationTime in interface FileTransfer