fr.bmartel.speedtest.inter

Interface ISpeedTestSocket

All Known Implementing Classes:

SpeedTestSocket

public interface ISpeedTestSocket

Interface for speed test socket.

Method Summary

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.
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).
int	getUploadChunkSize() retrieve size of each packet sent to upload server.
UploadStorageType	getUploadStorageType() retrieve storage type used for uploaded data.
void	removeSpeedTestListener(ISpeedTestListener listener) Relive a speed listener from list.
void	setUploadStorageType(UploadStorageType uploadStorageType) Set upload storage type.
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	startUpload(java.lang.String hostname, int port, java.lang.String uri, int fileSizeOctet) Start upload process.

Method Detail

startUpload

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

startDownload

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

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.

getLiveDownloadReport

SpeedTestReport getLiveDownloadReport()

get a temporary download report at this moment.

Returns:

speed test download report

getLiveUploadReport

SpeedTestReport getLiveUploadReport()

get a temporary upload report at this moment.

Returns:

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