README
U
AtomicI32Ref
U
AtomicOffset
U
AtomicOps
U
EntryId
U
MultithreadPlatform
U
MutexOps
U
MutexRef
U
PlatformCapabilities
U
RegisteredEntry
U
SharedMemory
U
SharedMemoryId
U
SpawnOptions
U
SpawnSpec
U
StartArg
U
TaskCond
U
TaskSemaphore
U
ThreadBackendKind
U
ThreadError
U
ThreadId
U
ThreadOps
U
Threads
U
WaitCallerContext
U
WaitResult
T
SharedStartArgDecoded
V
atomic_i32
V
atomic_ops_unsupported
V
atomic_wait_i32
V
backend_native
V
backend_node_worker
V
backend_wasi_threads
V
backend_web_worker
V
default_capabilities_for_backend
V
multithread_platform
V
multithread_platform_auto
V
multithread_platform_for_backend
V
multithread_platform_native_c
V
multithread_platform_node_worker
V
multithread_platform_unsupported
V
multithread_platform_wasi_threads
V
multithread_platform_web_worker
V
mutex_ops_unsupported
V
mutex_ref
V
native_capabilities
V
node_worker_capabilities
V
platform_capabilities
V
registered_entry_double
V
registered_entry_from_id
V
registered_entry_increment
V
registered_entry_passthrough
V
registered_entry_shared_counter_add
V
registered_entry_shared_counter_mutex
V
registered_entry_to_id
V
shared_memory
V
shared_start_arg_decode
V
shared_start_arg_encode
V
spawn_options
V
spawn_spec
V
spawn_spec_registered
V
task_cond
V
task_cond_broadcast
V
task_cond_signal
V
task_cond_wait
V
task_pause
V
task_semaphore
V
task_semaphore_acquire
V
task_semaphore_release
V
task_semaphore_try_acquire
V
thread_detach
V
thread_error_host_failure
V
thread_error_resource_exhausted
V
thread_join
V
thread_join_async
V
thread_join_portable
V
thread_ops
V
thread_ops_unsupported
V
thread_spawn_join_portable
V
threads_auto
V
threads_backend_kind
V
threads_for_backend
V
threads_join
V
threads_join_blocking
V
threads_spawn
V
threads_spawn_join
V
threads_spawn_join_blocking
V
threads_spawn_join_registered
V
threads_spawn_join_registered_blocking
V
threads_spawn_registered
V
wait_caller_main_thread
V
wait_caller_worker_thread
V
wait_not_equal
V
wait_ok
V
wait_timed_out
V
wasi_threads_capabilities
V
web_worker_capabilities

threads

Experimental threads

moonbit

template

workflow

Download zip

Author

mizchi

Version

0.1.2

License

Apache-2.0

Repository

github.com/mizchi/threads

Last updated

7 months ago

Downloads

Dependencies

moonbitlang/async0.16.6

#mizchi/threads

Experimental multithread abstraction layer for MoonBit.

#Package

mizchi/threads

#Included Structure

Library package under src/
Executable package under src/main/
Test, benchmark, and doc-test examples

#Quick Example

import {
  "mizchi/threads" @threads,
}

let t = @threads.threads_for_backend(@threads.backend_node_worker())
inspect(t.backend_kind, content="BackendNodeWorker")

AtomicI32Ref

source

using @mizchi/threads/internal/types {type mizchi/threads/internal/types}

AtomicOffset

source

type AtomicOffset = Int

AtomicOps

source

using @mizchi/threads/internal/types {type mizchi/threads/internal/types}

EntryId

source

type EntryId = Int

MultithreadPlatform

source

using @mizchi/threads/internal/types {type mizchi/threads/internal/types}

MutexOps

source

using @mizchi/threads/internal/types {type mizchi/threads/internal/types}

MutexRef

source

using @mizchi/threads/internal/types {type mizchi/threads/internal/types}

PlatformCapabilities

source

using @mizchi/threads/internal/types {type mizchi/threads/internal/types}

RegisteredEntry

source

using @mizchi/threads/internal/types {type mizchi/threads/internal/types}

SharedMemory

source

using @mizchi/threads/internal/types {type mizchi/threads/internal/types}

SharedMemoryId

source

type SharedMemoryId = Int

SpawnOptions

source

using @mizchi/threads/internal/types {type mizchi/threads/internal/types}

SpawnSpec

source

using @mizchi/threads/internal/types {type mizchi/threads/internal/types}

StartArg

source

type StartArg = Int

TaskCond

source

using @moonbitlang/async/cond_var {type moonbitlang/async/cond_var as TaskCond}

A condition variable that can be used for synchronization between tasks.

TaskSemaphore

source

using @moonbitlang/async/semaphore {type moonbitlang/async/semaphore as TaskSemaphore}

ThreadBackendKind

source

using @mizchi/threads/internal/types {type mizchi/threads/internal/types}

ThreadError

source

using @mizchi/threads/internal/types {type mizchi/threads/internal/types}

ThreadId

source

type ThreadId = Int

ThreadOps

source

using @mizchi/threads/internal/types {type mizchi/threads/internal/types}

Threads

source

using @mizchi/threads/internal/types {type mizchi/threads/internal/types as Threads}

WaitCallerContext

source

using @mizchi/threads/internal/types {type mizchi/threads/internal/types}

WaitResult

source

using @mizchi/threads/internal/types {type mizchi/threads/internal/types}

SharedStartArgDecoded

source

pub struct SharedStartArgDecoded {
  memory_id : Int
  local_arg : Int
}

atomic_i32

source

fn atomic_i32(memory : @mizchi/threads/internal/types.SharedMemory
SharedMemory, offset : Int) -> Result[@mizchi/threads/internal/types.AtomicI32Ref
AtomicI32Ref, @mizchi/threads/internal/types.ThreadError
ThreadError]

atomic_ops_unsupported

source

fn atomic_ops_unsupported() -> @mizchi/threads/internal/types.AtomicOps
AtomicOps

atomic_wait_i32

source

fn atomic_wait_i32(platform : @mizchi/threads/internal/types.MultithreadPlatform
MultithreadPlatform, addr : @mizchi/threads/internal/types.AtomicI32Ref
AtomicI32Ref, expect : Int, timeout_ns? : Int64, caller_context? : @mizchi/threads/internal/types.WaitCallerContext
WaitCallerContext) -> Result[@mizchi/threads/internal/types.WaitResult
WaitResult, @mizchi/threads/internal/types.ThreadError
ThreadError]

backend_native

source

fn backend_native() -> @mizchi/threads/internal/types.ThreadBackendKind
ThreadBackendKind

backend_node_worker

source

fn backend_node_worker() -> @mizchi/threads/internal/types.ThreadBackendKind
ThreadBackendKind

backend_wasi_threads

source

fn backend_wasi_threads() -> @mizchi/threads/internal/types.ThreadBackendKind
ThreadBackendKind

backend_web_worker

source

fn backend_web_worker() -> @mizchi/threads/internal/types.ThreadBackendKind
ThreadBackendKind

default_capabilities_for_backend

source

fn default_capabilities_for_backend(backend_kind : @mizchi/threads/internal/types.ThreadBackendKind
ThreadBackendKind) -> @mizchi/threads/internal/types.PlatformCapabilities
PlatformCapabilities

multithread_platform

source

fn multithread_platform(backend_kind : @mizchi/threads/internal/types.ThreadBackendKind
ThreadBackendKind, thread : @mizchi/threads/internal/types.ThreadOps
ThreadOps, atomics : @mizchi/threads/internal/types.AtomicOps
AtomicOps, mutex : @mizchi/threads/internal/types.MutexOps
MutexOps, capabilities? : @mizchi/threads/internal/types.PlatformCapabilities
PlatformCapabilities) -> @mizchi/threads/internal/types.MultithreadPlatform
MultithreadPlatform

multithread_platform_auto

source

fn multithread_platform_auto() -> @mizchi/threads/internal/types.MultithreadPlatform
MultithreadPlatform

multithread_platform_for_backend

source

fn multithread_platform_for_backend(backend_kind : @mizchi/threads/internal/types.ThreadBackendKind
ThreadBackendKind) -> @mizchi/threads/internal/types.MultithreadPlatform
MultithreadPlatform

multithread_platform_native_c

source

fn multithread_platform_native_c() -> @mizchi/threads/internal/types.MultithreadPlatform
MultithreadPlatform

multithread_platform_node_worker

source

fn multithread_platform_node_worker() -> @mizchi/threads/internal/types.MultithreadPlatform
MultithreadPlatform

multithread_platform_unsupported

source

fn multithread_platform_unsupported(backend_kind? : @mizchi/threads/internal/types.ThreadBackendKind
ThreadBackendKind) -> @mizchi/threads/internal/types.MultithreadPlatform
MultithreadPlatform

multithread_platform_wasi_threads

source

fn multithread_platform_wasi_threads() -> @mizchi/threads/internal/types.MultithreadPlatform
MultithreadPlatform

multithread_platform_web_worker

source

fn multithread_platform_web_worker() -> @mizchi/threads/internal/types.MultithreadPlatform
MultithreadPlatform

mutex_ops_unsupported

source

fn mutex_ops_unsupported() -> @mizchi/threads/internal/types.MutexOps
MutexOps

mutex_ref

source

fn mutex_ref(state : @mizchi/threads/internal/types.AtomicI32Ref
AtomicI32Ref) -> @mizchi/threads/internal/types.MutexRef
MutexRef

native_capabilities

source

fn native_capabilities() -> @mizchi/threads/internal/types.PlatformCapabilities
PlatformCapabilities

node_worker_capabilities

source

fn node_worker_capabilities() -> @mizchi/threads/internal/types.PlatformCapabilities
PlatformCapabilities

platform_capabilities

source

fn platform_capabilities(supports_join? : Bool, supports_detach? : Bool, supports_wait_timeout? : Bool, supports_blocking_wait_on_main_thread? : Bool) -> @mizchi/threads/internal/types.PlatformCapabilities
PlatformCapabilities

registered_entry_double

source

fn registered_entry_double() -> @mizchi/threads/internal/types.RegisteredEntry
RegisteredEntry

registered_entry_from_id

source

fn registered_entry_from_id(entry_id : Int) -> @mizchi/threads/internal/types.RegisteredEntry
RegisteredEntry?

registered_entry_increment

source

fn registered_entry_increment() -> @mizchi/threads/internal/types.RegisteredEntry
RegisteredEntry

registered_entry_passthrough

source

fn registered_entry_passthrough() -> @mizchi/threads/internal/types.RegisteredEntry
RegisteredEntry

registered_entry_shared_counter_add

source

fn registered_entry_shared_counter_add() -> @mizchi/threads/internal/types.RegisteredEntry
RegisteredEntry

registered_entry_shared_counter_mutex

source

fn registered_entry_shared_counter_mutex() -> @mizchi/threads/internal/types.RegisteredEntry
RegisteredEntry

registered_entry_to_id

source

fn registered_entry_to_id(entry : @mizchi/threads/internal/types.RegisteredEntry
RegisteredEntry) -> Int

shared_memory

source

fn shared_memory(memory_id : Int, byte_length : Int) -> Result[@mizchi/threads/internal/types.SharedMemory
SharedMemory, @mizchi/threads/internal/types.ThreadError
ThreadError]

shared_start_arg_decode

source

fn shared_start_arg_decode(encoded : Int) -> SharedStartArgDecoded

shared_start_arg_encode

source

fn shared_start_arg_encode(memory_id : Int, local_arg : Int) -> Result[Int, @mizchi/threads/internal/types.ThreadError
ThreadError]

spawn_options

source

fn spawn_options(detached? : Bool, stack_size? : Int, name? : String) -> @mizchi/threads/internal/types.SpawnOptions
SpawnOptions

spawn_spec

source

fn spawn_spec(entry_id : Int, start_arg : Int, options? : @mizchi/threads/internal/types.SpawnOptions
SpawnOptions) -> @mizchi/threads/internal/types.SpawnSpec
SpawnSpec

spawn_spec_registered

source

fn spawn_spec_registered(entry : @mizchi/threads/internal/types.RegisteredEntry
RegisteredEntry, start_arg : Int, options? : @mizchi/threads/internal/types.SpawnOptions
SpawnOptions) -> @mizchi/threads/internal/types.SpawnSpec
SpawnSpec

task_cond

source

fn task_cond() -> @moonbitlang/async/cond_var.Cond
Cond

task_cond_broadcast

source

fn task_cond_broadcast(cond : @moonbitlang/async/cond_var.Cond
Cond) -> Unit

task_cond_signal

source

fn task_cond_signal(cond : @moonbitlang/async/cond_var.Cond
Cond) -> Unit

task_cond_wait

source

async fn task_cond_wait(cond : @moonbitlang/async/cond_var.Cond
Cond) -> Unit

task_pause

source

async fn task_pause() -> Unit

task_semaphore

source

fn task_semaphore(size : Int, initial_value? : Int) -> @moonbitlang/async/semaphore.Semaphore
Semaphore

task_semaphore_acquire

source

async fn task_semaphore_acquire(sem : @moonbitlang/async/semaphore.Semaphore
Semaphore) -> Unit

task_semaphore_release

source

fn task_semaphore_release(sem : @moonbitlang/async/semaphore.Semaphore
Semaphore) -> Unit

task_semaphore_try_acquire

source

fn task_semaphore_try_acquire(sem : @moonbitlang/async/semaphore.Semaphore
Semaphore) -> Bool

thread_detach

source

fn thread_detach(platform : @mizchi/threads/internal/types.MultithreadPlatform
MultithreadPlatform, thread_id : Int) -> Result[Unit, @mizchi/threads/internal/types.ThreadError
ThreadError]

thread_error_host_failure

source

fn thread_error_host_failure(message : String) -> @mizchi/threads/internal/types.ThreadError
ThreadError

thread_error_resource_exhausted

source

fn thread_error_resource_exhausted() -> @mizchi/threads/internal/types.ThreadError
ThreadError

thread_join

source

fn thread_join(platform : @mizchi/threads/internal/types.MultithreadPlatform
MultithreadPlatform, thread_id : Int) -> Result[Int, @mizchi/threads/internal/types.ThreadError
ThreadError]

thread_join_async

source

async fn thread_join_async(platform : @mizchi/threads/internal/types.MultithreadPlatform
MultithreadPlatform, thread_id : Int, poll_interval_ms? : Int) -> Result[Int, @mizchi/threads/internal/types.ThreadError
ThreadError]

thread_join_portable

source

async fn thread_join_portable(platform : @mizchi/threads/internal/types.MultithreadPlatform
MultithreadPlatform, thread_id : Int, poll_interval_ms? : Int) -> Result[Int, @mizchi/threads/internal/types.ThreadError
ThreadError]

thread_ops

source

fn thread_ops(spawn : (@mizchi/threads/internal/types.SpawnSpec
SpawnSpec) -> Result[Int, @mizchi/threads/internal/types.ThreadError
ThreadError], join : (Int) -> Result[Int, @mizchi/threads/internal/types.ThreadError
ThreadError], try_join : (Int) -> Result[Int?, @mizchi/threads/internal/types.ThreadError
ThreadError], detach : (Int) -> Result[Unit, @mizchi/threads/internal/types.ThreadError
ThreadError], current_thread_id : () -> Int) -> @mizchi/threads/internal/types.ThreadOps
ThreadOps

thread_ops_unsupported

source

fn thread_ops_unsupported() -> @mizchi/threads/internal/types.ThreadOps
ThreadOps

thread_spawn_join_portable

source

async fn thread_spawn_join_portable(platform : @mizchi/threads/internal/types.MultithreadPlatform
MultithreadPlatform, spec : @mizchi/threads/internal/types.SpawnSpec
SpawnSpec, poll_interval_ms? : Int) -> Result[Int, @mizchi/threads/internal/types.ThreadError
ThreadError]

threads_auto

source

fn threads_auto() -> @mizchi/threads/internal/types.MultithreadPlatform
MultithreadPlatform

threads_backend_kind

source

fn threads_backend_kind(threads : @mizchi/threads/internal/types.MultithreadPlatform
MultithreadPlatform) -> @mizchi/threads/internal/types.ThreadBackendKind
ThreadBackendKind

threads_for_backend

source

fn threads_for_backend(backend_kind : @mizchi/threads/internal/types.ThreadBackendKind
ThreadBackendKind) -> @mizchi/threads/internal/types.MultithreadPlatform
MultithreadPlatform

threads_join

source

async fn threads_join(threads : @mizchi/threads/internal/types.MultithreadPlatform
MultithreadPlatform, thread_id : Int, poll_interval_ms? : Int) -> Result[Int, @mizchi/threads/internal/types.ThreadError
ThreadError]

threads_join_blocking

source

fn threads_join_blocking(threads : @mizchi/threads/internal/types.MultithreadPlatform
MultithreadPlatform, thread_id : Int) -> Result[Int, @mizchi/threads/internal/types.ThreadError
ThreadError]

threads_spawn

source

fn threads_spawn(threads : @mizchi/threads/internal/types.MultithreadPlatform
MultithreadPlatform, entry_id : Int, start_arg : Int, options? : @mizchi/threads/internal/types.SpawnOptions
SpawnOptions) -> Result[Int, @mizchi/threads/internal/types.ThreadError
ThreadError]

threads_spawn_join

source

async fn threads_spawn_join(threads : @mizchi/threads/internal/types.MultithreadPlatform
MultithreadPlatform, entry_id : Int, start_arg : Int, options? : @mizchi/threads/internal/types.SpawnOptions
SpawnOptions, poll_interval_ms? : Int) -> Result[Int, @mizchi/threads/internal/types.ThreadError
ThreadError]

threads_spawn_join_blocking

source

fn threads_spawn_join_blocking(threads : @mizchi/threads/internal/types.MultithreadPlatform
MultithreadPlatform, entry_id : Int, start_arg : Int, options? : @mizchi/threads/internal/types.SpawnOptions
SpawnOptions) -> Result[Int, @mizchi/threads/internal/types.ThreadError
ThreadError]

threads_spawn_join_registered

source

async fn threads_spawn_join_registered(threads : @mizchi/threads/internal/types.MultithreadPlatform
MultithreadPlatform, entry : @mizchi/threads/internal/types.RegisteredEntry
RegisteredEntry, start_arg : Int, options? : @mizchi/threads/internal/types.SpawnOptions
SpawnOptions, poll_interval_ms? : Int) -> Result[Int, @mizchi/threads/internal/types.ThreadError
ThreadError]

threads_spawn_join_registered_blocking

source

fn threads_spawn_join_registered_blocking(threads : @mizchi/threads/internal/types.MultithreadPlatform
MultithreadPlatform, entry : @mizchi/threads/internal/types.RegisteredEntry
RegisteredEntry, start_arg : Int, options? : @mizchi/threads/internal/types.SpawnOptions
SpawnOptions) -> Result[Int, @mizchi/threads/internal/types.ThreadError
ThreadError]

threads_spawn_registered

source

fn threads_spawn_registered(threads : @mizchi/threads/internal/types.MultithreadPlatform
MultithreadPlatform, entry : @mizchi/threads/internal/types.RegisteredEntry
RegisteredEntry, start_arg : Int, options? : @mizchi/threads/internal/types.SpawnOptions
SpawnOptions) -> Result[Int, @mizchi/threads/internal/types.ThreadError
ThreadError]

wait_caller_main_thread

source

fn wait_caller_main_thread() -> @mizchi/threads/internal/types.WaitCallerContext
WaitCallerContext

wait_caller_worker_thread

source

fn wait_caller_worker_thread() -> @mizchi/threads/internal/types.WaitCallerContext
WaitCallerContext

wait_not_equal

source

fn wait_not_equal() -> @mizchi/threads/internal/types.WaitResult
WaitResult

wait_ok

source

fn wait_ok() -> @mizchi/threads/internal/types.WaitResult
WaitResult

wait_timed_out

source

fn wait_timed_out() -> @mizchi/threads/internal/types.WaitResult
WaitResult

wasi_threads_capabilities

source

fn wasi_threads_capabilities() -> @mizchi/threads/internal/types.PlatformCapabilities
PlatformCapabilities

web_worker_capabilities

source

fn web_worker_capabilities() -> @mizchi/threads/internal/types.PlatformCapabilities
PlatformCapabilities

Source Files

Site source Report issue Packages Build queue Skills Statistics

threads

#mizchi/threads

#Package

#Included Structure

#Quick Example

#AtomicI32Ref

#AtomicOffset

#AtomicOps

#EntryId

#MultithreadPlatform

#MutexOps

#MutexRef

#PlatformCapabilities

#RegisteredEntry

#SharedMemory

#SharedMemoryId

#SpawnOptions

#SpawnSpec

#StartArg

#TaskCond

#TaskSemaphore

#ThreadBackendKind

#ThreadError

#ThreadId

#ThreadOps

#Threads

#WaitCallerContext

#WaitResult

#SharedStartArgDecoded

#atomic_i32

#atomic_ops_unsupported

#atomic_wait_i32

#backend_native

#backend_node_worker

#backend_wasi_threads

#backend_web_worker

#default_capabilities_for_backend

#multithread_platform

#multithread_platform_auto

#multithread_platform_for_backend

#multithread_platform_native_c

#multithread_platform_node_worker

#multithread_platform_unsupported

#multithread_platform_wasi_threads

#multithread_platform_web_worker

#mutex_ops_unsupported

#mutex_ref

#native_capabilities

#node_worker_capabilities

#platform_capabilities

#registered_entry_double

#registered_entry_from_id

#registered_entry_increment

#registered_entry_passthrough

#registered_entry_shared_counter_add

#registered_entry_shared_counter_mutex

#registered_entry_to_id

#shared_memory

#shared_start_arg_decode

#shared_start_arg_encode

#spawn_options

#spawn_spec

#spawn_spec_registered

#task_cond

#task_cond_broadcast

#task_cond_signal

#task_cond_wait

#task_pause

#task_semaphore

#task_semaphore_acquire

#task_semaphore_release

#task_semaphore_try_acquire

#thread_detach

#thread_error_host_failure

#thread_error_resource_exhausted

#thread_join

#thread_join_async

#thread_join_portable

#thread_ops

#thread_ops_unsupported

AtomicI32Ref

AtomicOffset

AtomicOps

EntryId

MultithreadPlatform

MutexOps

MutexRef

PlatformCapabilities

RegisteredEntry

SharedMemory

SharedMemoryId

SpawnOptions

SpawnSpec

StartArg

TaskCond

TaskSemaphore

ThreadBackendKind

ThreadError

ThreadId

ThreadOps

Threads

WaitCallerContext

WaitResult

SharedStartArgDecoded

atomic_i32

atomic_ops_unsupported

atomic_wait_i32

backend_native

backend_node_worker

backend_wasi_threads

backend_web_worker

default_capabilities_for_backend

multithread_platform

multithread_platform_auto

multithread_platform_for_backend

multithread_platform_native_c

multithread_platform_node_worker

multithread_platform_unsupported

multithread_platform_wasi_threads

multithread_platform_web_worker

mutex_ops_unsupported

mutex_ref

native_capabilities

node_worker_capabilities

platform_capabilities

registered_entry_double

registered_entry_from_id

registered_entry_increment

registered_entry_passthrough

registered_entry_shared_counter_add

registered_entry_shared_counter_mutex

registered_entry_to_id

shared_memory

shared_start_arg_decode

shared_start_arg_encode

spawn_options

spawn_spec

spawn_spec_registered

task_cond

task_cond_broadcast

task_cond_signal

task_cond_wait

task_pause

task_semaphore

task_semaphore_acquire

task_semaphore_release

task_semaphore_try_acquire

thread_detach

thread_error_host_failure

thread_error_resource_exhausted

thread_join

thread_join_async

thread_join_portable

thread_ops

thread_ops_unsupported

thread_spawn_join_portable

threads_auto

threads_backend_kind

threads_for_backend

threads_join