class Thread::Queue

Die Klasse Thread::Queue implementiert Multi-Producer-, Multi-Consumer-Queues. Sie ist besonders nützlich in der Thread-Programmierung, wenn Informationen sicher zwischen mehreren Threads ausgetauscht werden müssen. Die Klasse Thread::Queue implementiert alle erforderlichen Sperrsemantiken.

Die Klasse implementiert eine FIFO (First-In, First-Out)-Queue. In einer FIFO-Queue werden die zuerst hinzugefügten Aufgaben zuerst abgerufen.

Beispiel

queue = Thread::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

consumer.join

Öffentliche Klassenmethoden

Thread::Queue.new → leere_queue

Thread::Queue.new(enumerable) → queue

Source

static VALUE
rb_queue_initialize(int argc, VALUE *argv, VALUE self)
{
    VALUE initial;
    struct rb_queue *q = queue_ptr(self);
    if ((argc = rb_scan_args(argc, argv, "01", &initial)) == 1) {
        initial = rb_to_array(initial);
    }
    RB_OBJ_WRITE(self, queue_list(q), ary_buf_new());
    ccan_list_head_init(queue_waitq(q));
    if (argc == 1) {
        rb_ary_concat(q->que, initial);
    }
    return self;
}

Erstellt eine neue Queue-Instanz, die optional die Inhalte einer enumerable für ihren Anfangszustand verwendet.

Beispiel

q = Thread::Queue.new
#=> #<Thread::Queue:0x00007ff7501110d0>
q.empty?
#=> true

q = Thread::Queue.new([1, 2, 3])
#=> #<Thread::Queue:0x00007ff7500ec500>
q.empty?
#=> false
q.pop
#=> 1

Öffentliche Instanzmethoden

<<(object)

Fügt das gegebene object zur Queue hinzu.

Alias für: push

clear ()

Source

static VALUE
rb_queue_clear(VALUE self)
{
    struct rb_queue *q = queue_ptr(self);

    rb_ary_clear(check_array(self, q->que));
    return self;
}

Entfernt alle Objekte aus der Queue.

Source

static VALUE
rb_queue_close(VALUE self)
{
    struct rb_queue *q = queue_ptr(self);

    if (!queue_closed_p(self)) {
        FL_SET(self, QUEUE_CLOSED);

        wakeup_all(queue_waitq(q));
    }

    return self;
}

Schließt die Queue. Eine geschlossene Queue kann nicht wieder geöffnet werden.

Nachdem der Aufruf von close abgeschlossen ist, gelten folgende Bedingungen:

closed? gibt true zurück.
close wird ignoriert.
Der Aufruf von enq/push/<< löst eine ClosedQueueError aus.
Wenn empty? falsch ist, gibt der Aufruf von deq/pop/shift wie gewohnt ein Objekt aus der Queue zurück.
Wenn empty? wahr ist, wird der Thread bei deq(false) nicht angehalten und gibt nil zurück. deq(true) löst eine ThreadError aus.

ClosedQueueError erbt von StopIteration, sodass Sie eine Schleife abbrechen können.

Beispiel

q = Thread::Queue.new
Thread.new{
  while e = q.deq # wait for nil to break loop
    # ...
  end
}
q.close

closed?

Source

static VALUE
rb_queue_closed_p(VALUE self)
{
    return RBOOL(queue_closed_p(self));
}

Gibt true zurück, wenn die Queue geschlossen ist.

deq

Alias für: pop

empty?

Source

static VALUE
rb_queue_empty_p(VALUE self)
{
    return RBOOL(queue_length(self, queue_ptr(self)) == 0);
}

Gibt true zurück, wenn die Queue leer ist.

enq(object)

Fügt das gegebene object zur Queue hinzu.

Alias für: push

einfrieren

Source

static VALUE
rb_queue_freeze(VALUE self)
{
    rb_raise(rb_eTypeError, "cannot freeze " "%+"PRIsVALUE, self);
    UNREACHABLE_RETURN(self);
}

Die Queue kann nicht eingefroren werden, daher löst diese Methode eine Ausnahme aus.

Thread::Queue.new.freeze # Raises TypeError (cannot freeze #<Thread::Queue:0x...>)

Länge

Source

static VALUE
rb_queue_length(VALUE self)
{
    return LONG2NUM(queue_length(self, queue_ptr(self)));
}

Gibt die Länge der Queue zurück.

Auch als Alias: size

num_waiting ()

Source

static VALUE
rb_queue_num_waiting(VALUE self)
{
    struct rb_queue *q = queue_ptr(self);

    return INT2NUM(q->num_waiting);
}

Gibt die Anzahl der Threads zurück, die auf die Queue warten.

pop(non_block=false, timeout: nil)

Source

# File thread_sync.rb, line 16
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

Ruft Daten aus der Queue ab.

Wenn die Queue leer ist, wird der aufrufende Thread angehalten, bis Daten in die Queue eingefügt werden. Wenn non_block wahr ist, wird der Thread nicht angehalten und eine ThreadError wird ausgelöst.

Wenn nach timeout Sekunden keine Daten verfügbar sind, wird nil zurückgegeben. Wenn timeout gleich 0 ist, wird sofort zurückgegeben.

Auch als Alias: deq, shift

push(object)

Source

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

Fügt das gegebene object zur Queue hinzu.

Auch als Alias: enq, <<

shift

Alias für: pop

size

Gibt die Länge der Queue zurück.

Alias für: length