Class NetworkMetricsControllerImpl

An object that may dispatch events and have handlers for those events. Similar to the DOM's EventTarget, this is a basic event system based on event naming.

Some of the advantages of EventHost over EventTarget:

Not all supported platforms support EventTarget construction or extension.
EventTarget is designed for the DOM, with bubble and capture phases not necessary in Vinyl.
Event types are strict.
Events can be plain objects, no need to extend CustomEvent.
Easier unsubscription and disposal; reduces the risk of memory leaks.

EventHost supports concurrent modification, that is, handlers may be added or removed during the execution of another handler.

Hierarchy (View Summary)

EventHostImpl<NetworkMetricsEventMap>
- NetworkMetricsControllerImpl

Implements

NetworkMetricsController

Index

Constructors

constructor

new NetworkMetricsControllerImpl(
deps: NetworkMetricsControllerImplDependencies,
options?: Partial<NetworkMetricsControllerImplOptions>,
): NetworkMetricsControllerImpl
Parameters
- deps: NetworkMetricsControllerImplDependencies
- Optionaloptions: Partial<NetworkMetricsControllerImplOptions>
Returns NetworkMetricsControllerImpl
Overrides EventHostImpl.constructor
- Defined in network/metrics/NetworkMetricsControllerImpl.ts:146

Properties

`Readonly`logPrefix

logPrefix: string = ...

A string prefix for all log statements made by this target.

Accessors

[toStringTag]

get "[toStringTag]"(): string
Returns string
Overrides EventHostImpl.[toStringTag]
- Defined in network/metrics/NetworkMetricsControllerImpl.ts:180

metrics

get metrics(): NetworkMetrics
The current metrics state. The returned object is static at the time of request.

Returns NetworkMetrics
Implementation of NetworkMetricsController.metrics
- Defined in network/metrics/NetworkMetricsControllerImpl.ts:184

Methods

addDownlinkTransferEntry

addDownlinkTransferEntry(entry: NetworkTransferEntry): void
Adds information about a completed downlink content transfer.
Parameters
- entry: NetworkTransferEntry
Returns void
Implementation of NetworkMetricsController.addDownlinkTransferEntry
- Defined in network/metrics/NetworkMetricsControllerImpl.ts:246

addMetricsEntry

addMetricsEntry(entry: NetworkMetricsEntry): void
Adds information about a completed settled request. Note: This does not update estimated bandwidth.
Parameters
- entry: NetworkMetricsEntry
Returns void
Implementation of NetworkMetricsController.addMetricsEntry
- Defined in network/metrics/NetworkMetricsControllerImpl.ts:197

dispatch

dispatch<K extends "metricsChange">(
type: K,
event: NetworkMetricsEventMap[K],
): void
Dispatches an event.
Type Parameters
- K extends "metricsChange"
Parameters
- type: K
  The key of the event within EventMap
- event: NetworkMetricsEventMap[K]
  If the passed event is read-only, then it may be re-used/cached. Otherwise, it should be a new event object every dispatch. If no target property is set on the event, the target will be set to this host.
Returns void
Inherited from EventHostImpl.dispatch
- Defined in event/EventHost.ts:108

dispose

dispose(): void
Returns void
Overrides EventHostImpl.dispose
- Defined in network/metrics/NetworkMetricsControllerImpl.ts:270

getServiceMetrics

getServiceMetrics(serviceId: Maybe<string>): ReadonlyDeep<ServiceMetrics>
Returns metrics for the given service id. If the service id is nullish, or there is no history for the given service, empty service metrics will be returned.

The returned object is static at the time of request.
Parameters
- serviceId: Maybe<string>
Returns ReadonlyDeep<ServiceMetrics>
Implementation of NetworkMetricsController.getServiceMetrics
- Defined in network/metrics/NetworkMetricsControllerImpl.ts:192

hasAnyListeners

hasAnyListeners(): boolean
Returns true if the event host has any listeners.

Returns boolean
Implementation of NetworkMetricsController.hasAnyListeners

Inherited from EventHostImpl.hasAnyListeners
- Defined in event/EventHost.ts:88

hasListeners

hasListeners(type: "metricsChange"): boolean
Returns true if the event host has any listeners for the given type.
Parameters
- type: "metricsChange"
Returns boolean
Implementation of NetworkMetricsController.hasListeners

Inherited from EventHostImpl.hasListeners
- Defined in event/EventHost.ts:95

on

on<K extends "metricsChange">(
    type: K,
    handler: EventHandler<NetworkMetricsEventMap[K]>,
    options?: SignalOptions,
): Unsubscribe
Adds an event handler for the given typed event.
Type Parameters
- K extends "metricsChange"
Parameters
- type: K
  The key representing the event type to listen for.
- handler: EventHandler<NetworkMetricsEventMap[K]>
  A callback to invoke when the event with the given type is dispatched.
- Optionaloptions: SignalOptions
  Options for changing listening behavior.
Returns Unsubscribe
Returns a method, when invoked, removes the handler.
Implementation of NetworkMetricsController.on

Inherited from EventHostImpl.on
- Defined in event/EventHost.ts:99

Class NetworkMetricsControllerImpl

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns NetworkMetricsControllerImpl

Properties

ReadonlylogPrefix

Accessors

[toStringTag]

Returns string

metrics

Returns NetworkMetrics

Methods

addDownlinkTransferEntry

Parameters

Returns void

addMetricsEntry

Parameters

Returns void

dispatch

Type Parameters

Parameters

Returns void

dispose

Returns void

getServiceMetrics

Parameters

Returns ReadonlyDeep<ServiceMetrics>

hasAnyListeners

Returns boolean

hasListeners

Parameters

Returns boolean

on

Type Parameters

Parameters

Returns Unsubscribe

Settings

On This Page

`Readonly`logPrefix