Class ValueDownlinkModel

Hierarchy

DownlinkModel
- ValueDownlinkModel

Index

Constructors

constructor

Properties

Accessors

Constructors

constructor

new ValueDownlinkModel(context: DownlinkContext, hostUri: Uri, nodeUri: Uri, laneUri: Uri, prio?: number, rate?: number, body?: Value, state?: Value): ValueDownlinkModel

Overrides DownlinkModel.constructor
- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/ValueDownlinkModel.d.ts:9
Parameters
- context: DownlinkContext
- hostUri: Uri
- nodeUri: Uri
- laneUri: Uri
- Optional prio: number
- Optional rate: number
- Optional body: Value
- Optional state: Value
Returns ValueDownlinkModel

Properties

Readonly body

body: Value

Readonly context

context: DownlinkContext

Readonly host

host: null | Host

Readonly hostUri

hostUri: Uri

Readonly laneUri

laneUri: Uri

Readonly nodeUri

nodeUri: Uri

Readonly prio

prio: number

Readonly rate

rate: number

Readonly state

state: Value

Readonly status

status: number

Readonly views

views: readonly ValueDownlink<unknown, never>[]

Static Readonly Linked

Linked: number

Static Readonly Linking

Linking: number

Static Readonly Synced

Synced: number

Static Readonly Syncing

Syncing: number

Static Readonly Unlinking

Unlinking: number

Accessors

session

get session(): Value

- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/DownlinkModel.d.ts:28
Returns Value

type

get type(): DownlinkType

- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/ValueDownlinkModel.d.ts:13
Returns DownlinkType

unlinkDelay

get unlinkDelay(): number

- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/DownlinkModel.d.ts:23
Returns number

Methods

addDownlink

addDownlink(view: Downlink): void

Inherited from DownlinkModel.addDownlink
- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/DownlinkModel.d.ts:29
Parameters
- view: Downlink
Returns void

close

close(): void

Inherited from DownlinkModel.close
- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/DownlinkModel.d.ts:47
Returns void

closeUp

closeUp(): void

Inherited from DownlinkModel.closeUp
- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/DownlinkModel.d.ts:49
Returns void

command

command(body: AnyValue): void

Inherited from DownlinkModel.command
- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/DownlinkModel.d.ts:42
Parameters
- body: AnyValue
Returns void

Protected doUnlink

doUnlink(): void

Inherited from DownlinkModel.doUnlink
- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/DownlinkModel.d.ts:46
Returns void

get

get(): Value

- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/ValueDownlinkModel.d.ts:14
Returns Value

hostDidConnect

hostDidConnect(host: Host): void

Inherited from DownlinkModel.hostDidConnect
- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/DownlinkModel.d.ts:39
Parameters
- host: Host
Returns void

hostDidDisconnect

hostDidDisconnect(host: Host): void

Inherited from DownlinkModel.hostDidDisconnect
- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/DownlinkModel.d.ts:40
Parameters
- host: Host
Returns void

hostDidFail

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

Inherited from DownlinkModel.hostDidFail
- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/DownlinkModel.d.ts:41
Parameters
- error: unknown
- host: Host
Returns void

isAuthenticated

isAuthenticated(): boolean

Inherited from DownlinkModel.isAuthenticated
- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/DownlinkModel.d.ts:25
Returns boolean

isConnected

isConnected(): boolean

Inherited from DownlinkModel.isConnected
- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/DownlinkModel.d.ts:24
Returns boolean

isLinked

isLinked(): boolean

Inherited from DownlinkModel.isLinked
- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/DownlinkModel.d.ts:26
Returns boolean

isSynced

isSynced(): boolean

Inherited from DownlinkModel.isSynced
- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/DownlinkModel.d.ts:27
Returns boolean

keepLinked

keepLinked(): boolean

Inherited from DownlinkModel.keepLinked
- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/DownlinkModel.d.ts:21
Returns boolean

keepSynced

keepSynced(): boolean

Inherited from DownlinkModel.keepSynced
- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/DownlinkModel.d.ts:22
Returns boolean

link

link(): void

Inherited from DownlinkModel.link
- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/DownlinkModel.d.ts:44
Returns void

onCommandMessage

onCommandMessage(body: Value): void

Inherited from DownlinkModel.onCommandMessage
- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/DownlinkModel.d.ts:32
Parameters
- body: Value
Returns void

onEventMessage

onEventMessage(message: EventMessage, host: Host): void

Overrides DownlinkModel.onEventMessage
- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/ValueDownlinkModel.d.ts:17
Parameters
- message: EventMessage
- host: Host
Returns void

onLinkRequest

onLinkRequest(request: LinkRequest): void

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

onLinkedResponse

onLinkedResponse(response: LinkedResponse, host: Host): void

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

Protected onSetEvent

onSetEvent(newValue: Value): void

- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/ValueDownlinkModel.d.ts:18
Parameters
- newValue: Value
Returns void

onSyncRequest

onSyncRequest(request: SyncRequest): void

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

onSyncedResponse

onSyncedResponse(response: SyncedResponse, host: Host): void

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

onUnlinkRequest

onUnlinkRequest(request: UnlinkRequest, host: Host): void

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

onUnlinkedResponse

onUnlinkedResponse(response: UnlinkedResponse, host: Host): void

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

openUp

openUp(host: Host): void

Inherited from DownlinkModel.openUp
- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/DownlinkModel.d.ts:48
Parameters
- host: Host
Returns void

removeDownlink

removeDownlink(view: Downlink): void

Inherited from DownlinkModel.removeDownlink
- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/DownlinkModel.d.ts:30
Parameters
- view: Downlink
Returns void

set

set(newValue: Value): void

- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/ValueDownlinkModel.d.ts:15
Parameters
- newValue: Value
Returns void

setState

setState(state: Value): void

- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/ValueDownlinkModel.d.ts:16
Parameters
- state: Value
Returns void

sync

sync(): void

Inherited from DownlinkModel.sync
- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/DownlinkModel.d.ts:43
Returns void

unlink

unlink(): void

Inherited from DownlinkModel.unlink
- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/DownlinkModel.d.ts:45
Returns void

Protected valueDidSet

valueDidSet(newValue: Value, oldValue: Value): void

- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/ValueDownlinkModel.d.ts:20
Parameters
- newValue: Value
- oldValue: Value
Returns void

Protected valueWillSet

valueWillSet(newValue: Value): Value

- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/ValueDownlinkModel.d.ts:19
Parameters
- newValue: Value
Returns Value

Generated using TypeDoc