WarpClient | Swim Toolkit

Hierarchy

WarpClient

Implements

Index

Constructors

constructor

Properties

Constructors

constructor

new WarpClient(options?: WarpClientOptions): WarpClient

- Defined in swim-runtime-js/swim-host-js/@swim/client/lib/main/client/WarpClient.d.ts:22
Parameters
- Optional options: WarpClientOptions
Returns WarpClient

Properties

Readonly downlinkCount

downlinkCount: number

Readonly downlinks

downlinks: BTree<Uri, BTree<Uri, BTree<Uri, DownlinkModel, never>, never>, never>

Readonly hosts

hosts: BTree<Uri, Host, never>

Readonly observers

observers: readonly WarpObserver[]

Readonly online

online: boolean

Readonly options

options: WarpClientOptions

Readonly refs

refs: BaseRef[]

Methods

authenticate

authenticate(hostUri: AnyUri, credentials: AnyValue): void

Implementation of RefContext.authenticate
- Defined in swim-runtime-js/swim-host-js/@swim/client/lib/main/client/WarpClient.d.ts:58
Parameters
- hostUri: AnyUri
- credentials: AnyValue
Returns void

close

close(): void

- Defined in swim-runtime-js/swim-host-js/@swim/client/lib/main/client/WarpClient.d.ts:61
Returns void

closeDownlink

closeDownlink(downlink: DownlinkModel): void

Implementation of RefContext.closeDownlink
- Defined in swim-runtime-js/swim-host-js/@swim/client/lib/main/client/WarpClient.d.ts:43
Parameters
- downlink: DownlinkModel
Returns void

closeHost

closeHost(host: Host): void

Implementation of HostContext.closeHost
- Defined in swim-runtime-js/swim-host-js/@swim/client/lib/main/client/WarpClient.d.ts:39
Parameters
- host: Host
Returns void

closeRef

closeRef(ref: BaseRef): void

Implementation of RefContext.closeRef
- Defined in swim-runtime-js/swim-host-js/@swim/client/lib/main/client/WarpClient.d.ts:52
Parameters
- ref: BaseRef
Returns void

command

command(hostUri: AnyUri, nodeUri: AnyUri, laneUri: AnyUri, body: AnyValue): void
command(nodeUri: AnyUri, laneUri: AnyUri, body: AnyValue): void

Implementation of RefContext.command
- Defined in swim-runtime-js/swim-host-js/@swim/client/lib/main/client/WarpClient.d.ts:59
Parameters
- hostUri: AnyUri
- nodeUri: AnyUri
- laneUri: AnyUri
- body: AnyValue
Returns void
Implementation of RefContext.command
- Defined in swim-runtime-js/swim-host-js/@swim/client/lib/main/client/WarpClient.d.ts:60
Parameters
- nodeUri: AnyUri
- laneUri: AnyUri
- body: AnyValue
Returns void

didAuthenticate

didAuthenticate(didAuthenticate: WarpDidAuthenticate): WarpClient

Implementation of WarpRef.didAuthenticate
- Defined in swim-runtime-js/swim-host-js/@swim/client/lib/main/client/WarpClient.d.ts:65
Parameters
- didAuthenticate: WarpDidAuthenticate
Returns WarpClient

didConnect

didConnect(didConnect: WarpDidConnect): WarpClient

Implementation of WarpRef.didConnect
- Defined in swim-runtime-js/swim-host-js/@swim/client/lib/main/client/WarpClient.d.ts:64
Parameters
- didConnect: WarpDidConnect
Returns WarpClient

didDeauthenticate

didDeauthenticate(didDeauthenticate: WarpDidDeauthenticate): WarpClient

Implementation of WarpRef.didDeauthenticate
- Defined in swim-runtime-js/swim-host-js/@swim/client/lib/main/client/WarpClient.d.ts:66
Parameters
- didDeauthenticate: WarpDidDeauthenticate
Returns WarpClient

didDisconnect

didDisconnect(didDisconnect: WarpDidDisconnect): WarpClient

Implementation of WarpRef.didDisconnect
- Defined in swim-runtime-js/swim-host-js/@swim/client/lib/main/client/WarpClient.d.ts:67
Parameters
- didDisconnect: WarpDidDisconnect
Returns WarpClient

didFail

didFail(didFail: WarpDidFail): WarpClient

Implementation of WarpRef.didFail
- Defined in swim-runtime-js/swim-host-js/@swim/client/lib/main/client/WarpClient.d.ts:68
Parameters
- didFail: WarpDidFail
Returns WarpClient

downlink

downlink(init?: EventDownlinkInit): EventDownlink

Implementation of WarpRef.downlink
- Defined in swim-runtime-js/swim-host-js/@swim/client/lib/main/client/WarpClient.d.ts:44
Parameters
- Optional init: EventDownlinkInit
Returns EventDownlink

downlinkList

downlinkList(init?: ListDownlinkInit<Value, AnyValue>): ListDownlink<Value, AnyValue>
downlinkList<V, VU>(init?: ListDownlinkInit<V, VU>): ListDownlink<V, VU>

Implementation of WarpRef.downlinkList
- Defined in swim-runtime-js/swim-host-js/@swim/client/lib/main/client/WarpClient.d.ts:45
Parameters
- Optional init: ListDownlinkInit<Value, AnyValue>
Returns ListDownlink<Value, AnyValue>
Implementation of WarpRef.downlinkList
- Defined in swim-runtime-js/swim-host-js/@swim/client/lib/main/client/WarpClient.d.ts:46
Type parameters
- V
- VU = never
Parameters
- Optional init: ListDownlinkInit<V, VU>
Returns ListDownlink<V, VU>

downlinkMap

downlinkMap(init?: MapDownlinkInit<Value, Value, AnyValue, AnyValue>): MapDownlink<Value, Value, AnyValue, AnyValue>
downlinkMap<K, V, KU, VU>(init?: MapDownlinkInit<K, V, KU, VU>): MapDownlink<K, V, KU, VU>

Implementation of WarpRef.downlinkMap
- Defined in swim-runtime-js/swim-host-js/@swim/client/lib/main/client/WarpClient.d.ts:47
Parameters
- Optional init: MapDownlinkInit<Value, Value, AnyValue, AnyValue>
Returns MapDownlink<Value, Value, AnyValue, AnyValue>
Implementation of WarpRef.downlinkMap
- Defined in swim-runtime-js/swim-host-js/@swim/client/lib/main/client/WarpClient.d.ts:48
Type parameters
- K
- V
- KU = never
- VU = never
Parameters
- Optional init: MapDownlinkInit<K, V, KU, VU>
Returns MapDownlink<K, V, KU, VU>

downlinkValue

downlinkValue(init?: ValueDownlinkInit<Value, AnyValue>): ValueDownlink<Value, AnyValue>
downlinkValue<V, VU>(init?: ValueDownlinkInit<V, VU>): ValueDownlink<V, VU>

Implementation of WarpRef.downlinkValue
- Defined in swim-runtime-js/swim-host-js/@swim/client/lib/main/client/WarpClient.d.ts:49
Parameters
- Optional init: ValueDownlinkInit<Value, AnyValue>
Returns ValueDownlink<Value, AnyValue>
Implementation of WarpRef.downlinkValue
- Defined in swim-runtime-js/swim-host-js/@swim/client/lib/main/client/WarpClient.d.ts:50
Type parameters
- V
- VU = never
Parameters
- Optional init: ValueDownlinkInit<V, VU>
Returns ValueDownlink<V, VU>

getDownlink

getDownlink(hostUri: Uri, nodeUri: Uri, laneUri: Uri): undefined | DownlinkModel

Implementation of RefContext.getDownlink
- Defined in swim-runtime-js/swim-host-js/@swim/client/lib/main/client/WarpClient.d.ts:40
Parameters
- hostUri: Uri
- nodeUri: Uri
- laneUri: Uri
Returns undefined | DownlinkModel

getHost

getHost(hostUri: AnyUri): undefined | Host

- Defined in swim-runtime-js/swim-host-js/@swim/client/lib/main/client/WarpClient.d.ts:37
Parameters
- hostUri: AnyUri
Returns undefined | Host

hostDidAuthenticate

hostDidAuthenticate(body: Value, host: Host): void

Implementation of HostContext.hostDidAuthenticate
- Defined in swim-runtime-js/swim-host-js/@swim/client/lib/main/client/WarpClient.d.ts:70
Parameters
- body: Value
- host: Host
Returns void

hostDidConnect

hostDidConnect(host: Host): void

Implementation of HostContext.hostDidConnect
- Defined in swim-runtime-js/swim-host-js/@swim/client/lib/main/client/WarpClient.d.ts:69
Parameters
- host: Host
Returns void

hostDidDeauthenticate

hostDidDeauthenticate(body: Value, host: Host): void

Implementation of HostContext.hostDidDeauthenticate
- Defined in swim-runtime-js/swim-host-js/@swim/client/lib/main/client/WarpClient.d.ts:71
Parameters
- body: Value
- host: Host
Returns void

hostDidDisconnect

hostDidDisconnect(host: Host): void

Implementation of HostContext.hostDidDisconnect
- Defined in swim-runtime-js/swim-host-js/@swim/client/lib/main/client/WarpClient.d.ts:72
Parameters
- host: Host
Returns void

hostDidFail

hostDidFail(error: unknown, host: Host): void

Implementation of HostContext.hostDidFail
- Defined in swim-runtime-js/swim-host-js/@swim/client/lib/main/client/WarpClient.d.ts:73
Parameters
- error: unknown
- host: Host
Returns void

hostRef

hostRef(hostUri: AnyUri): HostRef

Implementation of WarpRef.hostRef
- Defined in swim-runtime-js/swim-host-js/@swim/client/lib/main/client/WarpClient.d.ts:53
Parameters
- hostUri: AnyUri
Returns HostRef

isOnline

isOnline(): boolean
isOnline(online: boolean): WarpClient

Implementation of HostContext.isOnline
- Defined in swim-runtime-js/swim-host-js/@swim/client/lib/main/client/WarpClient.d.ts:30
Returns boolean
Implementation of HostContext.isOnline
- Defined in swim-runtime-js/swim-host-js/@swim/client/lib/main/client/WarpClient.d.ts:31
Parameters
- online: boolean
Returns WarpClient

keepOnline

keepOnline(): boolean
keepOnline(keepOnline: boolean): WarpClient

- Defined in swim-runtime-js/swim-host-js/@swim/client/lib/main/client/WarpClient.d.ts:32
Returns boolean
- Defined in swim-runtime-js/swim-host-js/@swim/client/lib/main/client/WarpClient.d.ts:33
Parameters
- keepOnline: boolean
Returns WarpClient

laneRef

laneRef(hostUri: AnyUri, nodeUri: AnyUri, laneUri: AnyUri): LaneRef
laneRef(nodeUri: AnyUri, laneUri: AnyUri): LaneRef

Implementation of WarpRef.laneRef
- Defined in swim-runtime-js/swim-host-js/@swim/client/lib/main/client/WarpClient.d.ts:56
Parameters
- hostUri: AnyUri
- nodeUri: AnyUri
- laneUri: AnyUri
Returns LaneRef
Implementation of WarpRef.laneRef
- Defined in swim-runtime-js/swim-host-js/@swim/client/lib/main/client/WarpClient.d.ts:57
Parameters
- nodeUri: AnyUri
- laneUri: AnyUri
Returns LaneRef

nodeRef

nodeRef(hostUri: AnyUri, nodeUri: AnyUri): NodeRef
nodeRef(nodeUri: AnyUri): NodeRef

Implementation of WarpRef.nodeRef
- Defined in swim-runtime-js/swim-host-js/@swim/client/lib/main/client/WarpClient.d.ts:54
Parameters
- hostUri: AnyUri
- nodeUri: AnyUri
Returns NodeRef
Implementation of WarpRef.nodeRef
- Defined in swim-runtime-js/swim-host-js/@swim/client/lib/main/client/WarpClient.d.ts:55
Parameters
- nodeUri: AnyUri
Returns NodeRef

observe

observe(observer: WarpObserver): WarpClient

Implementation of WarpRef.observe
- Defined in swim-runtime-js/swim-host-js/@swim/client/lib/main/client/WarpClient.d.ts:62
Parameters
- observer: WarpObserver
Returns WarpClient

Protected onOffline

onOffline(event: Event): void

- Defined in swim-runtime-js/swim-host-js/@swim/client/lib/main/client/WarpClient.d.ts:36
Parameters
- event: Event
Returns void

Protected onOnline

onOnline(event: Event): void

- Defined in swim-runtime-js/swim-host-js/@swim/client/lib/main/client/WarpClient.d.ts:35
Parameters
- event: Event
Returns void

openDownlink

openDownlink(downlink: DownlinkModel): void

Implementation of RefContext.openDownlink
- Defined in swim-runtime-js/swim-host-js/@swim/client/lib/main/client/WarpClient.d.ts:41
Parameters
- downlink: DownlinkModel
Returns void

openHost

openHost(hostUri: AnyUri): Host

- Defined in swim-runtime-js/swim-host-js/@swim/client/lib/main/client/WarpClient.d.ts:38
Parameters
- hostUri: AnyUri
Returns Host

openRef

openRef(ref: BaseRef): void

Implementation of RefContext.openRef
- Defined in swim-runtime-js/swim-host-js/@swim/client/lib/main/client/WarpClient.d.ts:51
Parameters
- ref: BaseRef
Returns void

unlinkDownlink

unlinkDownlink(downlink: DownlinkModel): void

Implementation of RefContext.unlinkDownlink
- Defined in swim-runtime-js/swim-host-js/@swim/client/lib/main/client/WarpClient.d.ts:42
Parameters
- downlink: DownlinkModel
Returns void

unobserve

unobserve(observer: unknown): WarpClient

Implementation of WarpRef.unobserve
- Defined in swim-runtime-js/swim-host-js/@swim/client/lib/main/client/WarpClient.d.ts:63
Parameters
- observer: unknown
Returns WarpClient

Protected watchOnline

watchOnline(keepOnline: boolean): void

- Defined in swim-runtime-js/swim-host-js/@swim/client/lib/main/client/WarpClient.d.ts:34
Parameters
- keepOnline: boolean
Returns void

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional options: WarpClientOptions

Returns WarpClient

Properties

Readonly downlinkCount

Readonly downlinks

Readonly hosts

Readonly observers

Readonly online

Readonly options

Readonly refs

Methods

authenticate

Parameters

hostUri: AnyUri

credentials: AnyValue

Returns void

close

Returns void

closeDownlink

Parameters

downlink: DownlinkModel

Returns void

closeHost

Parameters

host: Host

Returns void

closeRef

Parameters

ref: BaseRef

Returns void

command

Parameters

hostUri: AnyUri

nodeUri: AnyUri

laneUri: AnyUri

body: AnyValue

Returns void

Parameters

nodeUri: AnyUri

laneUri: AnyUri

body: AnyValue

Returns void

didAuthenticate

Parameters

didAuthenticate: WarpDidAuthenticate

Returns WarpClient

didConnect

Parameters

didConnect: WarpDidConnect

Returns WarpClient

didDeauthenticate

Parameters

didDeauthenticate: WarpDidDeauthenticate

Returns WarpClient

didDisconnect

Parameters

didDisconnect: WarpDidDisconnect

Returns WarpClient

didFail

Parameters

didFail: WarpDidFail

Returns WarpClient

downlink

Parameters

Optional init: EventDownlinkInit

Returns EventDownlink

downlinkList

Parameters

Optional init: ListDownlinkInit<Value, AnyValue>

Returns ListDownlink<Value, AnyValue>

Type parameters