Package org.yamcs.cfdp

Class OngoingCfdpTransfer

java.lang.Object

org.yamcs.cfdp.OngoingCfdpTransfer

All Implemented Interfaces:

CfdpTransfer

Direct Known Subclasses:

CfdpIncomingTransfer, CfdpOutgoingTransfer

public abstract class OngoingCfdpTransfer
extends Object
implements CfdpTransfer

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor	Description
OngoingCfdpTransfer(String yamcsInstance, long id, 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()
OngoingCfdpTransfer	cancelTransfer()
protected void	changeState(org.yamcs.protobuf.TransferState newState)
protected void	failTransfer(String failureReason)
long	getDestinationId()	Return the entity id of the Receiver
String	getFailuredReason()
protected org.yamcs.cfdp.OngoingCfdpTransfer.FaultHandlingAction	getFaultHandlingAction(ConditionCode code)
long	getId()
long	getSourceId()	Return the entity id of the Sender
long	getStartTime()
CfdpTransactionId	getTransactionId()
org.yamcs.protobuf.TransferState	getTransferState()
boolean	isOngoing()
boolean	isReliable()
protected abstract void	onInactivityTimerExpiration()
boolean	pausable()
OngoingCfdpTransfer	pauseTransfer()
abstract void	processPacket(CfdpPacket packet)
protected void	rescheduleInactivityTimer()
protected abstract void	resume()
OngoingCfdpTransfer	resumeTransfer()
protected void	sendAck(AckPacket ackPacket)
protected void	sendPacket(CfdpPacket packet)
protected abstract void	suspend()

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.CfdpTransfer

getBucketName, getDirection, getObjectName, getRemotePath, getTotalSize, getTransferredSize

Field Detail

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

inactivityFuture

protected ScheduledFuture<?> inactivityFuture

failureReason

protected String failureReason

Constructor Detail

OngoingCfdpTransfer

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

Method Detail

processPacket

public abstract void processPacket(CfdpPacket packet)

sendAck

protected void sendAck(AckPacket ackPacket)

sendPacket

protected void sendPacket(CfdpPacket packet)

isOngoing

public final boolean isOngoing()

getTransferState

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

Specified by:

getTransferState in interface CfdpTransfer

cancellable

public boolean cancellable()

Specified by:

cancellable in interface CfdpTransfer

pausable

public boolean pausable()

Specified by:

pausable in interface CfdpTransfer

onInactivityTimerExpiration

protected abstract void onInactivityTimerExpiration()

cancelInactivityTimer

protected void cancelInactivityTimer()

rescheduleInactivityTimer

protected void rescheduleInactivityTimer()

pauseTransfer

public OngoingCfdpTransfer pauseTransfer()

suspend

protected abstract void suspend()

resumeTransfer

public OngoingCfdpTransfer resumeTransfer()

resume

protected abstract void resume()

cancelTransfer

public OngoingCfdpTransfer cancelTransfer()

cancel

protected abstract void cancel(ConditionCode code)

abandonTransfer

public OngoingCfdpTransfer abandonTransfer(String reason)

getTransactionId

public CfdpTransactionId getTransactionId()

Specified by:

getTransactionId in interface CfdpTransfer

isReliable

public boolean isReliable()

Specified by:

isReliable in interface CfdpTransfer

getStartTime

public long getStartTime()

Specified by:

getStartTime in interface CfdpTransfer

failTransfer

protected void failTransfer(String failureReason)

changeState

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

getFailuredReason

public String getFailuredReason()

Specified by:

getFailuredReason in interface CfdpTransfer

getId

public long getId()

Specified by:

getId in interface CfdpTransfer

getFaultHandlingAction

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

getSourceId

public long getSourceId()

Return the entity id of the Sender

Returns:

getDestinationId

public long getDestinationId()

Return the entity id of the Receiver

Returns: