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()

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.
java.math.RoundingMode	getDefaultRoundingMode() retrieve rounding mode used for BigDecimal.
int	getDefaultScale() retrieve scale used for BigDecimal.
SpeedTestReport	getLiveDownloadReport() get a temporary download report at this moment.
SpeedTestReport	getLiveUploadReport() get a temporary 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).
SpeedTestMode	getSpeedTestMode() retrieve current speed test mode.
int	getUploadChunkSize() retrieve size of each packet sent to upload server.
void	removeSpeedTestListener(ISpeedTestListener listener) Relive a speed listener from list.
void	setDefaultRoundingMode(java.math.RoundingMode roundingMode) Set the default RoundingMode for BigDecimal.
void	setDefaultScale(int scale) Set the default scale for BigDecimal.
void	setSocketTimeout(int socketTimeoutMillis) set socket timeout in millisecond.
void	setUploadChunkSize(int uploadChunkSize) set size of each packet sent to upload server.
void	shutdownAndWait() Shutdown threadpool and wait for task completion.
void	startDownload(java.lang.String hostname, int port, java.lang.String uri) Start download process.
void	startDownload(java.lang.String hostname, int port, java.lang.String uri, int reportInterval) Start download process.
void	startDownload(java.lang.String hostname, java.lang.String uri) Start download process with default to port 80.
void	startDownload(java.lang.String hostname, java.lang.String uri, int reportInterval) Start download process with default to port 80 with specified report interval.
void	startDownloadRepeat(java.lang.String hostname, int port, java.lang.String uri, int repeatWindow, int reportPeriodMillis, IRepeatListener repeatListener) Start repeat download task.
void	startDownloadRepeat(java.lang.String hostname, java.lang.String uri, int repeatWindow, int reportPeriodMillis, IRepeatListener repeatListener) Start repeat download task.
void	startFixedDownload(java.lang.String hostname, int port, java.lang.String uri, int maxDuration) Start download process with a fixed duration.
void	startFixedDownload(java.lang.String hostname, int port, java.lang.String uri, int maxDuration, int reportInterval) Start download process with a fixed duration.
void	startFixedUpload(java.lang.String hostname, int port, java.lang.String uri, int fileSizeOctet, int maxDuration) Start upload process.
void	startFixedUpload(java.lang.String hostname, int port, java.lang.String uri, int fileSizeOctet, int maxDuration, int reportInterval) Start upload process.
void	startFtpDownload(java.lang.String hostname, int port, java.lang.String uri, java.lang.String user, java.lang.String password) start FTP download with specific port, user, password.
void	startFtpDownload(java.lang.String hostname, java.lang.String uri) start FTP download on default port 21.
void	startFtpDownload(java.lang.String hostname, java.lang.String uri, int reportInterval) start FTP download on default port 21.
void	startFtpFixedDownload(java.lang.String hostname, java.lang.String uri, int maxDuration) start FTP download on default port 21.
void	startFtpFixedDownload(java.lang.String hostname, java.lang.String uri, int maxDuration, int reportInterval) start fixed FTP download on default port 21.
void	startFtpFixedUpload(java.lang.String hostname, java.lang.String uri, int fileSizeOctet, int maxDuration) Start FTP upload for a fixed duration.
void	startFtpFixedUpload(java.lang.String hostname, java.lang.String uri, int fileSizeOctet, int maxDuration, int reportInterval) Start FTP upload for a fixed duration.
void	startFtpUpload(java.lang.String hostname, int port, java.lang.String uri, int fileSizeOctet, java.lang.String user, java.lang.String password) Start FTP upload.
void	startFtpUpload(java.lang.String hostname, java.lang.String uri, int fileSizeOctet) Start FTP upload.
void	startFtpUpload(java.lang.String hostname, java.lang.String uri, int fileSizeOctet, int reportInterval) Start FTP upload.
void	startUpload(java.lang.String hostname, int port, java.lang.String uri, int fileSizeOctet) Start upload process.
void	startUpload(java.lang.String hostname, int port, java.lang.String uri, int fileSizeOctet, int reportInterval) Start upload process.
void	startUpload(java.lang.String hostname, java.lang.String uri, int fileSizeOctet) Start upload process with default port 80.
void	startUpload(java.lang.String hostname, java.lang.String uri, int fileSizeOctet, int reportInterval) Start upload process with default port 80 & specified report interval.
void	startUploadRepeat(java.lang.String hostname, int port, java.lang.String uri, int repeatWindow, int reportPeriodMillis, int fileSizeOctet, IRepeatListener repeatListener) Start repeat upload task.
void	startUploadRepeat(java.lang.String hostname, java.lang.String uri, int repeatWindow, int reportPeriodMillis, 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()

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 hostname,
                               int port,
                               java.lang.String uri,
                               int maxDuration)

Start download process with a fixed duration.

Parameters:

hostname - server mHostname

port - server mPort

uri - uri to fetch to download file

maxDuration - maximum duration of the speed test in milliseconds

startFixedDownload

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

Start download process with a fixed duration.

Parameters:

hostname - server mHostname

port - server mPort

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 hostname,
                          java.lang.String uri)

Start download process with default to port 80.

Parameters:

hostname - server mHostname

uri - uri to fetch to download file

startDownload

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

Start download process with default to port 80 with specified report interval.

Parameters:

hostname - server mHostname

uri - uri to fetch to download file

reportInterval - report interval in milliseconds

startDownload

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

Start download process.

Parameters:

hostname - server mHostname

port - server mPort

uri - uri to fetch to download file

reportInterval - report interval in milliseconds

startDownload

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

Start download process.

Specified by:

startDownload in interface ISpeedTestSocket

Parameters:

hostname - server mHostname

port - server mPort

uri - uri to fetch to download file

startFtpDownload

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

start FTP download on default port 21.

Parameters:

hostname - ftp host

uri - ftp uri

reportInterval - report interval in milliseconds

startFtpFixedDownload

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

start fixed FTP download on default port 21.

Parameters:

hostname - ftp host

uri - ftp uri

reportInterval - report interval in milliseconds

startFtpFixedDownload

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

start FTP download on default port 21.

Parameters:

hostname - ftp host

uri - ftp uri

startFtpDownload

public void startFtpDownload(java.lang.String hostname,
                             java.lang.String uri)

start FTP download on default port 21.

Parameters:

hostname - ftp host

uri - ftp uri

startFtpDownload

public void startFtpDownload(java.lang.String hostname,
                             int port,
                             java.lang.String uri,
                             java.lang.String user,
                             java.lang.String password)

start FTP download with specific port, user, password.

Parameters:

hostname - ftp host

uri - ftp uri

user - ftp username

password - ftp password

startFixedUpload

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

Start upload process.

Parameters:

hostname - server mHostname

port - server mPort

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 hostname,
                             int port,
                             java.lang.String uri,
                             int fileSizeOctet,
                             int maxDuration,
                             int reportInterval)

Start upload process.

Parameters:

hostname - server hostname

port - server port

uri - uri to fetch

fileSizeOctet - size of file to upload

maxDuration - maximum duration of speed test in milliseconds

reportInterval - report interval in milliseconds

startFtpFixedUpload

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

Start FTP upload for a fixed duration.

Parameters:

hostname - server hostname

uri - ftp uri

fileSizeOctet - file size to upload in octet

maxDuration - max duration of upload in milliseconds

reportInterval - report interval in milliseconds

startFtpFixedUpload

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

Start FTP upload for a fixed duration.

Parameters:

hostname - server hostname

uri - ftp uri

fileSizeOctet - file size to upload in octet

maxDuration - max duration of upload in milliseconds

startFtpUpload

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

Start FTP upload.

Parameters:

hostname - server hostname

uri - ftp uri

fileSizeOctet - file size to upload in octet

reportInterval - report interval in milliseconds

startFtpUpload

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

Start FTP upload.

Parameters:

hostname - server hostname

uri - ftp uri

fileSizeOctet - file size to upload in octet

startFtpUpload

public void startFtpUpload(java.lang.String hostname,
                           int port,
                           java.lang.String uri,
                           int fileSizeOctet,
                           java.lang.String user,
                           java.lang.String password)

Start FTP upload.

Parameters:

hostname - ftp host

port - ftp port

uri - upload uri

fileSizeOctet - file size in octet

user - username

password - password

startUpload

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

Start upload process with default port 80.

Parameters:

hostname - server mHostname

uri - uri to fetch

fileSizeOctet - size of file to upload

startUpload

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

Start upload process with default port 80 & specified report interval.

Parameters:

hostname - server mHostname

uri - uri to fetch

fileSizeOctet - size of file to upload

reportInterval - report interval in milliseconds

startUpload

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

Start upload process.

Parameters:

hostname - server mHostname

port - server mPort

uri - uri to fetch

fileSizeOctet - size of file to upload

reportInterval - report interval in milliseconds

startUpload

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

Start upload process.

Specified by:

startUpload in interface ISpeedTestSocket

Parameters:

hostname - server mHostname

port - server mPort

uri - uri to fetch

fileSizeOctet - size of file to upload

startDownloadRepeat

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

Start repeat download task.

Parameters:

hostname - server mHostname

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

startDownloadRepeat

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

Start repeat download task.

Parameters:

hostname - server mHostname

port - server mPort

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 hostname,
                              java.lang.String uri,
                              int repeatWindow,
                              int reportPeriodMillis,
                              int fileSizeOctet,
                              IRepeatListener repeatListener)

Start repeat upload task.

Parameters:

hostname - server mHostname

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

startUploadRepeat

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

Start repeat upload task.

Parameters:

hostname - server mHostname

port - server mPort

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

getLiveDownloadReport

public SpeedTestReport getLiveDownloadReport()

get a temporary download report at this moment.

Specified by:

getLiveDownloadReport in interface ISpeedTestSocket

Returns:

speed test download report

getLiveUploadReport

public SpeedTestReport getLiveUploadReport()

get a temporary upload report at this moment.

Specified by:

getLiveUploadReport in interface ISpeedTestSocket

Returns:

speed test 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

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

clearListeners

public void clearListeners()

Clear all listeners.