Limiter

Object Hierarchy:

Description:

[ CCode ( type_id = "dex_limiter_get_type ()" ) ]
[ Version ( since = "1.2" ) ]
public sealed class Limiter : Object

`DexLimiter` limits the number of operations running concurrently.

A limiter starts with a fixed number of permits. Use [method@Dex.Limiter.acquire] and [method@Dex.Limiter.release] directly when a permit must cover a custom scope, or use [method@Dex.Limiter.run] or [method@Dex.Limiter.run_on_pool] to acquire a permit and release it automatically when the work completes.

Namespace: Dex

Package: libdex-1

Content:

Creation methods:

public Limiter (uint max_concurrency)
Creates a new `DexLimiter` with max_concurrency permits.

Methods:

public Future acquire ()
Acquires one permit from this.
public void close ()
Closes this.
public Future close_after_drain ()
Closes this and waits for all queued and running work to complete.
public uint get_max_concurrency ()
Gets the maximum number of permits available from this.
public void release ()
Releases one permit previously acquired from this.
public Future run (Scheduler? scheduler, size_t stack_size, owned FiberFunc func)
Runs func while holding one permit from this.
public Future run_coroutine (Scheduler? scheduler, owned CoroutineFunc func)
Runs func while holding one permit from this.
public Future run_on_pool (ThreadPool pool, owned ThreadFunc thread_func)
Runs thread_func on pool while holding one permit from this.

Inherited Members:

All known members inherited from class Dex.Object

@ref

unref