Thread::Queue#pop

(?::boolish non_block, ?timeout: ::_ToF?) -> Elem?

pop(non_block=false, timeout: nil)

# File tmp/rubies/ruby-3.4.1/thread_sync.rb, line 14
def pop(non_block = false, timeout: nil)
  if non_block && timeout
    raise ArgumentError, "can't set a timeout if non_block is enabled"
  end
  Primitive.rb_queue_pop(non_block, timeout)
end

Retrieves data from the queue.

If the queue is empty, the calling thread is suspended until data is pushed onto the queue. If non_block is true, the thread isn’t suspended, and ThreadError is raised.

If timeout seconds have passed and no data is available nil is returned. If timeout is 0 it returns immediately.

Ruby version changes

3.2
- Thread::Queue#pop(timeout: sec) is added. [Feature #18774]

See also #num_waiting #push #length #shift also in 4.1 · 4.0 · 3.3 · 3.2 · 3.1

‹ prev#num_waiting next ›#push