ISpeedTestSocket (jspeedtest 1.32.1 API)

All Known Implementing Classes:

SpeedTestSocket
```
public interface ISpeedTestSocket
```
Interface for speed test socket.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`addSpeedTestListener(ISpeedTestListener listener)` Add a speed test listener to list.
`void`	`closeSocket()` Close socket streams and socket object.
`void`	`forceStopTask()` close socket + shutdown thread pool.
`ComputationMethod`	`getComputationMethod()` Get the computation method.
`java.math.RoundingMode`	`getDefaultRoundingMode()` retrieve rounding mode used for BigDecimal.
`int`	`getDefaultScale()` retrieve scale used for BigDecimal.
`long`	`getDownloadSetupTime()` Get download setup time value.
`FtpMode`	`getFtpMode()` Get FTP mode.
`SpeedTestReport`	`getLiveReport()` get a temporary download/upload report at this moment.
`RepeatWrapper`	`getRepeatWrapper()` retrieve repeat wrapper object used to manage repeating Download/upload tasks.
`int`	`getSocketTimeout()` get socket timeout in milliseconds ( 0 if no timeout not defined).
`int`	`getUploadChunkSize()` retrieve size of each packet sent to upload server.
`long`	`getUploadSetupTime()` Get upload setup time value.
`UploadStorageType`	`getUploadStorageType()` retrieve storage type used for uploaded data.
`void`	`removeSpeedTestListener(ISpeedTestListener listener)` Relive a speed listener from list.
`void`	`setComputationMethod(ComputationMethod computationMethod)` Set computation method used to calculate transfer rate.
`boolean`	`setProxyServer(java.lang.String proxyUrl)` Set proxy server for all DL/UL tasks.
`void`	`setUploadStorageType(UploadStorageType uploadStorageType)` Set upload storage type.
`void`	`shutdownAndWait()` Shutdown threadpool and wait for task completion.
`void`	`startDownload(java.lang.String uri)` Start download process.
`void`	`startUpload(java.lang.String uri, int fileSizeOctet)` Start upload process.

- Method Detail
  - startUpload
```
void startUpload(java.lang.String uri,
                 int fileSizeOctet)
```
    Start upload process.
    
    Parameters:
    
    uri - uri to fetch
    
    fileSizeOctet - size of file to upload
  - startDownload
```
void startDownload(java.lang.String uri)
```
    Start download process.
    
    Parameters:
    
    uri - uri to fetch to download file
  - addSpeedTestListener
```
void addSpeedTestListener(ISpeedTestListener listener)
```
    Add a speed test listener to list.
    
    Parameters:
    
    listener - speed test listener to be added
  - removeSpeedTestListener
```
void removeSpeedTestListener(ISpeedTestListener listener)
```
    Relive a speed listener from list.
    
    Parameters:
    
    listener - speed test listener to be removed
  - forceStopTask
```
void forceStopTask()
```
    close socket + shutdown thread pool.
  - getLiveReport
```
SpeedTestReport getLiveReport()
```
    get a temporary download/upload report at this moment.
    
    Returns:
    
    speed test download report
  - closeSocket
```
void closeSocket()
```
    Close socket streams and socket object.
  - shutdownAndWait
```
void shutdownAndWait()
```
    Shutdown threadpool and wait for task completion.
  - getSocketTimeout
```
int getSocketTimeout()
```
    get socket timeout in milliseconds ( 0 if no timeout not defined).
    
    Returns:
    
    mSocket timeout value (0 if not defined)
  - getUploadChunkSize
```
int getUploadChunkSize()
```
    retrieve size of each packet sent to upload server.
    
    Returns:
    
    size of each packet sent to upload server
  - getRepeatWrapper
```
RepeatWrapper getRepeatWrapper()
```
    retrieve repeat wrapper object used to manage repeating Download/upload tasks.
    
    Returns:
    
    repeat wrapper object
  - getDefaultRoundingMode
```
java.math.RoundingMode getDefaultRoundingMode()
```
    retrieve rounding mode used for BigDecimal.
    
    Returns:
    
    rounding mode
  - getDefaultScale
```
int getDefaultScale()
```
    retrieve scale used for BigDecimal.
    
    Returns:
    
    mScale value
  - getUploadStorageType
```
UploadStorageType getUploadStorageType()
```
    retrieve storage type used for uploaded data.
    
    Returns:
    
    storage type
  - setUploadStorageType
```
void setUploadStorageType(UploadStorageType uploadStorageType)
```
    Set upload storage type.
    
    Parameters:
    
    uploadStorageType - upload storage type
  - getDownloadSetupTime
```
long getDownloadSetupTime()
```
    Get download setup time value.
    
    Returns:
    
    download setup time
  - getUploadSetupTime
```
long getUploadSetupTime()
```
    Get upload setup time value.
    
    Returns:
    
    upload setup time
  - setComputationMethod
```
void setComputationMethod(ComputationMethod computationMethod)
```
    Set computation method used to calculate transfer rate.
    
    Parameters:
    
    computationMethod - model value
  - getComputationMethod
```
ComputationMethod getComputationMethod()
```
    Get the computation method.
    
    Returns:
    
    computation method
  - setProxyServer
```
boolean setProxyServer(java.lang.String proxyUrl)
```
    Set proxy server for all DL/UL tasks.
    
    Parameters:
    
    proxyUrl - proxy URL
    
    Returns:
    
    false if malformed
  - getFtpMode
```
FtpMode getFtpMode()
```
    Get FTP mode.
    
    Returns:
    
    ftp mode

Interface ISpeedTestSocket

Method Summary

Method Detail

startUpload

startDownload

addSpeedTestListener

removeSpeedTestListener

forceStopTask

getLiveReport

closeSocket

shutdownAndWait

getSocketTimeout

getUploadChunkSize

getRepeatWrapper

getDefaultRoundingMode

getDefaultScale

getUploadStorageType

setUploadStorageType

getDownloadSetupTime

getUploadSetupTime

setComputationMethod

getComputationMethod

setProxyServer

getFtpMode