Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update scaladoc for Channel #105

Merged
merged 1 commit into from
Mar 19, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions core/src/main/scala/ox/channels/Channel.scala
Original file line number Diff line number Diff line change
Expand Up @@ -221,9 +221,10 @@ trait Sink[-T]:
* - buffered channels, where a given number of sent values might be buffered, before subsequent `send`s block
* - unlimited channels, where an unlimited number of values might be buffered, hence `send` never blocks
*
* Channels can be created using the channel's companion object. When no arguments are given, a rendezvous channel is created, while a
* buffered channel can be created by providing a positive integer to the [[Channel.apply]] method. A rendezvous channel behaves like a
* buffered channel with buffer size 0. An unlimited channel can be created using [[Channel.unlimited]].
* Channels can be created using the channel's companion object. A rendezvous channel is created using [[Channel.rendezvous]]. A buffered
* channel can be created either with a given capacity - by providing a positive integer to the [[Channel.buffered]] method - or with the
* default capacity ([[StageCapacity.default]]) using [[Channel.bufferedDefault]] . A rendezvous channel behaves like a buffered channel
* with buffer size 0. An unlimited channel can be created using [[Channel.unlimited]].
*
* In a rendezvous channel, senders and receivers block, until a matching party arrives (unless one is already waiting). Similarly,
* buffered channels block if the buffer is full (in case of senders), or in case of receivers, if the buffer is empty and there are no
Expand Down
Loading