Welshman Docs / @welshman/app / RelayStats

Class: RelayStats

Defined in: app/src/plugins/relayStats.ts:59

Per-relay connection statistics, keyed by url, plus the getQuality heuristic the router uses to rank relays. A pure store — the socket wiring that fills it lives in appPolicyRelayStats.

Extends

• MapPlugin<RelayStatsItem>

Constructors

Constructor

new RelayStats(app): RelayStats

Defined in: app/src/plugins/base.ts:105

Parameters

app

IApp

Returns

RelayStats

Inherited from

MapPlugin.constructor

Properties

all

all: Projection<RelayStatsItem[]>

Defined in: app/src/plugins/base.ts:101

Inherited from

MapPlugin.all

---

app

protected readonly app: IApp

Defined in: app/src/plugins/base.ts:105

Inherited from

MapPlugin.app

---

index

index: Projection<ItemsByKey<RelayStatsItem>>

Defined in: app/src/plugins/base.ts:100

Inherited from

MapPlugin.index

---

one()

one: (key?, ...args) => Readable<Maybe<RelayStatsItem>>

Defined in: app/src/plugins/base.ts:102

Parameters

key?

string

args?

...any[]

Returns

Readable<Maybe<RelayStatsItem>>

Inherited from

MapPlugin.one

---

store

protected store: Writable<Map<string, RelayStatsItem>>

Defined in: app/src/plugins/base.ts:99

Inherited from

MapPlugin.store

---

subs

subs: (key, value) => void[] = []

Defined in: app/src/plugins/base.ts:103

Parameters

key

string

value

Maybe<RelayStatsItem>

Returns

void

Inherited from

MapPlugin.subs

Methods

clear()

clear(): void

Defined in: app/src/plugins/base.ts:136

Returns

void

Inherited from

MapPlugin.clear

---

delete()

delete(key): void

Defined in: app/src/plugins/base.ts:126

Parameters

key

string

Returns

void

Inherited from

MapPlugin.delete

---

emitItem()

protected emitItem(key, value): void

Defined in: app/src/plugins/base.ts:156

Parameters

key

string

value

Maybe<RelayStatsItem>

Returns

void

Inherited from

MapPlugin.emitItem

---

get()

get(key): undefined | RelayStatsItem

Defined in: app/src/plugins/base.ts:111

Parameters

key

string

Returns

undefined | RelayStatsItem

Inherited from

MapPlugin.get

---

getQuality()

getQuality(url): 0 | 0.7 | 0.8 | 0.9 | 1

Defined in: app/src/plugins/relayStats.ts:60

Parameters

url

string

Returns

0 | 0.7 | 0.8 | 0.9 | 1

---

monitorSocket()

monitorSocket(socket): () => void

Defined in: app/src/plugins/relayStats.ts:196

Parameters

socket

Socket

Returns

(): void

Returns

void

---

onItem()

onItem(subscriber): Unsubscriber

Defined in: app/src/plugins/base.ts:146

Parameters

subscriber

(key, value) => void

Returns

Unsubscriber

Inherited from

MapPlugin.onItem

---

project()

project<U>(key, read): Projection<U>

Defined in: app/src/plugins/base.ts:113

Type Parameters

U

U

Parameters

key

string

read

(item) => U

Returns

Projection<U>

Inherited from

MapPlugin.project

---

set()

set(key, value): void

Defined in: app/src/plugins/base.ts:116

Parameters

key

string

value

RelayStatsItem

Returns

void

Inherited from

MapPlugin.set