ri > Concurrent::Promises::Channel

= Concurrent::Promises::Channel < Concurrent::Synchronization::Object

------------------------------------------------------------------------
= Includes:
Comparable (from /home/chedong/.local/share/rdoc)

(from /home/chedong/.local/share/rdoc)
------------------------------------------------------------------------
A first in first out channel that accepts messages with push family of
methods and returns messages with pop family of methods. Pop and push
operations can be represented as futures, see {#pop_op} and {#push_op}.
The capacity of the channel can be limited to support back pressure, use
capacity option in {#initialize}. {#pop} method blocks ans {#pop_op}
returns pending future if there is no message in the channel. If the
capacity is limited the {#push} method blocks and {#push_op} returns
pending future.

{include:file:docs-source/channel.out.md} @!macro warn.edge
------------------------------------------------------------------------
= Constants:

ANY:
  An object which matches anything (with #===)

UNLIMITED_CAPACITY:
  Default capacity of the Channel, makes it accept unlimited number of
  messages.


= Class methods:

  new
  select
  select_matching
  select_op
  select_op_matching
  try_select
  try_select_matching

= Instance methods:

  <=>
  capacity
  inspect
  partial_select_op
  peek
  peek_matching
  pop
  pop_matching
  pop_op
  pop_op_matching
  push
  push_op
  select
  select_matching
  select_op
  select_op_matching
  size
  to_s
  try_pop
  try_pop_matching
  try_push
  try_select
  try_select_matching