aboutsummaryrefslogtreecommitdiff
path: root/api/threads.md
diff options
context:
space:
mode:
authorBruce Hill <bruce@bruce-hill.com>2024-08-19 00:23:02 -0400
committerBruce Hill <bruce@bruce-hill.com>2024-08-19 00:23:02 -0400
commit67e8f2dea0d4eec20a839d47f1fa6302a4a5f733 (patch)
tree3f9d28687b6ac824b5676c963ef9964ac4857c4a /api/threads.md
parent8363d53bd27c621cb342fea15736a3b11231f2a4 (diff)
Move docs into one folder
Diffstat (limited to 'api/threads.md')
-rw-r--r--api/threads.md111
1 files changed, 0 insertions, 111 deletions
diff --git a/api/threads.md b/api/threads.md
deleted file mode 100644
index 228fc8ac..00000000
--- a/api/threads.md
+++ /dev/null
@@ -1,111 +0,0 @@
-# Threads
-
-Tomo supports POSIX threads (pthreads) through the `Thread` type. The
-recommended practice is to have each thread interact with other threads only
-through thread-safe Channels with no other shared data.
-
-## Thread Methods
-
-### `new`
-
-**Description:**
-Creates a new thread to execute a specified function.
-
-**Usage:**
-```tomo
-Thread.new(fn: func() -> Void) -> Thread
-```
-
-**Parameters:**
-
-- `fn`: The function to be executed by the new thread.
-
-**Returns:**
-A new `Thread` object representing the created thread.
-
-**Example:**
-```tomo
->> jobs := |Int|
->> results := |Int|
->> thread := Thread.new(func():
- while yes:
- input := jobs:get()
- results:give(input + 10
-)
-= Thread<0x12345678>
->> jobs:give(10)
->> results:get()
-= 11
-```
-
----
-
-### `cancel`
-
-**Description:**
-Requests the cancellation of a specified thread.
-
-**Usage:**
-```tomo
-cancel(thread: Thread) -> Void
-```
-
-**Parameters:**
-
-- `thread`: The thread to cancel.
-
-**Returns:**
-Nothing.
-
-**Example:**
-```tomo
->> thread:cancel()
-```
-
----
-
-### `join`
-
-**Description:**
-Waits for a specified thread to terminate.
-
-**Usage:**
-```tomo
-join(thread: Thread) -> Void
-```
-
-**Parameters:**
-
-- `thread`: The thread to join.
-
-**Returns:**
-Nothing.
-
-**Example:**
-```tomo
->> thread:join()
-```
-
----
-
-### `detach`
-
-**Description:**
-Detaches a specified thread, allowing it to run independently.
-
-**Usage:**
-```tomo
-detach(thread: Thread) -> Void
-```
-
-**Parameters:**
-
-- `thread`: The thread to detach.
-
-**Returns:**
-Nothing.
-
-**Example:**
-```tomo
->> thread:detach()
-```