diff options
| author | Bruce Hill <bruce@bruce-hill.com> | 2025-01-02 16:24:07 -0500 |
|---|---|---|
| committer | Bruce Hill <bruce@bruce-hill.com> | 2025-01-02 16:24:07 -0500 |
| commit | be384c0caa92cb152c264125fb265373e6a50440 (patch) | |
| tree | b823fb0dd4cfec643670236688a2a7ca76787d7b /docs/channels.md | |
| parent | 2fcf1939bb295887592c1f24f7b8fbb10efcfcba (diff) | |
Replace threads with generic mutexed datastructures.
Diffstat (limited to 'docs/channels.md')
| -rw-r--r-- | docs/channels.md | 177 |
1 files changed, 0 insertions, 177 deletions
diff --git a/docs/channels.md b/docs/channels.md deleted file mode 100644 index ab61a82a..00000000 --- a/docs/channels.md +++ /dev/null @@ -1,177 +0,0 @@ -# Channels - -Channels are a thread-safe message queue for communicating between threads, -although they can also be used as a general-purpose queue. - -## Syntax - -The syntax to create a channel is `|:T|`, where `T` is the type that will be -passed through the channel. You can also specify a maximum size for the -channel, which will cause giving to block until the recipient has gotten from -the channel if the maximum size is reached. - -```tomo -channel := |:Int| -channel:give(10) -channel:give(20) ->> channel:get() -= 10 ->> channel:get() -= 20 - -small_channel := |:Int; max_size=5| -``` - -## Channel Methods - -### `give` - -**Description:** -Adds an item to the channel. - -**Signature:** -```tomo -func give(channel:|T|, item: T, front: Bool = no -> Void) -``` - -**Parameters:** - -- `channel`: The channel to which the item will be added. -- `item`: The item to add to the channel. -- `front`: Whether to put the item at the front of the channel (as opposed to the back). - -**Returns:** -Nothing. - -**Example:** -```tomo ->> channel:give("Hello") -``` - ---- - -### `give_all` - -**Description:** -Adds multiple items to the channel. - -**Signature:** -```tomo -func give_all(channel:|T|, items: [T], front: Bool = no -> Void) -``` - -**Parameters:** - -- `channel`: The channel to which the items will be added. -- `items`: The array of items to add to the channel. -- `front`: Whether to put the item at the front of the channel (as opposed to the back). - -**Returns:** -Nothing. - -**Example:** -```tomo ->> channel:give_all([1, 2, 3]) -``` - ---- - -### `get` - -**Description:** -Removes and returns an item from the channel. If the channel is empty, it waits until an item is available. - -**Signature:** -```tomo -func get(channel:|T|, front: Bool = yes -> T) -``` - -**Parameters:** - -- `channel`: The channel from which to remove an item. -- `front`: Whether to put the item at the front of the channel (as opposed to the back). - -**Returns:** -The item removed from the channel. - -**Example:** -```tomo ->> channel:peek() -= "Hello" -``` - ---- - -### `peek` - -**Description:** -Returns the next item that will come out of the channel, but without removing -it. If the channel is empty, it waits until an item is available. - -**Signature:** -```tomo -func peek(channel:|T|, front: Bool = yes -> T) -``` - -**Parameters:** - -- `channel`: The channel from which to remove an item. -- `front`: Whether to put the item at the front of the channel (as opposed to the back). - -**Returns:** -The item removed from the channel. - -**Example:** -```tomo ->> channel:get() -= "Hello" -``` - ---- - -### `clear` - -**Description:** -Removes all items from the channel. - -**Signature:** -```tomo -func clear(channel:|T| -> Void) -``` - -**Parameters:** - -- `channel`: The mutable reference to the channel. - -**Returns:** -Nothing. - -**Example:** -```tomo ->> channel:clear() -``` - ---- - -### `view` - -**Description:** -Returns a list of all items currently in the channel without removing them. - -**Signature:** -```tomo -func channel:view(->[T]) -``` - -**Parameters:** - -- `channel`: The channel to view. - -**Returns:** -An array of items currently in the channel. - -**Example:** -```tomo ->> channel:view() -= [1, 2, 3] -``` |
