класс Thread::SizedQueue

Родитель:: Объект

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

См. Thread::Queue для примера работы Thread::SizedQueue.

Общедоступные методы класса

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(‘очередь закрыта’).

deq

Псевдоним для: pop

empty? Показать исходный код

static VALUE
rb_szqueue_empty_p(VALUE self)
{
    struct rb_szqueue *sq = szqueue_ptr(self);

    return RBOOL(queue_length(self, &sq->q) == 0);
}

Возвращает true, если очередь пуста.

enq(object, non_block=false, timeout: nil)

Псевдоним для: push

freeze Показать исходный код

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

Очередь нельзя заморозить, поэтому этот метод вызывает исключение:

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

length

size

static VALUE
rb_szqueue_length(VALUE self)
{
    struct rb_szqueue *sq = szqueue_ptr(self);

    return LONG2NUM(queue_length(self, &sq->q));
}

Возвращает длину очереди.

Также псевдоним для: size

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 36
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 59
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

length

size

Возвращает длину очереди.

Псевдоним для: length

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