fr.bmartel.speedtest.inter.ISpeedTestSocket Maven / Gradle / Ivy
/*
* The MIT License (MIT)
*
* Copyright (c) 2016-2017 Bertrand Martel
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE.
*/
package fr.bmartel.speedtest.inter;
import fr.bmartel.speedtest.RepeatWrapper;
import fr.bmartel.speedtest.SpeedTestReport;
import fr.bmartel.speedtest.model.ComputationMethod;
import fr.bmartel.speedtest.model.UploadStorageType;
import java.math.RoundingMode;
/**
* Interface for speed test socket.
*
* @author Bertrand Martel
*/
public interface ISpeedTestSocket {
/**
* Start upload process.
*
* @param uri uri to fetch
* @param fileSizeOctet size of file to upload
*/
void startUpload(String uri, int fileSizeOctet);
/**
* Start download process.
*
* @param uri uri to fetch to download file
*/
void startDownload(String uri);
/**
* Add a speed test listener to list.
*
* @param listener speed test listener to be added
*/
void addSpeedTestListener(ISpeedTestListener listener);
/**
* Relive a speed listener from list.
*
* @param listener speed test listener to be removed
*/
void removeSpeedTestListener(ISpeedTestListener listener);
/**
* close socket + shutdown thread pool.
*/
void forceStopTask();
/**
* get a temporary download/upload report at this moment.
*
* @return speed test download report
*/
SpeedTestReport getLiveReport();
/**
* Close socket streams and socket object.
*/
void closeSocket();
/**
* Shutdown threadpool and wait for task completion.
*/
void shutdownAndWait();
/**
* get socket timeout in milliseconds ( 0 if no timeout not defined).
*
* @return mSocket timeout value (0 if not defined)
*/
int getSocketTimeout();
/**
* retrieve size of each packet sent to upload server.
*
* @return size of each packet sent to upload server
*/
int getUploadChunkSize();
/**
* retrieve repeat wrapper object used to manage repeating Download/upload tasks.
*
* @return repeat wrapper object
*/
RepeatWrapper getRepeatWrapper();
/**
* retrieve rounding mode used for BigDecimal.
*
* @return rounding mode
*/
RoundingMode getDefaultRoundingMode();
/**
* retrieve scale used for BigDecimal.
*
* @return mScale value
*/
int getDefaultScale();
/**
* retrieve storage type used for uploaded data.
*
* @return storage type
*/
UploadStorageType getUploadStorageType();
/**
* Set upload storage type.
*
* @param uploadStorageType upload storage type
*/
void setUploadStorageType(UploadStorageType uploadStorageType);
/**
* Get download setup time value.
*
* @return download setup time
*/
long getDownloadSetupTime();
/**
* Get upload setup time value.
*
* @return upload setup time
*/
long getUploadSetupTime();
/**
* Set computation method used to calculate transfer rate.
*
* @param computationMethod model value
*/
void setComputationMethod(ComputationMethod computationMethod);
/**
* Get the computation method.
*
* @return computation method
*/
ComputationMethod getComputationMethod();
}