Dex-1 ▶ Dex ▶ Channel

constructor

• new Channel(): Dex.Channel

  Returns Dex.Channel

Static$gtype

_init

• _init(...args: any[]): void

  Parameters

  • ...args: any[]

  Returns void

can_receive

• can_receive(): boolean

  Returns boolean

can_send

• can_send(): boolean

  Returns boolean

close_receive

• close_receive(): void

  Returns void

close_send

• close_send(): void

  Returns void

Signalconnect

• connect<K extends "notify">(
      signal: K,
      callback: SignalCallback<Dex.Channel, Dex.Channel.SignalSignatures[K]>,
  ): number

  Type Parameters

  • K extends "notify"

  Parameters

  • signal: K
  • callback: SignalCallback<Dex.Channel, Dex.Channel.SignalSignatures[K]>

  Returns number

• connect(signal: string, callback: (...args: any[]) => any): number

  Parameters

  • signal: string
  • callback: (...args: any[]) => any

  Returns number

Signalconnect_after

• connect_after<K extends "notify">(
      signal: K,
      callback: SignalCallback<Dex.Channel, Dex.Channel.SignalSignatures[K]>,
  ): number

  Type Parameters

  • K extends "notify"

  Parameters

  • signal: K
  • callback: SignalCallback<Dex.Channel, Dex.Channel.SignalSignatures[K]>

  Returns number

• connect_after(signal: string, callback: (...args: any[]) => any): number

  Parameters

  • signal: string
  • callback: (...args: any[]) => any

  Returns number

Signalemit

• emit<K extends "notify">(
      signal: K,
      ...args: GjsParameters<Dex.Channel.SignalSignatures[K]> extends [
          any,
          ...Q[],
      ]
          ? Q
          : never,
  ): void

  Type Parameters

  • K extends "notify"

  Parameters

  • signal: K
  • ...args: GjsParameters<Dex.Channel.SignalSignatures[K]> extends [any, ...Q[]] ? Q : never

  Returns void

• emit(signal: string, ...args: any[]): void

  Parameters

  • signal: string
  • ...args: any[]

  Returns void

receive

• receive(): Dex.Future

  Receives the next item from the channel.

  The resulting future will resolve or reject when an item is available to the channel or when send side has closed (in that order).

  Returns Dex.Future

  a Dex.Future

receive_all

• receive_all(): Dex.Future

  Will attempt to receive all items in the channel as a DexResultSet.

  If the receive side of the channel is closed, then the future will reject with an error.

  If there are items in the queue, then they will be returned as part of a DexResultSet containing each of the futures.

  Otherwise, a Dex.FutureSet will be returned which will resolve or reject when the next item is available in the channel (or the send or receive sides are closed).

  Returns Dex.Future

  a Dex.Future

send

• send(future: Dex.Future): Dex.Future

  Queues future into the channel.

  The other end of the channel can receive the future (or a future that will eventually resolve to future) using dex_channel_receive().

  This function returns a Dex.Future that will resolve when the channels capacity is low enough to queue more items.

  If the send side of the channel is closed, the returned Dex.Future will be rejected with Dex.Error.CHANNEL_CLOSED.

  Parameters

  • future: Dex.Future

    a Dex.Future

  Returns Dex.Future

  a Dex.Future

Staticnew

• new(capacity: number): Dex.Channel

  Parameters

  • capacity: number

  Returns Dex.Channel