Crosstales.OnlineCheck.Tool.SpeedTestNET.SpeedTestNET Class Reference

Test the down- and upload speed of the Internet connection. More...

Inheritance diagram for Crosstales.OnlineCheck.Tool.SpeedTestNET.SpeedTestNET:
Crosstales.Common.Util.Singleton< SpeedTestNET >

Public Member Functions

delegate void TestCompleted (Crosstales.OnlineCheck.Tool.SpeedTestNET.Model.Server server, double duration, double downloadspeed, double uploadspeed)
 Callback to determine whether the speed test has completed. More...
 
void Test ()
 Checks the Internet down- and upload speed. More...
 
void Start ()
 

Public Attributes

SpeedTestNETCompleteEvent OnSpeedTestComplete
 
double LastDownloadSpeedMBps => LastDownloadSpeed / 8 / 1024 / 1024
 Returns the last download speed in mega bytes-per-second (MBps). More...
 
double LastUploadSpeedMBps => LastUploadSpeed / 8 / 1024 / 1024
 Returns the last upload speed in mega bytes-per-second (MBps). More...
 
bool isPlatformSupported => !Helper.isWebPlatform && !Helper.isWSABasedPlatform
 Indicates if SpeedTestNET is supporting the current platform. More...
 

Protected Member Functions

override void OnApplicationQuit ()
 
- Protected Member Functions inherited from Crosstales.Common.Util.Singleton< SpeedTestNET >
virtual void Awake ()
 
virtual void OnDestroy ()
 

Properties

bool TestDownload [get, set]
 Test the download speed. More...
 
bool TestUpload [get, set]
 Test the upload speed. More...
 
bool RunOnStart [get, set]
 Start at runtime. More...
 
Crosstales.OnlineCheck.Tool.SpeedTestNET.Model.Server LastServer [get]
 Returns the last used server. More...
 
double LastDuration [get]
 Returns the last test duration size seconds. More...
 
double LastDownloadSpeed [get]
 Returns the last download speed in bits-per-second (bps). More...
 
double LastUploadSpeed [get]
 Returns the last upload speed in bits-per-second (bps). More...
 
bool isBusy [get]
 Returns true if SpeedTest is busy. More...
 
- Properties inherited from Crosstales.Common.Util.Singleton< SpeedTestNET >
static T Instance [get, protected set]
 Returns the singleton instance of this class. More...
 
bool DontDestroy [get, set]
 Don't destroy gameobject during scene switches. More...
 

Events

TestCompleted OnTestCompleted
 An event triggered whenever the speed test has completed. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from Crosstales.Common.Util.Singleton< SpeedTestNET >
static void CreateInstance (bool searchExistingGameObject=true, bool deleteExistingInstance=false)
 Creates an instance of this object. More...
 
static void DeleteInstance ()
 Deletes the instance of this object. More...
 
- Static Public Attributes inherited from Crosstales.Common.Util.Singleton< SpeedTestNET >
static string PrefabPath
 Fully qualified prefab path. More...
 
static string GameObjectName
 Name of the gameobject in the scene. More...
 
- Static Protected Attributes inherited from Crosstales.Common.Util.Singleton< SpeedTestNET >
static T instance
 

Detailed Description

Test the down- and upload speed of the Internet connection.

Member Function Documentation

◆ Test()

void Crosstales.OnlineCheck.Tool.SpeedTestNET.SpeedTestNET.Test ( )

Checks the Internet down- and upload speed.

◆ TestCompleted()

delegate void Crosstales.OnlineCheck.Tool.SpeedTestNET.SpeedTestNET.TestCompleted ( Crosstales.OnlineCheck.Tool.SpeedTestNET.Model.Server  server,
double  duration,
double  downloadspeed,
double  uploadspeed 
)

Callback to determine whether the speed test has completed.

Member Data Documentation

◆ isPlatformSupported

bool Crosstales.OnlineCheck.Tool.SpeedTestNET.SpeedTestNET.isPlatformSupported => !Helper.isWebPlatform && !Helper.isWSABasedPlatform

Indicates if SpeedTestNET is supporting the current platform.

Returns
True if SpeedTestNET supports current platform.

◆ LastDownloadSpeedMBps

double Crosstales.OnlineCheck.Tool.SpeedTestNET.SpeedTestNET.LastDownloadSpeedMBps => LastDownloadSpeed / 8 / 1024 / 1024

Returns the last download speed in mega bytes-per-second (MBps).

Returns
Last test download in mega bytes-per-second (MBps).

◆ LastUploadSpeedMBps

double Crosstales.OnlineCheck.Tool.SpeedTestNET.SpeedTestNET.LastUploadSpeedMBps => LastUploadSpeed / 8 / 1024 / 1024

Returns the last upload speed in mega bytes-per-second (MBps).

Returns
Last test upload in mega bytes-per-second (MBps).

Property Documentation

◆ isBusy

bool Crosstales.OnlineCheck.Tool.SpeedTestNET.SpeedTestNET.isBusy
get

Returns true if SpeedTest is busy.

Returns
True if if SpeedTest is busy.

◆ LastDownloadSpeed

double Crosstales.OnlineCheck.Tool.SpeedTestNET.SpeedTestNET.LastDownloadSpeed
get

Returns the last download speed in bits-per-second (bps).

Returns
Last download speed in bits-per-second (bps).

◆ LastDuration

double Crosstales.OnlineCheck.Tool.SpeedTestNET.SpeedTestNET.LastDuration
get

Returns the last test duration size seconds.

Returns
Last test duration size seconds.

◆ LastServer

Crosstales.OnlineCheck.Tool.SpeedTestNET.Model.Server Crosstales.OnlineCheck.Tool.SpeedTestNET.SpeedTestNET.LastServer
get

Returns the last used server.

Returns
Last used server.

◆ LastUploadSpeed

double Crosstales.OnlineCheck.Tool.SpeedTestNET.SpeedTestNET.LastUploadSpeed
get

Returns the last upload speed in bits-per-second (bps).

Returns
Last upload speed in bits-per-second (bps).

◆ RunOnStart

bool Crosstales.OnlineCheck.Tool.SpeedTestNET.SpeedTestNET.RunOnStart
getset

Start at runtime.

◆ TestDownload

bool Crosstales.OnlineCheck.Tool.SpeedTestNET.SpeedTestNET.TestDownload
getset

Test the download speed.

◆ TestUpload

bool Crosstales.OnlineCheck.Tool.SpeedTestNET.SpeedTestNET.TestUpload
getset

Test the upload speed.

Event Documentation

◆ OnTestCompleted

TestCompleted Crosstales.OnlineCheck.Tool.SpeedTestNET.SpeedTestNET.OnTestCompleted

An event triggered whenever the speed test has completed.


The documentation for this class was generated from the following file:
  • C:/Users/slaub/Unity/assets/OnlineCheck/OnlineCheckPro/Assets/Plugins/crosstales/OnlineCheck/Extras/SpeedTestNET/Scripts/SpeedTestNET.cs