Constructor
new Bandwidther(sessionId, network, requestedBw, negotiationBandwidth, proactive)
Constructor for the Bandwidther class. Does not validate input data
coherence.
Parameters:
| Name | Type | Description |
|---|---|---|
sessionId |
number | The session id to perform the pings |
network |
ClientNetwork | Network object |
requestedBw |
number | required bandwidth is in kbits/s |
negotiationBandwidth |
number | Time to run the test in seconds |
proactive |
Boolean | Tells teh bandwidther to be proactive |
- Source:
Methods
(static) genClient(sessionId, network, requestedBw, negotiationBandwidth) → {Bandwidther}
Generates a new bandwidther with Client settings.
Parameters:
| Name | Type | Description |
|---|---|---|
sessionId |
number | The session id to perform the pings |
network |
ClientNetwork | ServerNetwork | Network object |
requestedBw |
number | required bandwidth is in kbits/s |
negotiationBandwidth |
number | Time to run the test in seconds |
- Source:
Returns:
- Type
- Bandwidther
(static) genServer(sessionId, network, requestedBw, negotiationBandwidth) → {Bandwidther}
Generates a new bandwidther with Server settings.
Parameters:
| Name | Type | Description |
|---|---|---|
sessionId |
number | The session id to perform the pings |
network |
ClientNetwork | ServerNetwork | Network object |
requestedBw |
number | required bandwidth is in kbits/s |
negotiationBandwidth |
number | Time to run the test in seconds |
- Source:
Returns:
- Type
- Bandwidther
cancel()
Cancel communication
- Source:
measure() → {Promise}
Starts the measurement stage.
- Source:
Returns:
On sucess the measures, on error the error
- Type
- Promise