Class: Queue

Inherits:
Object
  • Object
show all
Defined in:
thread.c,
thread.c

Overview

This class provides a way to synchronize communication between threads.

Example:

require 'thread'

	queue = Queue.new

producer = Thread.new do

5.times do |i|
   sleep rand(i) # simulate expense
   queue << i
   puts "#{i} produced"
end

end

consumer = Thread.new do

5.times do |i|
   value = queue.pop
   sleep rand(i/2) # simulate expense
   puts "consumed #{value}"
end

end

Instance Method Summary collapse

Constructor Details

#initializeObject

Creates a new queue instance.


211
212
213
214
215
216
217
# File 'thread.c', line 211

static VALUE
rb_queue_initialize(VALUE self)
{
    RSTRUCT_SET(self, QUEUE_QUE, ary_buf_new());
    RSTRUCT_SET(self, QUEUE_WAITERS, ary_buf_new());
    return self;
}

Instance Method Details

#clearObject

Removes all objects from the queue.


348
349
350
351
352
353
# File 'thread.c', line 348

static VALUE
rb_queue_clear(VALUE self)
{
    rb_ary_clear(GET_QUEUE_QUE(self));
    return self;
}

#empty?Boolean

Returns true if the queue is empty.

Returns:

  • (Boolean)

336
337
338
339
340
# File 'thread.c', line 336

static VALUE
rb_queue_empty_p(VALUE self)
{
    return queue_length(self) == 0 ? Qtrue : Qfalse;
}

#lengthObject #sizeObject Also known as: size

Returns the length of the queue.


364
365
366
367
368
369
# File 'thread.c', line 364

static VALUE
rb_queue_length(VALUE self)
{
    unsigned long len = queue_length(self);
    return ULONG2NUM(len);
}

#marshal_dumpObject


547
548
549
550
551
552
# File 'thread.c', line 547

static VALUE
undumpable(VALUE obj)
{
    rb_raise(rb_eTypeError, "can't dump %"PRIsVALUE, rb_obj_class(obj));
    UNREACHABLE;
}

#num_waitingObject

Returns the number of threads waiting on the queue.


377
378
379
380
381
382
# File 'thread.c', line 377

static VALUE
rb_queue_num_waiting(VALUE self)
{
    unsigned long len = queue_num_waiting(self);
    return ULONG2NUM(len);
}

#pop(non_block = false) ⇒ Object #deq(non_block = false) ⇒ Object #shift(non_block = false) ⇒ Object Also known as: deq, shift

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 an exception is raised.


322
323
324
325
326
327
# File 'thread.c', line 322

static VALUE
rb_queue_pop(int argc, VALUE *argv, VALUE self)
{
    VALUE should_block = queue_pop_should_block(argc, argv);
    return queue_do_pop(self, should_block);
}

#push(object) ⇒ Object #enq(object) ⇒ Object #<<(object) ⇒ Object Also known as: enq, <<

Pushes the given object to the queue.


237
238
239
240
241
# File 'thread.c', line 237

static VALUE
rb_queue_push(VALUE self, VALUE obj)
{
    return queue_do_push(self, obj);
}