3.2 KiB
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.
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.
Usage:
give(channel:|T|, item: T, where: Where = Where.End) -> Void
Parameters:
channel: The channel to which the item will be added.item: The item to add to the channel.where: Where to put the item (at theStartorEndof the queue).Anywheredefaults toEnd.
Returns:
Nothing.
Example:
>> channel:give("Hello")
give_all
Description:
Adds multiple items to the channel.
Usage:
give_all(channel:|T|, items: [T], where: Where = Where.End) -> Void
Parameters:
channel: The channel to which the items will be added.items: The array of items to add to the channel.where: Where to put the items (at theStartorEndof the queue).Anywheredefaults toEnd.
Returns:
Nothing.
Example:
>> 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.
Usage:
get(channel:|T|, where: Where = Where.Start) -> T
Parameters:
channel: The channel from which to remove an item.where: Where to get the item from (from theStartorEndof the queue).Anywheredefaults toStart.
Returns:
The item removed from the channel.
Example:
>> 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.
Usage:
peek(channel:|T|, where: Where = Where.Start) -> T
Parameters:
channel: The channel from which to remove an item.where: Which end of the channel to peek from (theStartorEnd).Anywheredefaults toStart.
Returns:
The item removed from the channel.
Example:
>> channel:get()
= "Hello"
clear
Description:
Removes all items from the channel.
Usage:
clear(channel:|T|) -> Void
Parameters:
channel: The mutable reference to the channel.
Returns:
Nothing.
Example:
>> channel:clear()
view
Description:
Returns a list of all items currently in the channel without removing them.
Usage:
channel:view() -> [T]
Parameters:
channel: The channel to view.
Returns:
An array of items currently in the channel.
Example:
>> channel:view()
= [1, 2, 3]