class SizedQueue
This class represents queues of specified size capacity. The push operation may be blocked if the capacity is full.
See Queue for an example of how a SizedQueue works.
Public Class Methods
new(max)
click to toggle source
Creates a fixed-length queue with a maximum size of max
.
static VALUE rb_szqueue_initialize(VALUE self, VALUE vmax) { long max; max = NUM2LONG(vmax); if (max <= 0) { rb_raise(rb_eArgError, "queue size must be positive"); } RSTRUCT_SET(self, QUEUE_QUE, ary_buf_new()); RSTRUCT_SET(self, QUEUE_WAITERS, ary_buf_new()); RSTRUCT_SET(self, SZQUEUE_WAITERS, ary_buf_new()); RSTRUCT_SET(self, SZQUEUE_MAX, vmax); return self; }
Public Instance Methods
clear()
click to toggle source
Removes all objects from the queue.
static VALUE rb_szqueue_clear(VALUE self) { rb_ary_clear(GET_QUEUE_QUE(self)); wakeup_all_threads(GET_SZQUEUE_WAITERS(self)); return self; }
max()
click to toggle source
Returns the maximum size of the queue.
static VALUE rb_szqueue_max_get(VALUE self) { return GET_SZQUEUE_MAX(self); }
max=(number)
click to toggle source
Sets the maximum size of the queue to the given number
.
static VALUE rb_szqueue_max_set(VALUE self, VALUE vmax) { long max = NUM2LONG(vmax), diff = 0; VALUE t; if (max <= 0) { rb_raise(rb_eArgError, "queue size must be positive"); } if ((unsigned long)max > GET_SZQUEUE_ULONGMAX(self)) { diff = max - GET_SZQUEUE_ULONGMAX(self); } RSTRUCT_SET(self, SZQUEUE_MAX, vmax); while (diff-- > 0 && !NIL_P(t = rb_ary_shift(GET_SZQUEUE_WAITERS(self)))) { rb_thread_wakeup_alive(t); } return vmax; }
num_waiting()
click to toggle source
Returns the number of threads waiting on the queue.
static VALUE rb_szqueue_num_waiting(VALUE self) { long len = queue_num_waiting(self); len += RARRAY_LEN(GET_SZQUEUE_WAITERS(self)); return ULONG2NUM(len); }
pop(non_block=false)
click to toggle source
deq(non_block=false)
shift(non_block=false)
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.
static VALUE rb_szqueue_pop(int argc, VALUE *argv, VALUE self) { VALUE should_block = queue_pop_should_block(argc, argv); return szqueue_do_pop(self, should_block); }
push(object)
click to toggle source
enq(object)
<<(object)
Pushes object
to the queue.
If there is no space left in the queue, waits until space becomes available.
static VALUE rb_szqueue_push(VALUE self, VALUE obj) { struct waiting_delete args; args.waiting = GET_SZQUEUE_WAITERS(self); args.th = rb_thread_current(); while (queue_length(self) >= GET_SZQUEUE_ULONGMAX(self)) { rb_ary_push(args.waiting, args.th); rb_ensure((VALUE (*)())rb_thread_sleep_deadly, (VALUE)0, queue_delete_from_waiting, (VALUE)&args); } return queue_do_push(self, obj); }