Class MapDownlinkModel

Hierarchy

DownlinkModel
- MapDownlinkModel

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new MapDownlinkModel(context: DownlinkContext, hostUri: Uri, nodeUri: Uri, laneUri: Uri, prio?: number, rate?: number, body?: Value, state?: BTree<Value, Value, never>): MapDownlinkModel

Overrides DownlinkModel.constructor
- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/MapDownlinkModel.d.ts:11
Parameters
- context: DownlinkContext
- hostUri: Uri
- nodeUri: Uri
- laneUri: Uri
- Optional prio: number
- Optional rate: number
- Optional body: Value
- Optional state: BTree<Value, Value, never>
Returns MapDownlinkModel

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: BTree<Value, Value, never>

Readonly status

status: number

Readonly views

views: readonly MapDownlink<unknown, unknown, never, 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

size

get size(): number

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

type

get type(): DownlinkType

- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/MapDownlinkModel.d.ts:15
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

clear

clear(): void

- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/MapDownlinkModel.d.ts:25
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

delete

delete(key: Value): boolean

- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/MapDownlinkModel.d.ts:22
Parameters
- key: Value
Returns boolean

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

drop

drop(lower: number): MapDownlinkModel

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

entries

entries(): Cursor<[Value, Value]>

- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/MapDownlinkModel.d.ts:30
Returns Cursor<[Value, Value]>

forEach

forEach<T>(callback: (key: Value, value: Value) => void | T): undefined | T
forEach<T, S>(callback: (key: Value, value: Value) => void | T, thisArg: S): undefined | T

- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/MapDownlinkModel.d.ts:26
Type parameters
- T
Parameters
- callback: (key: Value, value: Value) => void | T
  - - (key: Value, value: Value): void | T
    - Parameters
      - key: Value
      - value: Value
      Returns void | T
Returns undefined | T
- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/MapDownlinkModel.d.ts:27
Type parameters
- T
- S
Parameters
- callback: (key: Value, value: Value) => void | T
  - - (key: Value, value: Value): void | T
    - Parameters
      - key: Value
      - value: Value
      Returns void | T
- thisArg: S
Returns undefined | T

get

get(key: Value): Value

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

getEntry

getEntry(index: number): undefined | [Value, Value]

- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/MapDownlinkModel.d.ts:20
Parameters
- index: number
Returns undefined | [Value, Value]

has

has(key: Value): boolean

- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/MapDownlinkModel.d.ts:18
Parameters
- key: Value
Returns boolean

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

isEmpty

isEmpty(): boolean

- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/MapDownlinkModel.d.ts:17
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

keys

keys(): Cursor<Value>

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

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

Protected mapDidClear

mapDidClear(): void

- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/MapDownlinkModel.d.ts:48
Returns void

Protected mapDidDrop

mapDidDrop(lower: number): void

- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/MapDownlinkModel.d.ts:44
Parameters
- lower: number
Returns void

Protected mapDidRemove

mapDidRemove(key: Value, oldValue: Value): void

- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/MapDownlinkModel.d.ts:42
Parameters
- key: Value
- oldValue: Value
Returns void

Protected mapDidTake

mapDidTake(upper: number): void

- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/MapDownlinkModel.d.ts:46
Parameters
- upper: number
Returns void

Protected mapDidUpdate

mapDidUpdate(key: Value, newValue: Value, oldValue: Value): void

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

Protected mapWillClear

mapWillClear(): void

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

Protected mapWillDrop

mapWillDrop(lower: number): void

- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/MapDownlinkModel.d.ts:43
Parameters
- lower: number
Returns void

Protected mapWillRemove

mapWillRemove(key: Value): void

- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/MapDownlinkModel.d.ts:41
Parameters
- key: Value
Returns void

Protected mapWillTake

mapWillTake(upper: number): void

- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/MapDownlinkModel.d.ts:45
Parameters
- upper: number
Returns void

Protected mapWillUpdate

mapWillUpdate(key: Value, newValue: Value): Value

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

Protected onClearEvent

onClearEvent(): void

- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/MapDownlinkModel.d.ts:38
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

Protected onDropEvent

onDropEvent(lower: number): void

- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/MapDownlinkModel.d.ts:36
Parameters
- lower: number
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/MapDownlinkModel.d.ts:33
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 onRemoveEvent

onRemoveEvent(key: Value): void

- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/MapDownlinkModel.d.ts:35
Parameters
- key: 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

Protected onTakeEvent

onTakeEvent(upper: number): void

- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/MapDownlinkModel.d.ts:37
Parameters
- upper: number
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

Protected onUpdateEvent

onUpdateEvent(key: Value, newValue: Value): void

- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/MapDownlinkModel.d.ts:34
Parameters
- key: Value
- newValue: Value
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(key: Value, newValue: Value): MapDownlinkModel

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

setState

setState(state: BTree<Value, Value, never>): void

- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/MapDownlinkModel.d.ts:32
Parameters
- state: BTree<Value, Value, never>
Returns void

snapshot

snapshot(): BTree<Value, Value, never>

- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/MapDownlinkModel.d.ts:31
Returns BTree<Value, Value, never>

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

take

take(upper: number): MapDownlinkModel

- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/MapDownlinkModel.d.ts:24
Parameters
- upper: number
Returns MapDownlinkModel

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

values

values(): Cursor<Value>

- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/MapDownlinkModel.d.ts:29
Returns Cursor<Value>

Generated using TypeDoc