类 Thread::SizedQueue
此类表示指定大小容量的队列。如果容量已满,则 push 操作可能会被阻塞。
请参阅 Thread::Queue
,了解 Thread::SizedQueue
的工作原理示例。
公共类方法
new(max) 点击切换源代码
创建一个固定长度的队列,最大大小为 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; }
公共实例方法
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 点击切换源代码
类似于 Thread::Queue#close
。
不同之处在于等待入队的线程的行为。
如果有等待入队的线程,它们将被中断并引发 ClosedQueueError(‘queue closed’)。
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; }
deq
别名:pop
empty? 点击切换源代码
如果队列为空,则返回 true
。
static VALUE rb_szqueue_empty_p(VALUE self) { struct rb_szqueue *sq = szqueue_ptr(self); return RBOOL(queue_length(self, &sq->q) == 0); }
freeze 点击切换源代码
队列不能被冻结,因此此方法会引发异常
Thread::Queue.new.freeze # Raises TypeError (cannot freeze #<Thread::Queue:0x...>)
static VALUE rb_queue_freeze(VALUE self) { rb_raise(rb_eTypeError, "cannot freeze " "%+"PRIsVALUE, self); UNREACHABLE_RETURN(self); }
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) 点击切换源代码
将队列的最大大小设置为给定的 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; }
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) 点击切换源代码
从队列中检索数据。
如果队列为空,调用线程将被挂起,直到数据被推送到队列中。如果 non_block
为真,线程不会被挂起,并且会引发 ThreadError
。
如果 timeout
秒过去且没有数据可用,则返回 nil
。如果 timeout
为 0
,则立即返回。
# 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
push(object, non_block=false, timeout: nil) 点击切换源代码
将 object
推送到队列中。
如果队列中没有空间,则会等待直到有空间可用,除非 non_block
为真。如果 non_block
为真,线程不会被挂起,并且会引发 ThreadError
。
如果 timeout
秒过去且没有空间可用,则返回 nil
。如果 timeout
为 0
,则立即返回。否则返回 self
。
# 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
shift
别名:pop