Dex-1 ▶ Dex ▶ LimiterSince 1.2

constructor

• new Limiter(): Dex.Limiter

  Returns Dex.Limiter

Static$gtype

_init

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

  Parameters

  • ...args: any[]

  Returns void

Since 1.2acquire

• acquire(): Dex.Future

  Acquires one permit from limiter.

  The returned future resolves to true when a permit has been acquired. Call Dex.Limiter.release exactly once for each resolved acquisition.

  If the returned future is discarded before the permit is acquired, the permit is returned to the limiter when it becomes available. If limiter is closed before acquisition completes, the returned future rejects with Dex.Error.SEMAPHORE_CLOSED.

  Returns Dex.Future

  a future that resolves when a permit is acquired

  Since

  1.2

Since 1.2close

• close(): void

  Closes limiter.

  Pending and future acquisitions reject with Dex.Error.SEMAPHORE_CLOSED. Permits already acquired remain valid, but releasing them after close will not make them available for new work.

  Returns void

  Since

  1.2

Since 1.2close_after_drain

• close_after_drain(): Dex.Future

  Closes limiter and waits for all queued and running work to complete.

  After this function is called, new acquire attempts are rejected with Dex.Error.SEMAPHORE_CLOSED.

  The returned future resolves to true once all outstanding pending acquire futures and held permits are complete. Existing permit holders must still eventually release.

  Returns Dex.Future

  a Dex.Future that resolves to true

  Since

  1.2

Signalconnect

• connect<K extends keyof Dex.Limiter.SignalSignatures>(
      signal: K,
      callback: SignalCallback<Dex.Limiter, Dex.Limiter.SignalSignatures[K]>,
  ): number

  Type Parameters

  • K extends keyof Dex.Limiter.SignalSignatures

  Parameters

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

  Returns number

Signalconnect_after

• connect_after<K extends keyof Dex.Limiter.SignalSignatures>(
      signal: K,
      callback: SignalCallback<Dex.Limiter, Dex.Limiter.SignalSignatures[K]>,
  ): number

  Type Parameters

  • K extends keyof Dex.Limiter.SignalSignatures

  Parameters

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

  Returns number

Signalemit

• emit<K extends keyof Dex.Limiter.SignalSignatures>(
      signal: K,
      ...args: GjsParameters<Dex.Limiter.SignalSignatures[K]>,
  ): void

  Type Parameters

  • K extends keyof Dex.Limiter.SignalSignatures

  Parameters

  • signal: K
  • ...args: GjsParameters<Dex.Limiter.SignalSignatures[K]>

  Returns void

Since 1.2get_max_concurrency

• get_max_concurrency(): number

  Gets the maximum number of permits available from limiter.

  Returns number

  the maximum number of concurrent operations

  Since

  1.2

Since 1.2release

• release(): void

  Releases one permit previously acquired from limiter.

  This must be called exactly once for each successful Dex.Limiter.acquire unless the permit is managed by Dex.Limiter.run.

  Returns void

  Since

  1.2

Since 1.2run

• run(
      scheduler: Dex.Scheduler,
      stack_size: number | bigint,
      func: FiberFunc,
  ): Dex.Future

  Runs func while holding one permit from limiter.

  The returned future resolves or rejects with the result of the spawned fiber. The permit is released automatically after the fiber resolves or rejects. If the returned future is discarded after the fiber starts, the fiber is allowed to complete so that the permit can be released.

  Parameters

  • scheduler: Dex.Scheduler

    scheduler to spawn func on, or null for the thread default

  • stack_size: number | bigint

    stack size for the spawned fiber, or zero to use the default

  • func: FiberFunc

    fiber function to run after a permit is acquired

  Returns Dex.Future

  a future representing the spawned fiber

  Since

  1.2

Since 1.2run_coroutine

• run_coroutine(scheduler: Dex.Scheduler, func: CoroutineFunc): Dex.Future

  Runs func while holding one permit from limiter.

  The returned future resolves or rejects with the result of the spawned coroutine. The permit is released automatically after the coroutine resolves or rejects. If the returned future is discarded after the coroutine starts, the coroutine is allowed to complete so that the permit can be released.

  Parameters

  • scheduler: Dex.Scheduler

    scheduler to spawn func on, or null for the thread default

  • func: CoroutineFunc

    coroutine function to run after a permit is acquired

  Returns Dex.Future

  a future representing the spawned coroutine

  Since

  1.2

Since 1.2run_on_pool

• run_on_pool(pool: Dex.ThreadPool, thread_func: Dex.ThreadFunc): Dex.Future

  Runs thread_func on pool while holding one permit from limiter.

  The returned future resolves or rejects with the result of the submitted thread-pool work. The permit is released automatically after the work resolves or rejects. If the returned future is discarded after the work is submitted to pool, the work is allowed to complete so that the permit can be released.

  Workers in Dex.ThreadPool are not scheduler threads, so thread_func must not use dex_await().

  Parameters

  • pool: Dex.ThreadPool

    a Dex.ThreadPool

  • thread_func: Dex.ThreadFunc

    function to run on pool after a permit is acquired

  Returns Dex.Future

  a future representing the submitted work

  Since

  1.2

Staticnew

• new(max_concurrency: number): Dex.Limiter

  Parameters

  • max_concurrency: number

  Returns Dex.Limiter