fr.bmartel.speedtest

Class SpeedTestSocket

java.lang.Object

fr.bmartel.speedtest.SpeedTestSocket

All Implemented Interfaces:

ISpeedTestSocket

public class SpeedTestSocket
extends java.lang.Object
implements ISpeedTestSocket

Client socket main implementation.

Two modes upload and download

upload will write a file to a specific host with given uri. The file is randomly generated with a given size

download will retrieve a content from a specific host with given uri.

For both mode, transfer rate is calculated independently from mSocket initial connection

Constructor Summary

Constructors

Constructor and Description
SpeedTestSocket()
SpeedTestSocket(int reportInterval) Initialize global report interval value.

Method Summary

Modifier and Type	Method and Description
void	addSpeedTestListener(ISpeedTestListener listener) Add a speed test listener to list.
void	clearListeners() Clear all listeners.
void	closeSocket() Close socket streams and socket object.
void	forceStopTask() close mSocket + 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 live report.
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).
SpeedTestMode	getSpeedTestMode() retrieve current speed test mode.
int	getUploadChunkSize() retrieve size of each packet sent to upload server.
long	getUploadSetupTime() Get upload setup time value.
UploadStorageType	getUploadStorageType() Retrieve upload storage type (RAM or ROM).
void	removeSpeedTestListener(ISpeedTestListener listener) Relive a speed listener from list.
void	setComputationMethod(ComputationMethod computationMethod) Set computation method used to calculate transfer rate.
void	setDefaultRoundingMode(java.math.RoundingMode roundingMode) Set the default RoundingMode for BigDecimal.
void	setDefaultScale(int scale) Set the default scale for BigDecimal.
void	setDownloadSetupTime(long setupTime) Set the setup time for download.
void	setFtpMode(FtpMode mode) Set FTP mode passive or active.
boolean	setProxyServer(java.lang.String proxyUrl) Set proxy server for all DL/UL tasks.
void	setSocketTimeout(int socketTimeoutMillis) set socket timeout in millisecond.
void	setUploadChunkSize(int uploadChunkSize) set size of each packet sent to upload server.
void	setUploadSetupTime(long setupTime) Set the setup time for upload.
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	startDownload(java.lang.String uri, int reportInterval) Start download process.
void	startDownloadRepeat(java.lang.String uri, int repeatWindow, int reportPeriodMillis, IRepeatListener repeatListener) Start repeat download task.
void	startDownloadRepeat(java.lang.String uri, int repeatWindow, IRepeatListener repeatListener) Start repeat download task.
void	startFixedDownload(java.lang.String uri, int maxDuration) Start download process with a fixed duration.
void	startFixedDownload(java.lang.String uri, int maxDuration, int reportInterval) Start download process with a fixed duration.
void	startFixedUpload(java.lang.String uri, int fileSizeOctet, int maxDuration) Start upload process.
void	startFixedUpload(java.lang.String uri, int fileSizeOctet, int maxDuration, int reportInterval) Start upload process.
void	startUpload(java.lang.String uri, int fileSizeOctet) Start upload process.
void	startUpload(java.lang.String uri, int fileSizeOctet, int reportInterval) Start upload process.
void	startUploadRepeat(java.lang.String uri, int repeatWindow, int reportPeriodMillis, int fileSizeOctet, IRepeatListener repeatListener) Start repeat upload task.
void	startUploadRepeat(java.lang.String uri, int repeatWindow, int fileSizeOctet, IRepeatListener repeatListener) Start repeat upload task.

Methods inherited from class java.lang.Object

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

Constructor Detail

SpeedTestSocket

public SpeedTestSocket()

SpeedTestSocket

public SpeedTestSocket(int reportInterval)

Initialize global report interval value.

Parameters:

reportInterval - report value in milliseconds

Method Detail

addSpeedTestListener

public void addSpeedTestListener(ISpeedTestListener listener)

Add a speed test listener to list.

Specified by:

addSpeedTestListener in interface ISpeedTestSocket

Parameters:

listener - speed test listener to be added

removeSpeedTestListener

public void removeSpeedTestListener(ISpeedTestListener listener)

Relive a speed listener from list.

Specified by:

removeSpeedTestListener in interface ISpeedTestSocket

Parameters:

listener - speed test listener to be removed

shutdownAndWait

public void shutdownAndWait()

Shutdown threadpool and wait for task completion.

Specified by:

shutdownAndWait in interface ISpeedTestSocket

startFixedDownload

public void startFixedDownload(java.lang.String uri,
                               int maxDuration)

Start download process with a fixed duration.

Parameters:

uri - uri to fetch to download file

maxDuration - maximum duration of the speed test in milliseconds

startFixedDownload

public void startFixedDownload(java.lang.String uri,
                               int maxDuration,
                               int reportInterval)

Start download process with a fixed duration.

Parameters:

uri - uri to fetch to download file

maxDuration - maximum duration of the speed test in milliseconds

reportInterval - report interval in milliseconds

startDownload

public void startDownload(java.lang.String uri,
                          int reportInterval)

Start download process.

Parameters:

uri - uri to fetch to download file

reportInterval - report interval in milliseconds

startDownload

public void startDownload(java.lang.String uri)

Start download process.

Specified by:

startDownload in interface ISpeedTestSocket

Parameters:

uri - uri to fetch to download file

setProxyServer

public boolean setProxyServer(java.lang.String proxyUrl)

Set proxy server for all DL/UL tasks.

Specified by:

setProxyServer in interface ISpeedTestSocket

Parameters:

proxyUrl - proxy URL

Returns:

false if malformed

startFixedUpload

public void startFixedUpload(java.lang.String uri,
                             int fileSizeOctet,
                             int maxDuration)

Start upload process.

Parameters:

uri - uri to fetch

fileSizeOctet - size of file to upload

maxDuration - maximum duration of speed test in milliseconds

startFixedUpload

public void startFixedUpload(java.lang.String uri,
                             int fileSizeOctet,
                             int maxDuration,
                             int reportInterval)

Start upload process.

Parameters:

uri - uri to fetch

fileSizeOctet - size of file to upload

maxDuration - maximum duration of speed test in milliseconds

reportInterval - report interval in milliseconds

startUpload

public void startUpload(java.lang.String uri,
                        int fileSizeOctet,
                        int reportInterval)

Start upload process.

Parameters:

uri - uri to fetch

fileSizeOctet - size of file to upload

reportInterval - report interval in milliseconds

startUpload

public void startUpload(java.lang.String uri,
                        int fileSizeOctet)

Start upload process.

Specified by:

startUpload in interface ISpeedTestSocket

Parameters:

uri - uri to fetch

fileSizeOctet - size of file to upload

startDownloadRepeat

public void startDownloadRepeat(java.lang.String uri,
                                int repeatWindow,
                                IRepeatListener repeatListener)

Start repeat download task.

Parameters:

uri - uri to fetch to download file

repeatWindow - time window for the repeated download in milliseconds

repeatListener - listener for download repeat task completion & reports

startDownloadRepeat

public void startDownloadRepeat(java.lang.String uri,
                                int repeatWindow,
                                int reportPeriodMillis,
                                IRepeatListener repeatListener)

Start repeat download task.

Parameters:

uri - uri to fetch to download file

repeatWindow - time window for the repeated download in milliseconds

reportPeriodMillis - time interval between each report in milliseconds

repeatListener - listener for download repeat task completion & reports

startUploadRepeat

public void startUploadRepeat(java.lang.String uri,
                              int repeatWindow,
                              int fileSizeOctet,
                              IRepeatListener repeatListener)

Start repeat upload task.

Parameters:

uri - uri to fetch to download file

repeatWindow - time window for the repeated upload in milliseconds

fileSizeOctet - file size in octet

repeatListener - listener for upload repeat task completion & reports

startUploadRepeat

public void startUploadRepeat(java.lang.String uri,
                              int repeatWindow,
                              int reportPeriodMillis,
                              int fileSizeOctet,
                              IRepeatListener repeatListener)

Start repeat upload task.

Parameters:

uri - uri to fetch to download file

repeatWindow - time window for the repeated upload in milliseconds

reportPeriodMillis - time interval between each report in milliseconds

fileSizeOctet - file size in octet

repeatListener - listener for upload repeat task completion & reports

forceStopTask

public void forceStopTask()

close mSocket + shutdown thread pool.

Specified by:

forceStopTask in interface ISpeedTestSocket

getLiveReport

public SpeedTestReport getLiveReport()

Get live report.

Specified by:

getLiveReport in interface ISpeedTestSocket

Returns:

download/upload report

closeSocket

public void closeSocket()

Description copied from interface: ISpeedTestSocket

Close socket streams and socket object.

Specified by:

closeSocket in interface ISpeedTestSocket

getSpeedTestMode

public SpeedTestMode getSpeedTestMode()

retrieve current speed test mode.

Returns:

speed test mode (UPLOAD/DOWNLOAD/NONE)

setSocketTimeout

public void setSocketTimeout(int socketTimeoutMillis)

set socket timeout in millisecond.

Parameters:

socketTimeoutMillis - mSocket timeout value in milliseconds

getSocketTimeout

public int getSocketTimeout()

get socket timeout in milliseconds ( 0 if no timeout not defined).

Specified by:

getSocketTimeout in interface ISpeedTestSocket

Returns:

mSocket timeout value (0 if not defined)

getUploadChunkSize

public int getUploadChunkSize()

retrieve size of each packet sent to upload server.

Specified by:

getUploadChunkSize in interface ISpeedTestSocket

Returns:

size of each packet sent to upload server

getRepeatWrapper

public RepeatWrapper getRepeatWrapper()

Description copied from interface: ISpeedTestSocket

retrieve repeat wrapper object used to manage repeating Download/upload tasks.

Specified by:

getRepeatWrapper in interface ISpeedTestSocket

Returns:

repeat wrapper object

setUploadChunkSize

public void setUploadChunkSize(int uploadChunkSize)

set size of each packet sent to upload server.

Parameters:

uploadChunkSize - new size of each packet sent to upload server

setDefaultRoundingMode

public void setDefaultRoundingMode(java.math.RoundingMode roundingMode)

Set the default RoundingMode for BigDecimal.

Parameters:

roundingMode - rounding mode.

setDefaultScale

public void setDefaultScale(int scale)

Set the default scale for BigDecimal.

Parameters:

scale - mScale value

setComputationMethod

public void setComputationMethod(ComputationMethod computationMethod)

Set computation method used to calculate transfer rate.

Specified by:

setComputationMethod in interface ISpeedTestSocket

Parameters:

computationMethod - model value

setFtpMode

public void setFtpMode(FtpMode mode)

Set FTP mode passive or active.

Parameters:

mode - ftp mode.

getComputationMethod

public ComputationMethod getComputationMethod()

Get the computation method.

Specified by:

getComputationMethod in interface ISpeedTestSocket

Returns:

computation method

setUploadSetupTime

public void setUploadSetupTime(long setupTime)

Set the setup time for upload.

Parameters:

setupTime - point in time from which upload speed rate should be computed

setDownloadSetupTime

public void setDownloadSetupTime(long setupTime)

Set the setup time for download.

Parameters:

setupTime - point in time from which download speed rate should be computed

getDownloadSetupTime

public long getDownloadSetupTime()

Get download setup time value.

Specified by:

getDownloadSetupTime in interface ISpeedTestSocket

Returns:

download setup time value

getUploadSetupTime

public long getUploadSetupTime()

Get upload setup time value.

Specified by:

getUploadSetupTime in interface ISpeedTestSocket

Returns:

upload setup time value

getDefaultRoundingMode

public java.math.RoundingMode getDefaultRoundingMode()

Retrieve rounding mode used for BigDecimal.

Specified by:

getDefaultRoundingMode in interface ISpeedTestSocket

Returns:

rounding mode

getDefaultScale

public int getDefaultScale()

Retrieve scale used for BigDecimal.

Specified by:

getDefaultScale in interface ISpeedTestSocket

Returns:

mScale value

getUploadStorageType

public UploadStorageType getUploadStorageType()

Retrieve upload storage type (RAM or ROM).

Specified by:

getUploadStorageType in interface ISpeedTestSocket

Returns:

upload storage type

setUploadStorageType

public void setUploadStorageType(UploadStorageType uploadStorageType)

Set upload storage type.

Specified by:

setUploadStorageType in interface ISpeedTestSocket

Parameters:

uploadStorageType - upload storage type

clearListeners

public void clearListeners()

Clear all listeners.

getFtpMode

public FtpMode getFtpMode()

Get FTP mode.

Specified by:

getFtpMode in interface ISpeedTestSocket

Returns:

ftp mode