Spec-Zone.ru › Ruby 4.0
  1. Thread::
  2. SizedQueue

class Thread::SizedQueue

Родительский класс:
Object

Этот класс представляет собой очереди заданной вместимости. Операция добавления может быть заблокирована, если очередь заполнена.

Пример работы Thread::SizedQueue см. в разделе Thread::Queue.

Открытые методы класса

new(max) Показать исходный код
static VALUE
rb_szqueue_initialize(VALUE self, VALUE vmax)
{
    long max;
    struct rb_szqueue *sq = szqueue_ptr(self);

    max = NUM2LONG(vmax);
    if (max <= 0) {
        rb_raise(rb_eArgError, "queue size must be positive");
    }

    RB_OBJ_WRITE(self, szqueue_list(sq), ary_buf_new());
    ccan_list_head_init(szqueue_waitq(sq));
    ccan_list_head_init(szqueue_pushq(sq));
    sq->max = max;

    return self;
}

Создаёт очередь фиксированной длины с максимальным размером max.

Открытые методы экземпляра

<<(object)
Псевдоним для: push
clear () Показать исходный код
static VALUE
rb_szqueue_clear(VALUE self)
{
    struct rb_szqueue *sq = szqueue_ptr(self);

    rb_ary_clear(check_array(self, sq->q.que));
    wakeup_all(szqueue_pushq(sq));
    return self;
}

Удаляет все объекты из очереди.

close Показать исходный код
static VALUE
rb_szqueue_close(VALUE self)
{
    if (!queue_closed_p(self)) {
        struct rb_szqueue *sq = szqueue_ptr(self);

        FL_SET(self, QUEUE_CLOSED);
        wakeup_all(szqueue_waitq(sq));
        wakeup_all(szqueue_pushq(sq));
    }
    return self;
}

Аналогичен методу Thread::Queue#close.

Отличие заключается в поведении при наличии ожидающих потоков, добавляющих элементы в очередь.

Если есть ожидающие потоки, добавляющие элементы в очередь, они прерываются вызовом исключения ClosedQueueError(‘queue closed’).

deq
Псевдоним для: pop
enq(object, non_block=false, timeout: nil)
Псевдоним для: push
max () Показать исходный код
static VALUE
rb_szqueue_max_get(VALUE self)
{
    return LONG2NUM(szqueue_ptr(self)->max);
}

Возвращает максимальный размер очереди.

max=(number) Показать исходный код
static VALUE
rb_szqueue_max_set(VALUE self, VALUE vmax)
{
    long max = NUM2LONG(vmax);
    long diff = 0;
    struct rb_szqueue *sq = szqueue_ptr(self);

    if (max <= 0) {
        rb_raise(rb_eArgError, "queue size must be positive");
    }
    if (max > sq->max) {
        diff = max - sq->max;
    }
    sq->max = max;
    sync_wakeup(szqueue_pushq(sq), diff);
    return vmax;
}

Устанавливает максимальный размер очереди равным заданному значению number.

num_waiting () Показать исходный код
static VALUE
rb_szqueue_num_waiting(VALUE self)
{
    struct rb_szqueue *sq = szqueue_ptr(self);

    return INT2NUM(sq->q.num_waiting + sq->num_waiting_push);
}

Возвращает количество потоков, ожидающих в очереди.

pop(non_block=false, timeout: nil) Показать исходный код
# File thread_sync.rb, line 38
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_szqueue_pop(non_block, timeout)
end

Извлекает данные из очереди.

Если очередь пуста, вызывающий поток приостанавливается до тех пор, пока данные не будут помещены в очередь. Если non_block имеет значение true, поток не приостанавливается, а вызывается исключение ThreadError.

Если прошло timeout секунд и данные недоступны, возвращается nil. Если timeout равно 0, метод возвращает результат немедленно.

Также имеет псевдонимы: deq, shift
push(object, non_block=false, timeout: nil) Показать исходный код
# File thread_sync.rb, line 61
def push(object, non_block = false, timeout: nil)
  if non_block && timeout
    raise ArgumentError, "can't set a timeout if non_block is enabled"
  end
  Primitive.rb_szqueue_push(object, non_block, timeout)
end

Помещает object в очередь.

Если в очереди нет свободного места, метод ожидает его появления, если только non_block не имеет значение true. Если non_block имеет значение true, поток не приостанавливается, а вызывается исключение ThreadError.

Если прошло timeout секунд и свободное место не появилось, возвращается nil. Если timeout равно 0, метод возвращает результат немедленно. В противном случае возвращается self.

Также имеет псевдонимы: enq, <<
shift
Псевдоним для: pop

Ruby Core © 1993–2025 Yukihiro Matsumoto
Licensed under the Ruby License.
Ruby Standard Library © contributors
Licensed under their own licenses.

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API