PeerAddressBook
Extends:
Constructor Summary
Public Constructor | ||
public |
constructor(netconfig: NetworkConfig) |
Member Summary
Public Members | ||
public get |
knownAddressesCount: number |
|
public get |
knownRtcAddressesCount: number |
|
public get |
knownWsAddressesCount: number |
|
public get |
knownWssAddressesCount: number |
|
public get |
seeded: boolean |
Method Summary
Public Methods | ||
public |
add(channel: PeerChannel, arg: PeerAddress | Array<PeerAddress>) |
|
public |
close(channel: PeerChannel, peerAddress: PeerAddress, type: number): void Called when a connection to this peerAddress is closed. |
|
public |
established(channel: PeerChannel, peerAddress: PeerAddress | RtcPeerAddress): void Called when a connection to this peerAddress has been established. |
|
public |
get(peerAddress: PeerAddress): PeerAddress |
|
public |
getByPeerId(peerId: PeerId): PeerAddress |
|
public |
getChannelByPeerId(peerId: PeerId): PeerChannel |
|
public |
getState(peerAddress: PeerAddress): PeerAddressState |
|
public |
isBanned(peerAddress: PeerAddress): boolean |
|
public |
iterator(): Iterator<PeerAddressState> |
|
public |
query(protocolMask: number, serviceMask: number, maxAddresses: number): Array<PeerAddress> |
|
public |
rtcIterator(): Iterator<PeerAddressState> |
|
public |
unroutable(channel: PeerChannel, peerAddress: PeerAddress): void Called when a message has been returned as unroutable. |
|
public |
wsIterator(): Iterator<PeerAddressState> |
|
public |
wssIterator(): Iterator<PeerAddressState> |
Inherited Summary
From class Observable | ||
public static get |
WILDCARD: string: string |
|
public |
bubble(observable: Observable, types: ...string) |
|
public |
fire(type: string, args: ...*): Promise |
|
public |
off(type: string, id: number) |
|
public |
on(type: string, callback: Function): number |
Public Constructors
public constructor(netconfig: NetworkConfig) source
Override:
Observable#constructorParams:
Name | Type | Attribute | Description |
netconfig | NetworkConfig |
Public Members
public get knownAddressesCount: number source
public get knownRtcAddressesCount: number source
public get knownWsAddressesCount: number source
public get knownWssAddressesCount: number source
public get seeded: boolean source
Public Methods
public add(channel: PeerChannel, arg: PeerAddress | Array<PeerAddress>) source
Params:
Name | Type | Attribute | Description |
channel | PeerChannel | ||
arg | PeerAddress | Array<PeerAddress> |
public close(channel: PeerChannel, peerAddress: PeerAddress, type: number): void source
Called when a connection to this peerAddress is closed.
Params:
Name | Type | Attribute | Description |
channel | PeerChannel | ||
peerAddress | PeerAddress | ||
type | number |
|
Return:
void |
public established(channel: PeerChannel, peerAddress: PeerAddress | RtcPeerAddress): void source
Called when a connection to this peerAddress has been established. The connection might have been initiated by the other peer, so address may not be known previously. If it is already known, it has been updated by a previous version message.
Params:
Name | Type | Attribute | Description |
channel | PeerChannel | ||
peerAddress | PeerAddress | RtcPeerAddress |
Return:
void |
public get(peerAddress: PeerAddress): PeerAddress source
Params:
Name | Type | Attribute | Description |
peerAddress | PeerAddress |
public getByPeerId(peerId: PeerId): PeerAddress source
Params:
Name | Type | Attribute | Description |
peerId | PeerId |
public getChannelByPeerId(peerId: PeerId): PeerChannel source
Params:
Name | Type | Attribute | Description |
peerId | PeerId |
public getState(peerAddress: PeerAddress): PeerAddressState source
Params:
Name | Type | Attribute | Description |
peerAddress | PeerAddress |
public isBanned(peerAddress: PeerAddress): boolean source
Params:
Name | Type | Attribute | Description |
peerAddress | PeerAddress |
Return:
boolean |
public query(protocolMask: number, serviceMask: number, maxAddresses: number): Array<PeerAddress> source
Params:
Name | Type | Attribute | Description |
protocolMask | number | ||
serviceMask | number | ||
maxAddresses | number |
public unroutable(channel: PeerChannel, peerAddress: PeerAddress): void source
Called when a message has been returned as unroutable.
Params:
Name | Type | Attribute | Description |
channel | PeerChannel | ||
peerAddress | PeerAddress |
Return:
void |