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 test listener to list
void	closeSocket() Close socket streams and socket object
void	closeSocketJoinRead() Join reading thread before closing socket
void	connectAndExecuteTask(java.util.TimerTask task, boolean isDownload) Create and connect socket
void	forceStopTask()
SpeedTestReport	getLiveDownloadReport() get a temporary download report at this moment
SpeedTestReport	getLiveUploadReport() get a temporary upload report at this moment
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	setSocketTimeout(int socketTimeoutMillis)
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
void	writeDownload(byte[] data) Write download request to server host

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 test listener to list

Parameters:

listener -

removeSpeedTestListener

public void removeSpeedTestListener(ISpeedTestListener listener)

Relive a speed listener from list

Parameters:

listener -

connectAndExecuteTask

public void connectAndExecuteTask(java.util.TimerTask task,
                         boolean isDownload)

Create and connect socket

Parameters:

task - task to be executed when connected to socket

isDownload - define if it is a download or upload test

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

writeDownload

public void writeDownload(byte[] data)

Write download request to server host

Parameters:

data - HTTP request to send to initiate downwload process

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 test download report

getLiveUploadReport

public SpeedTestReport getLiveUploadReport()

get a temporary upload report at this moment

Returns:

speed test upload report

closeSocket

public void closeSocket()

Close socket streams and socket object

closeSocketJoinRead

public void closeSocketJoinRead()

Join reading thread before closing socket

getSpeedTestMode

public SpeedTestMode getSpeedTestMode()

retrieve current speed test mode

Returns:

speed test mode (UPLOAD/DOWNLOAD/NONE)

getUploadChunkSize

public int getUploadChunkSize()

retrieve size of each packet sent to upload server

Returns:

size of each packet sent to upload server

setSocketTimeout

public void setSocketTimeout(int socketTimeoutMillis)

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