Class WebSocketHost

Hierarchy

RemoteHost
- WebSocketHost

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new WebSocketHost(context: HostContext, hostUri: Uri, options?: WebSocketHostOptions): WebSocketHost

Overrides RemoteHost.constructor
- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/host/WebSocketHost.d.ts:13
Parameters
- context: HostContext
- hostUri: Uri
- Optional options: WebSocketHostOptions
Returns WebSocketHost

Properties

Readonly authenticated

authenticated: boolean

Readonly context

context: HostContext

Readonly downlinkCount

downlinkCount: number

Readonly downlinks

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

Readonly hostUri

hostUri: Uri

idleTimer

idleTimer: number

Readonly options

options: WebSocketHostOptions

reconnectTimeout

reconnectTimeout: number

reconnectTimer

reconnectTimer: number

Readonly sendBuffer

sendBuffer: Envelope[]

Readonly session

session: Value

Readonly socket

socket: null | WebSocket

Readonly uriCache

uriCache: UriCache

Static Readonly IdleTimeout

IdleTimeout: number

Static Readonly MaxReconnectTimeout

MaxReconnectTimeout: number

Static Readonly SendBufferSize

SendBufferSize: number

Static Readonly UnlinkDelay

UnlinkDelay: number

Accessors

WebSocket

get WebSocket(): null | WebSocketConstructor

- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/host/WebSocketHost.d.ts:17
Returns null | WebSocketConstructor

credentials

get credentials(): Value

- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/host/RemoteHost.d.ts:13
Returns Value

idleTimeout

get idleTimeout(): number

- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/host/RemoteHost.d.ts:16
Returns number

maxReconnectTimeout

get maxReconnectTimeout(): number

- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/host/RemoteHost.d.ts:15
Returns number

sendBufferSize

get sendBufferSize(): number

- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/host/RemoteHost.d.ts:17
Returns number

unlinkDelay

get unlinkDelay(): number

- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/host/RemoteHost.d.ts:14
Returns number

Methods

authenticate

authenticate(credentials: AnyValue): void

Inherited from RemoteHost.authenticate
- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/host/RemoteHost.d.ts:29
Parameters
- credentials: AnyValue
Returns void

Protected checkIdle

checkIdle(): void

Inherited from RemoteHost.checkIdle
- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/host/RemoteHost.d.ts:58
Returns void

Protected clearIdle

clearIdle(): void

Inherited from RemoteHost.clearIdle
- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/host/RemoteHost.d.ts:57
Returns void

Protected clearReconnect

clearReconnect(): void

Inherited from RemoteHost.clearReconnect
- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/host/RemoteHost.d.ts:55
Returns void

close

close(): void

Overrides RemoteHost.close
- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/host/WebSocketHost.d.ts:20
Returns void

closeDownlink

closeDownlink(downlink: HostDownlink): void

Inherited from RemoteHost.closeDownlink
- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/host/RemoteHost.d.ts:32
Parameters
- downlink: HostDownlink
Returns void

closeUp

closeUp(): void

Inherited from RemoteHost.closeUp
- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/host/RemoteHost.d.ts:61
Returns void

command

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

Inherited from RemoteHost.command
- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/host/RemoteHost.d.ts:33
Parameters
- nodeUri: AnyUri
- laneUri: AnyUri
- body: AnyValue
Returns void

isAuthenticated

isAuthenticated(): boolean

Inherited from RemoteHost.isAuthenticated
- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/host/RemoteHost.d.ts:20
Returns boolean

isConnected

isConnected(): boolean

Overrides RemoteHost.isConnected
- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/host/WebSocketHost.d.ts:18
Returns boolean

isIdle

isIdle(): boolean

Inherited from RemoteHost.isIdle
- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/host/RemoteHost.d.ts:25
Returns boolean

Protected onAuthRequest

onAuthRequest(request: AuthRequest): void

Inherited from RemoteHost.onAuthRequest
- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/host/RemoteHost.d.ts:43
Parameters
- request: AuthRequest
Returns void

Protected onAuthedResponse

onAuthedResponse(response: AuthedResponse): void

Inherited from RemoteHost.onAuthedResponse
- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/host/RemoteHost.d.ts:44
Parameters
- response: AuthedResponse
Returns void

Protected onCommandMessage

onCommandMessage(message: CommandMessage): void

Inherited from RemoteHost.onCommandMessage
- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/host/RemoteHost.d.ts:36
Parameters
- message: CommandMessage
Returns void

Protected onConnect

onConnect(): void

Inherited from RemoteHost.onConnect
- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/host/RemoteHost.d.ts:51
Returns void

Protected onDeauthRequest

onDeauthRequest(request: DeauthRequest): void

Inherited from RemoteHost.onDeauthRequest
- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/host/RemoteHost.d.ts:45
Parameters
- request: DeauthRequest
Returns void

Protected onDeauthedResponse

onDeauthedResponse(response: DeauthedResponse): void

Inherited from RemoteHost.onDeauthedResponse
- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/host/RemoteHost.d.ts:46
Parameters
- response: DeauthedResponse
Returns void

Protected onDisconnect

onDisconnect(): void

Inherited from RemoteHost.onDisconnect
- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/host/RemoteHost.d.ts:52
Returns void

Protected onEnvelope

onEnvelope(envelope: Envelope): void

Inherited from RemoteHost.onEnvelope
- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/host/RemoteHost.d.ts:34
Parameters
- envelope: Envelope
Returns void

Protected onError

onError(error?: unknown): void

Inherited from RemoteHost.onError
- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/host/RemoteHost.d.ts:53
Parameters
- Optional error: unknown
Returns void

Protected onEventMessage

onEventMessage(message: EventMessage): void

Inherited from RemoteHost.onEventMessage
- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/host/RemoteHost.d.ts:35
Parameters
- message: EventMessage
Returns void

Protected onLinkRequest

onLinkRequest(request: LinkRequest): void

Inherited from RemoteHost.onLinkRequest
- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/host/RemoteHost.d.ts:37
Parameters
- request: LinkRequest
Returns void

Protected onLinkedResponse

onLinkedResponse(response: LinkedResponse): void

Inherited from RemoteHost.onLinkedResponse
- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/host/RemoteHost.d.ts:38
Parameters
- response: LinkedResponse
Returns void

Protected onSyncRequest

onSyncRequest(request: SyncRequest): void

Inherited from RemoteHost.onSyncRequest
- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/host/RemoteHost.d.ts:39
Parameters
- request: SyncRequest
Returns void

Protected onSyncedResponse

onSyncedResponse(response: SyncedResponse): void

Inherited from RemoteHost.onSyncedResponse
- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/host/RemoteHost.d.ts:40
Parameters
- response: SyncedResponse
Returns void

Protected onUnknownEnvelope

onUnknownEnvelope(envelope: string | Envelope): void

Inherited from RemoteHost.onUnknownEnvelope
- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/host/RemoteHost.d.ts:47
Parameters
- envelope: string | Envelope
Returns void

Protected onUnlinkRequest

onUnlinkRequest(request: UnlinkRequest): void

Inherited from RemoteHost.onUnlinkRequest
- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/host/RemoteHost.d.ts:41
Parameters
- request: UnlinkRequest
Returns void

Protected onUnlinkedResponse

onUnlinkedResponse(response: UnlinkedResponse): void

Inherited from RemoteHost.onUnlinkedResponse
- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/host/RemoteHost.d.ts:42
Parameters
- response: UnlinkedResponse
Returns void

Protected onWebSocketClose

onWebSocketClose(): void

- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/host/WebSocketHost.d.ts:24
Returns void

Protected onWebSocketError

onWebSocketError(): void

- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/host/WebSocketHost.d.ts:25
Returns void

Protected onWebSocketMessage

onWebSocketMessage(message: MessageEvent<any>): void

- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/host/WebSocketHost.d.ts:23
Parameters
- message: MessageEvent<any>
Returns void

Protected onWebSocketOpen

onWebSocketOpen(): void

- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/host/WebSocketHost.d.ts:22
Returns void

open

open(): void

Overrides RemoteHost.open
- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/host/WebSocketHost.d.ts:19
Returns void

openDownlink

openDownlink(downlink: HostDownlink): void

Inherited from RemoteHost.openDownlink
- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/host/RemoteHost.d.ts:30
Parameters
- downlink: HostDownlink
Returns void

push

push(envelope: Envelope): void

Overrides RemoteHost.push
- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/host/WebSocketHost.d.ts:21
Parameters
- envelope: Envelope
Returns void

Protected reconnect

reconnect(): void

Inherited from RemoteHost.reconnect
- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/host/RemoteHost.d.ts:54
Returns void

resolve

resolve(relative: AnyUri): Uri

Inherited from RemoteHost.resolve
- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/host/RemoteHost.d.ts:27
Parameters
- relative: AnyUri
Returns Uri

unlinkDownlink

unlinkDownlink(downlink: HostDownlink): void

Inherited from RemoteHost.unlinkDownlink
- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/host/RemoteHost.d.ts:31
Parameters
- downlink: HostDownlink
Returns void

unresolve

unresolve(absolute: AnyUri): Uri

Inherited from RemoteHost.unresolve
- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/host/RemoteHost.d.ts:28
Parameters
- absolute: AnyUri
Returns Uri

Protected watchIdle

watchIdle(): void

Inherited from RemoteHost.watchIdle
- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/host/RemoteHost.d.ts:56
Returns void

Generated using TypeDoc