Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ModelEventDownlink<M>

Type parameters

Hierarchy

Index

Properties

Optional consume

consume: boolean

Readonly downlink

downlink: null | EventDownlink

Readonly downlinkConsumers

downlinkConsumers: readonly unknown[]

Readonly downlinkFlags

downlinkFlags: number

Readonly name

name: undefined | string

Readonly ownBody

ownBody: null | Value

Readonly ownHostUri

ownHostUri: null | Uri

Readonly ownLaneUri

ownLaneUri: null | Uri

Readonly ownNodeUri

ownNodeUri: null | Uri

Readonly ownPrio

ownPrio: undefined | number

Readonly ownRate

ownRate: undefined | number

Readonly ownWarp

ownWarp: null | WarpRef

Readonly owner

owner: M

Methods

addDownlinkConsumer

  • addDownlinkConsumer(downlinkConsumer: unknown): void
  • Parameters

    • downlinkConsumer: unknown

    Returns void

bindDownlink

  • Parameters

    Returns EventDownlink

body

  • Returns null | Value

  • Parameters

    Returns ModelEventDownlink<M>

createDownlink

  • Parameters

    Returns EventDownlink

didAddDownlinkConsumer

  • didAddDownlinkConsumer(downlinkConsumer: unknown): void
  • Parameters

    • downlinkConsumer: unknown

    Returns void

didMount

  • didMount(): void
  • Returns void

didRemoveDownlinkConsumer

  • didRemoveDownlinkConsumer(downlinkConsumer: unknown): void
  • Parameters

    • downlinkConsumer: unknown

    Returns void

didStartConsuming

  • didStartConsuming(): void
  • Returns void

didStopConsuming

  • didStopConsuming(): void
  • Returns void

didUnmount

  • didUnmount(): void
  • Returns void

hostUri

  • Returns null | Uri

  • Parameters

    Returns ModelEventDownlink<M>

Optional initBody

  • Returns AnyValue

Optional initDownlink

  • Parameters

    Returns EventDownlink

Optional initHostUri

  • initHostUri(): null | AnyUri
  • Returns null | AnyUri

Optional initLaneUri

  • initLaneUri(): null | AnyUri
  • Returns null | AnyUri

Optional initNodeUri

  • initNodeUri(): null | AnyUri
  • Returns null | AnyUri

Optional initPrio

  • initPrio(): undefined | number
  • Returns undefined | number

Optional initRate

  • initRate(): undefined | number
  • Returns undefined | number

isConsuming

  • isConsuming(): boolean
  • Returns boolean

isMounted

  • isMounted(): boolean
  • Returns boolean

laneUri

  • Returns null | Uri

  • Parameters

    Returns ModelEventDownlink<M>

link

  • link(): void
  • Returns void

mount

  • mount(): void
  • Returns void

nodeUri

  • Returns null | Uri

  • Parameters

    Returns ModelEventDownlink<M>

onAddDownlinkConsumer

  • onAddDownlinkConsumer(downlinkConsumer: unknown): void
  • Parameters

    • downlinkConsumer: unknown

    Returns void

onMount

  • onMount(): void
  • Returns void

onRemoveDownlinkConsumer

  • onRemoveDownlinkConsumer(downlinkConsumer: unknown): void
  • Parameters

    • downlinkConsumer: unknown

    Returns void

onStartConsuming

  • onStartConsuming(): void
  • Returns void

onStopConsuming

  • onStopConsuming(): void
  • Returns void

onUnmount

  • onUnmount(): void
  • Returns void

prio

  • Returns undefined | number

  • Parameters

    • prio: undefined | number

    Returns ModelEventDownlink<M>

rate

  • Returns undefined | number

  • Parameters

    • rate: undefined | number

    Returns ModelEventDownlink<M>

reconcile

  • reconcile(): void
  • Returns void

relink

  • relink(): void
  • Returns void

removeDownlinkConsumer

  • removeDownlinkConsumer(downlinkConsumer: unknown): void
  • Parameters

    • downlinkConsumer: unknown

    Returns void

setDownlinkFlags

  • setDownlinkFlags(downlinkFlags: number): void
  • Parameters

    • downlinkFlags: number

    Returns void

startConsuming

  • startConsuming(): void
  • Returns void

stopConsuming

  • stopConsuming(): void
  • Returns void

unlink

  • unlink(): void
  • Returns void

unmount

  • unmount(): void
  • Returns void

warp

  • Returns null | WarpRef

  • Parameters

    Returns ModelEventDownlink<M>

willAddDownlinkConsumer

  • willAddDownlinkConsumer(downlinkConsumer: unknown): void
  • Parameters

    • downlinkConsumer: unknown

    Returns void

willMount

  • willMount(): void
  • Returns void

willRemoveDownlinkConsumer

  • willRemoveDownlinkConsumer(downlinkConsumer: unknown): void
  • Parameters

    • downlinkConsumer: unknown

    Returns void

willStartConsuming

  • willStartConsuming(): void
  • Returns void

willStopConsuming

  • willStopConsuming(): void
  • Returns void

willUnmount

  • willUnmount(): void
  • Returns void

Generated using TypeDoc