unlimited.fc.client.api.multiclient

Interface MultiHookManagerInterface

All Superinterfaces:

TransferState

All Known Implementing Classes:

MultiClientTransferHook, ThreadSafeMultiHook

public interface MultiHookManagerInterface
extends TransferState

Defines the common method set that is used within all Multi-Client hooks

Method Summary

Modifier and Type	Method and Description
java.util.Vector<? extends TransferHook>	getCompletedHooks() Gets the completed hooks.
int	getCompletedJobCount() Returns the amount of jobs that have been classified as completed
java.util.Vector<? extends TransferHook>	getCurrentHooks() Gets the current hooks.
java.lang.String	getErrorMessage() Returns the current error message (if any) for this transfer
int	getFailedJobCount() Returns the amount of jobs that have been classified as failures
java.util.Vector<TransferJob>	getFailedJobs() Gets the failed jobs.
TransferHook	getHook(java.lang.Integer id) Gets the hook that matches the corresponding client ID.
unlimited.core.transfers.UDPTransferMetricsContainer	getTransferMetrics()

Methods inherited from interface unlimited.fc.client.api.TransferState

getAllFilePaths, getBytesSoFarAllFiles, getBytesSoFarCurrentFile, getCountTransferred, getCurrentEffectiveRate, getCurrentFilename, getCurrentFileTransferTime, getCurrentPercent, getCurrentRate, getDirection, getEffectiveRateAverage, getFilesSoFar, getFilesTransferredLocal, getFilesTransferredRemote, getFormattedCurrentFileTransferTime, getFormattedOverallTransferTime, getFormattedTransferTime, getLocalFilename, getMeanEffectiveRate, getOverallRate, getOverallRateInKBperSecond, getOverallTimeRemaining, getOverallTimeRemainingMillis, getOverallTransferTime, getPacketLossPercent, getPercent, getRateAverage, getRateAverageInKBperSecond, getRateInKBperSecond, getRemoteFilename, getRoundTripTime, getSizeAllFiles, getSizeCurrentFile, getSizeTransferredAlreadyAllFiles, getSizeTransferredAlreadyCurrentFile, getStatusCode, getStatusMessage, getTimeRemaining, getTimeRemainingMillis, getTotalFiles, getTransferMode, getTransferStartTime, getTransferStatus, getTransferTime, getTransferWarningMessage, isSecure, isTransferCancelled, isTransferComplete, isTransferError, isTransferWarning, setCancelled

Method Detail

getFailedJobs

java.util.Vector<TransferJob> getFailedJobs()

Gets the failed jobs.

Returns:

the failed jobs

getCurrentHooks

java.util.Vector<? extends TransferHook> getCurrentHooks()

Gets the current hooks.

Returns:

the current hooks

getCompletedHooks

java.util.Vector<? extends TransferHook> getCompletedHooks()

Gets the completed hooks.

Returns:

the completed hooks

getTransferMetrics

unlimited.core.transfers.UDPTransferMetricsContainer getTransferMetrics()

See Also:

UDPTransferMetrics.getTransferMetrics()

getErrorMessage

java.lang.String getErrorMessage()

Returns the current error message (if any) for this transfer

See Also:

TransferHook.getErrorMessage()

getHook

TransferHook getHook(java.lang.Integer id)

Gets the hook that matches the corresponding client ID.

Parameters:

id - the id

Returns:

the hook

getCompletedJobCount

int getCompletedJobCount()

Returns the amount of jobs that have been classified as completed

Returns:

Non negative whole number

getFailedJobCount

int getFailedJobCount()

Returns the amount of jobs that have been classified as failures

Returns:

Non negative whole number