Class: ContinuityPinger

continuity-pinger~ContinuityPinger(sessionId, network, periodPings, pingWndwSze, pcktlssWndwSze, proactive)

ContinuityPinger class. In charge of sending pings and obtain the metrics during Continuity.

Constructor

new ContinuityPinger(sessionId, network, periodPings, pingWndwSze, pcktlssWndwSze, proactive)

Constructor for the QualityParameters class. Does not validate input data coherence.
Parameters:
Name Type Description
sessionId number The session id to perform the pings
network ClientNetwork | ServerNetwork Network object
periodPings number ms elapsed between pings
pingWndwSze number Latency and Jitter window size
pcktlssWndwSze number Packet loss window size
proactive Boolean
Source:

Extends

  • EventEmitter

Members

localMeas :Measurement

The local measures for the parameters.
Type:
  • Measurement
Source:

maxBuffer :Number

Maximum number of samples to hold in the buffers.
Type:
  • Number
Source:

network :ClientNetwork

Client Network object to attach th listeners required for the Pinger.
Type:
  • ClientNetwork
Source:

pcktlssWndwSze :Number

Window to calculate the packet loss measures
Type:
  • Number
Source:

periodPings :Number

Time between pings requests. Measured in ms.
Type:
  • Number
Source:

pingWndwSze :Number

Window to calculate the ping and jitter measures
Type:
  • Number
Source:

recieveTime :Array.<MeasureTimestamp>

Array containing the arriving time of the Responses for the requests.
Type:
  • Array.<MeasureTimestamp>
Source:

reporMeas :Measurement

The reported measures from the other endpoint.
Type:
  • Measurement
Source:

reqTime :Array.<MeasureTimestamp>

Array containing the arriving time of the remote Requests.
Type:
  • Array.<MeasureTimestamp>
Source:

sendingTime :Array.<MeasureTimestamp>

Array containing the kickout time for Ping requests
Type:
  • Array.<MeasureTimestamp>
Source:

sequence :Number

The sequence number which is included in every Request.
Type:
  • Number
Source:

sessionId :Number

Session id to be included in the requests
Type:
  • Number
Source:

Methods

(static) genClient(sessionId, network, periodPings, pingWndwSze, pcktlssWndwSze) → {Pinger}

Generates a new pinger with Client settings.
Parameters:
Name Type Description
sessionId Number The id of the session
network ClientNetwork | ServerNetwork Network object
periodPings Number Period in ms
pingWndwSze Number Window size for ping calculation
pcktlssWndwSze Number Window size for packet loss calculation
Source:
Returns:
Type
Pinger

(static) genServer(sessionId, network, periodPings, pingWndwSze, pcktlssWndwSze) → {Pinger}

Generates a new pinger with Server settings.
Parameters:
Name Type Description
sessionId Number The id of the session
network ClientNetwork | ServerNetwork Network object
periodPings Number Period in ms
pingWndwSze Number Window size for ping calculation
pcktlssWndwSze Number Window size for packet loss calculation
Source:
Returns:
Type
Pinger

cleanLatencyTime()

Clean arrays used for latency calculation.
Source:

cleanReqTime()

Clean arrays used for jitter calculation.
Source:

measure()

Starts the measurement stage.
Source:

stop()

Stop the current measurement.
Source: