Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/m-lab/ndt7-client-android
ndt7 Android-native client
https://github.com/m-lab/ndt7-client-android
bbr ndt ndt7 network-performance-test network-speed tcpinfo
Last synced: 3 days ago
JSON representation
ndt7 Android-native client
- Host: GitHub
- URL: https://github.com/m-lab/ndt7-client-android
- Owner: m-lab
- License: apache-2.0
- Created: 2018-09-29T12:01:37.000Z (about 6 years ago)
- Default Branch: main
- Last Pushed: 2024-06-08T20:49:14.000Z (5 months ago)
- Last Synced: 2024-10-29T13:50:08.439Z (17 days ago)
- Topics: bbr, ndt, ndt7, network-performance-test, network-speed, tcpinfo
- Language: Kotlin
- Homepage: https://www.measurementlab.net/
- Size: 208 KB
- Stars: 12
- Watchers: 4
- Forks: 11
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ndt7-kotlin
Kotlin implementation of the [NDT7 protocol by M-Lab](https://github.com/m-lab/ndt-server/blob/master/spec/ndt7-protocol.md)
# How it works
Consumers wishing to use the NDT7 speed test should create a subclass of type `NDTTest` and override the functions that it exposes
--------------------------------------------------------------------------------------------------------------------------------------------------------
```
open fun onMeasurementDownloadProgress(measurement: Measurement) {
}
```
Returns Measurement information during the download speed test. You can look at the Measurement data class to understand what this will provide. If you are purely interested in download speed, you don't need to override this
--------------------------------------------------------------------------------------------------------------------------------------------------------
```
open fun onMeasurementUploadProgress(measurement: Measurement) {
}
```
Returns Measurement information during the upload speed test. You can look at the Measurement data class to understand what this will provide. If you are purely interested in upload speed, you don't need to override this
--------------------------------------------------------------------------------------------------------------------------------------------------------
```
open fun onDownloadProgress(clientResponse: ClientResponse) {
}
```
This returns the ElapsedTime and NumBytes during the download test. ElapsedTime is in *microseconds*.
To ease data transformation into the commonly used `mbps`, we expose a static class that assists with the calculations
`DataConverter.convertToMbps(clientResponse) will generate a String that represents the speed in mbps. Note this is mega*BITS* per second.
--------------------------------------------------------------------------------------------------------------------------------------------------------
```
open fun onUploadProgress(clientResponse: ClientResponse) {
}
```
This returns the ElapsedTime and NumBytes during the upload test. ElapsedTime is in *microseconds*.
To ease data transformation into the commonly used `mbps`, we expose a static class that assists with the calculations
`DataConverter.convertToMbps(clientResponse) will generate a String that represents the speed in mbps. Note this is mega*BITS* per second.
--------------------------------------------------------------------------------------------------------------------------------------------------------
```
open fun onFinished(clientResponse: ClientResponse?, error: Throwable?, testType: TestType) {
}
```
This will be called when a speed test is finished. It includes the type of test. If you run both an upload and download test, this will be fired twice. Once with download results and once with the upload results.
You should also check the `error` is null. The reason for this is to allow the consumer to determine if they wish to use the results. The test may run for 9/10 seconds and then error. The consumer may believe that the results are accurate enough to use. Error will be null if the test completed successfully. Otherwise, it is up to the consumer to determine if they wish to run another scan or if they believe the partial results are acceptable
--------------------------------------------------------------------------------------------------------------------------------------------------------
We've provided two implementation examples, one for kotlin and one for java. To change which implementation is used, you need to adjust which activity is defined in the manifest
```
//this is for kotlin
//this is for java
```