Skip to content

Commit d2fc020

Browse files
garyrussellartembilan
authored andcommitted
GH-3020: QueueChannel doc polishing
Resolves #3020
1 parent eac33d3 commit d2fc020

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

src/reference/asciidoc/channel.adoc

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -102,12 +102,12 @@ public QueueChannel(int capacity)
102102
----
103103
====
104104

105-
A channel that has not reached its capacity limit storeS messages in its internal queue, and the `send()` method returns immediately, even if no receiver is ready to handle the message.
106-
If the queue has reached capacity, the sender blocks until room is available.
107-
Alternatively, if you use the send call that accepts a timeout, the queue blocks until either room is available or the timeout period elapses, whichever occurs first.
108-
Similarly, a `receive` call returns immediately if a message is available on the queue, but, if the queue is empty, then a receive call may block until either a message is available or the timeout elapses.
105+
A channel that has not reached its capacity limit stores messages in its internal queue, and the `send(Message<?>)` method returns immediately, even if no receiver is ready to handle the message.
106+
If the queue has reached capacity, the sender blocks until room is available in the queue.
107+
Alternatively, if you use the send method that has an additional timeout parameter, the queue blocks until either room is available or the timeout period elapses, whichever occurs first.
108+
Similarly, a `receive()` call returns immediately if a message is available on the queue, but, if the queue is empty, then a receive call may block until either a message is available or the timeout, if provided, elapses.
109109
In either case, it is possible to force an immediate return regardless of the queue's state by passing a timeout value of 0.
110-
Note, however, that calls to the no-arg versions of `send()` and `receive()` block indefinitely.
110+
Note, however, that calls to the versions of `send()` and `receive()` with no `timeout` parameter block indefinitely.
111111

112112
[[channel-implementations-prioritychannel]]
113113
===== `PriorityChannel`

0 commit comments

Comments
 (0)