fr.bmartel.speedtest

Class SpeedTestSocket

java.lang.Object

fr.bmartel.speedtest.SpeedTestSocket

public class SpeedTestSocket
extends java.lang.Object

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 socket initial connection

Constructor Summary

Constructors

Constructor and Description
SpeedTestSocket() Build Client socket.

Method Summary

Methods

Modifier and Type	Method and Description
void	addSpeedTestListener(ISpeedTestListener listener) Add a speed examples listener to list.
void	closeSocket() Close socket streams and socket object.
void	forceStopTask() close socket + shutdown thread pool.
SpeedTestReport	getLiveDownloadReport() get a temporary download report at this moment.
SpeedTestReport	getLiveUploadReport() get a temporary upload report at this moment.
int	getSocketTimeout() get socket timeout in milliseconds ( 0 if no timeout not defined).
SpeedTestMode	getSpeedTestMode() retrieve current speed examples mode.
int	getUploadChunkSize() retrieve size of each packet sent to upload server.
void	removeSpeedTestListener(ISpeedTestListener listener) Relive a speed listener from list.
void	setSocketTimeout(int socketTimeoutMillis) set socket timeout in millisecond.
void	setUploadChunkSize(int uploadChunkSize) set size of each packet sent to upload server.
void	startDownload(java.lang.String hostname, int port, java.lang.String uri) Start download process.
void	startDownloadRepeat(java.lang.String hostname, int port, java.lang.String uri, int repeatWindow, int reportPeriodMillis, IRepeatListener repeatListener) Start repeat download task.
void	startUpload(java.lang.String hostname, int port, java.lang.String uri, int fileSizeOctet) Start upload process.

Methods inherited from class java.lang.Object

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

Constructor Detail

SpeedTestSocket

public SpeedTestSocket()

Build Client socket.

Method Detail

addSpeedTestListener

public void addSpeedTestListener(ISpeedTestListener listener)

Add a speed examples listener to list.

Parameters:

listener - speed examples listener to be added

removeSpeedTestListener

public void removeSpeedTestListener(ISpeedTestListener listener)

Relive a speed listener from list.

Parameters:

listener - speed examples listener to be removed

startDownload

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

Start download process.

Parameters:

hostname - server hostname

port - server port

uri - uri to fetch to download file

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 hostname

port - server port

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

forceStopTask

public void forceStopTask()

close socket + shutdown thread pool.

startUpload

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

Start upload process.

Parameters:

hostname - server hostname

port - server port

uri - uri to fetch

fileSizeOctet - size of file to upload

getLiveDownloadReport

public SpeedTestReport getLiveDownloadReport()

get a temporary download report at this moment.

Returns:

speed examples download report

getLiveUploadReport

public SpeedTestReport getLiveUploadReport()

get a temporary upload report at this moment.

Returns:

speed examples upload report

closeSocket

public void closeSocket()

Close socket streams and socket object.

getSpeedTestMode

public SpeedTestMode getSpeedTestMode()

retrieve current speed examples mode.

Returns:

speed examples mode (UPLOAD/DOWNLOAD/NONE)

setSocketTimeout

public void setSocketTimeout(int socketTimeoutMillis)

set socket timeout in millisecond.

Parameters:

socketTimeoutMillis - socket timeout value in milliseconds

getSocketTimeout

public int getSocketTimeout()

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

Returns:

socket timeout value (0 if not defined)

getUploadChunkSize

public int getUploadChunkSize()

retrieve size of each packet sent to upload server.

Returns:

size of each packet sent to upload server

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