FileTransferProgress.Status (core 2.5.1 API)

Summary:
Property
Method

| Detail:
Property
Method

org.hidetake.groovy.ssh.util.FileTransferProgress.Status

Represents transferred bytes and elapsed time.

Properties Summary

Properties
Type	Name and description
`long`	`lastCheckPointTime` Timestamp in milliseconds when the last checkpoint is committed.
`long`	`maxSize` Estimated bytes to transfer.
`long`	`startedTime` Timestamp in milliseconds when transfer is started.
`long`	`transferredSize` Actually transferred bytes.

Methods Summary

Methods
Type	Name and description
`void`	`checkPoint()` Commit a checkpoint.
`static long`	`currentTime()`
`long`	`getElapsedTime()` Return elapsed time in milliseconds from started
`long`	`getElapsedTimeFromCheckPoint()` Return elapsed time in milliseconds from the last checkpoint
`double`	`getKiloBytesPerSecond()` Return transfer rate in kbps.
`double`	`getPercent()` Return percent of transferred data.
`Status`	`leftShift(long size)` Report the progress that data has been transferred.

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class java.lang.Object`	`java.lang.Object#wait(long, int), java.lang.Object#wait(long), java.lang.Object#wait(), java.lang.Object#equals(java.lang.Object), java.lang.Object#toString(), java.lang.Object#hashCode(), java.lang.Object#getClass(), java.lang.Object#notify(), java.lang.Object#notifyAll()`

- Property Detail
  - long lastCheckPointTime
    
    Timestamp in milliseconds when the last checkpoint is committed.
  - final long maxSize
    
    Estimated bytes to transfer.
  - final long startedTime
    
    Timestamp in milliseconds when transfer is started.
  - long transferredSize
    
    Actually transferred bytes.
- Method Detail
  - void checkPoint()
    
    Commit a checkpoint.
  - static long currentTime()
  - long getElapsedTime()
    
    Return elapsed time in milliseconds from started
    Returns:
    elapsed time in milliseconds from started
  - long getElapsedTimeFromCheckPoint()
    
    Return elapsed time in milliseconds from the last checkpoint
    Returns:
    elapsed time in milliseconds from the last checkpoint
  - double getKiloBytesPerSecond()
    
    Return transfer rate in kbps.
    Returns:
    transfer rate in kbps
  - double getPercent()
    
    Return percent of transferred data.
    Returns:
    percent of transferred data
  - Status leftShift(long size)
    
    Report the progress that data has been transferred.
    Parameters:
    size - transferred size in bytes
    Returns:
    this instance

Summary:
Property
Method

| Detail:
Property
Method

Groovy Documentation