112 lines
1.5 KiB
Markdown
112 lines
1.5 KiB
Markdown
# Threads
|
|
|
|
Tomo supports POSIX threads (pthreads) through the `Thread` type. The
|
|
recommended practice is to have each thread interact with other threads only
|
|
through [mutex-guarded datastructures](mutexed.md).
|
|
|
|
## Thread Methods
|
|
|
|
### `new`
|
|
|
|
**Description:**
|
|
Creates a new thread to execute a specified function.
|
|
|
|
**Signature:**
|
|
```tomo
|
|
func 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():
|
|
repeat:
|
|
input := jobs:get()
|
|
results:give(input + 10
|
|
)
|
|
= Thread<0x12345678>
|
|
>> jobs:give(10)
|
|
>> results:get()
|
|
= 11
|
|
```
|
|
|
|
---
|
|
|
|
### `cancel`
|
|
|
|
**Description:**
|
|
Requests the cancellation of a specified thread.
|
|
|
|
**Signature:**
|
|
```tomo
|
|
func cancel(thread: Thread)
|
|
```
|
|
|
|
**Parameters:**
|
|
|
|
- `thread`: The thread to cancel.
|
|
|
|
**Returns:**
|
|
Nothing.
|
|
|
|
**Example:**
|
|
```tomo
|
|
>> thread:cancel()
|
|
```
|
|
|
|
---
|
|
|
|
### `join`
|
|
|
|
**Description:**
|
|
Waits for a specified thread to terminate.
|
|
|
|
**Signature:**
|
|
```tomo
|
|
func join(thread: Thread)
|
|
```
|
|
|
|
**Parameters:**
|
|
|
|
- `thread`: The thread to join.
|
|
|
|
**Returns:**
|
|
Nothing.
|
|
|
|
**Example:**
|
|
```tomo
|
|
>> thread:join()
|
|
```
|
|
|
|
---
|
|
|
|
### `detach`
|
|
|
|
**Description:**
|
|
Detaches a specified thread, allowing it to run independently.
|
|
|
|
**Signature:**
|
|
```tomo
|
|
func detach(thread: Thread)
|
|
```
|
|
|
|
**Parameters:**
|
|
|
|
- `thread`: The thread to detach.
|
|
|
|
**Returns:**
|
|
Nothing.
|
|
|
|
**Example:**
|
|
```tomo
|
|
>> thread:detach()
|
|
```
|