org.jruby.ext.thread

Class Queue

java.lang.Object

org.jruby.RubyBasicObject

org.jruby.RubyObject

org.jruby.ext.thread.Queue

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.lang.Comparable<IRubyObject>, InstanceVariables, InternalVariables, IRubyObject, CoreObjectType, DataType

Direct Known Subclasses:

SizedQueue

public class Queue
extends RubyObject
implements DataType

The "Queue" class from the 'thread' library. The implementation is a kernel of Doug Lea's LinkedBlockingQueue with Ruby related tweaks: closeable (blocks out producers, no effect on consumers) and capacity adjustable (Ruby allows sized_queue.max = 123 post construction). Relevant changes noted in comments below. An optionally-bounded blocking queue based on linked nodes. This queue orders elements FIFO (first-in-first-out). The head of the queue is that element that has been on the queue the longest time. The tail of the queue is that element that has been on the queue the shortest time. New elements are inserted at the tail of the queue, and the queue retrieval operations obtain elements at the head of the queue. Linked queues typically have higher throughput than array-based queues but less predictable performance in most concurrent applications.

The optional capacity bound constructor argument serves as a way to prevent excessive queue expansion. The capacity, if unspecified, is equal to Integer.MAX_VALUE. Linked nodes are dynamically created upon each insertion unless this would bring the queue above capacity.

Since:

1.5

Author:

Doug Lea

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.jruby.RubyObject

RubyObject.Data

Nested classes/interfaces inherited from class org.jruby.RubyBasicObject

RubyBasicObject.Finalizer

Field Summary

Fields

Modifier and Type	Field and Description
protected int	capacity The capacity bound, or Integer.MAX_VALUE if none
protected boolean	closed
protected java.util.concurrent.atomic.AtomicInteger	count Current number of elements
protected org.jruby.ext.thread.Queue.Node	last Tail of linked list.
protected java.util.concurrent.locks.Condition	notEmpty Wait queue for waiting takes
protected java.util.concurrent.locks.Condition	notFull Wait queue for waiting puts
protected java.util.concurrent.locks.ReentrantLock	putLock Lock held by put, offer, etc
protected java.util.concurrent.locks.ReentrantLock	takeLock Lock held by takeInternal, poll, etc

Fields inherited from class org.jruby.RubyObject

IVAR_INSPECTING_OBJECT_ALLOCATOR, OBJECT_ALLOCATOR, REIFYING_OBJECT_ALLOCATOR

Fields inherited from class org.jruby.RubyBasicObject

ALL_F, BASICOBJECT_ALLOCATOR, COMPARE_BY_IDENTITY_F, ERR_INSECURE_SET_INST_VAR, FALSE_F, FL_USHIFT, flags, FROZEN_F, IS_OVERLAID_F, metaClass, NEVER, NIL_F, REFINED_MODULE_F, STAMP_OFFSET, TAINTED_F, UNDEF, UNTRUST_F, USER0_F, USER1_F, USER2_F, USER3_F, USER4_F, USER5_F, USER6_F, USER7_F, USER8_F, USER9_F, USERA_F, VAR_TABLE_OFFSET, varTable, varTableStamp

Fields inherited from interface org.jruby.runtime.builtin.IRubyObject

NULL_ARRAY

Constructor Summary

Constructors

Constructor and Description
Queue(Ruby runtime, RubyClass type)

Method Summary

Modifier and Type	Method and Description
void	checkShutdown()
IRubyObject	clear(ThreadContext context) Atomically removes all of the elements from this queue.
protected void	clearInternal()
IRubyObject	close(ThreadContext context)
IRubyObject	closed_p(ThreadContext context)
protected void	closeInternal()
protected RaiseException	createInterruptedError(ThreadContext context, java.lang.String methodName)
protected IRubyObject	dequeue()
RubyBoolean	empty_p(ThreadContext context)
protected void	enqueue(org.jruby.ext.thread.Queue.Node node)
protected void	fullyLock() Locks to prevent both puts and takes.
protected void	fullyUnlock() Unlocks to allow both puts and takes.
IRubyObject	initialize(ThreadContext context)
protected void	initializedCheck()
boolean	isShutdown()
protected long	java_length()
RubyNumeric	length(ThreadContext context)
IRubyObject	marshal_dump(ThreadContext context)
RubyNumeric	num_waiting(ThreadContext context)
IRubyObject	pollInternal()
IRubyObject	pop(ThreadContext context)
IRubyObject	pop(ThreadContext context, IRubyObject arg0)
IRubyObject	push(ThreadContext context, IRubyObject value)
protected void	putInternal(ThreadContext context, IRubyObject e) Inserts the specified element at the tail of this queue, waiting if necessary for space to become available.
IRubyObject	raiseClosedError(ThreadContext context)
static void	setup(Ruby runtime)
void	shutdown()
protected void	signalNotEmpty() Signals a waiting takeInternal.
protected void	signalNotFull() Signals a waiting put.
protected IRubyObject	takeInternal(ThreadContext context)

Methods inherited from class org.jruby.RubyObject

attachToObjectSpace, callInit, callInit, callInit, callInit, callInit, callInit, callInit, callInit, callInit, callInit, convertToType, createObjectClass, dig, eqlInternal, equalInternal, equals, getNativeClassIndex, hashCode, inspect, op_eqq, puts, specificEval, toRubyString, toString

Methods inherited from class org.jruby.RubyBasicObject

addFinalizer, anyToString, asJavaString, asString, callMethod, callMethod, callMethod, callMethod, callMethod, callMethod, callMethod, callMethod, callMethod, callSuper, checkArrayType, checkCallMethod, checkCallMethod, checkFrozen, checkStringType, checkStringType19, compareTo, convertToArray, convertToFloat, convertToHash, convertToInteger, convertToInteger, convertToInteger, convertToString, copyInstanceVariablesInto, copySpecialInstanceVariables, createBasicObjectClass, dataGetStruct, dataGetStructChecked, dataWrapStruct, decode, display, dup, ensureInstanceVariablesSettable, eql_p, eql, equal_p, equal_p19, evalUnder, extend, fastGetInstanceVariable, fastGetInternalVariable, fastHasInstanceVariable, fastHasInternalVariable, fastSetInstanceVariable, fastSetInternalVariable, freeze, frozen_p, getFFIHandle, getFlag, getInstanceEvalClass, getInstanceVariable, getInstanceVariableList, getInstanceVariableNameList, getInstanceVariables, getInternalVariable, getInternalVariables, getJavaClass, getMetaClass, getMetaClass, getNativeHandle, getNativeTypeIndex, getObjectId, getRuntime, getSingletonClass, getSingletonClassClone, getSingletonClassCloneAndAttach, getType, getVariable, getVariableCount, getVariableList, getVariableNameList, hash, hashyInspect, hasInstanceVariable, hasInternalVariable, hasVariables, id, infectBy, initialize_copy, initialize19, inspect, inspectHashCode, instance_eval, instance_eval, instance_eval, instance_eval, instance_eval19, instance_eval19, instance_eval19, instance_eval19, instance_exec, instance_exec19, instance_of_p, instance_variable_defined_p, instance_variable_get, instance_variable_set, instance_variables, instance_variables19, isBuiltin, isClass, isFalse, isFrozen, isImmediate, isModule, isNil, isSpecialConst, isSpecialObject, isTaint, isTrue, isUntrusted, kind_of_p, makeMetaClass, method_missing, method_missing19, method, method19, methods, methods, methods19, nil_p, nonFixnumHashCode, OBJ_INIT_COPY, objInitCopy, op_cmp, op_equal_19, op_equal, op_match, op_match19, op_not_equal, op_not_match, op_not, private_methods, private_methods19, protected_methods, protected_methods19, public_methods, public_methods19, rbClone, rbClone, rbInspect, remove_instance_variable, removeFinalizers, removeInstanceVariable, removeInternalVariable, respond_to_p, respond_to_p, respond_to_p19, respond_to_p19, respondsTo, respondsToMissing, respondsToMissing, send, send, send, send, send, send19, send19, send19, send19, setFFIHandle, setFlag, setFrozen, setInstanceVariable, setInternalVariable, setMetaClass, setNativeHandle, setTaint, setUntrusted, setVariable, singleton_method_added, singleton_method_added19, singleton_method_removed, singleton_method_removed19, singleton_method_undefined, singleton_method_undefined19, singleton_method, singleton_methods, specificEval, specificEval, specificEval, specificEval, syncVariables, syncVariables, taint, taint, tainted_p, testFrozen, testFrozen, to_a, to_a, to_s, toJava, trust, type_deprecated, type, untaint, untrust, untrusted_p, validateInstanceVariable, validateInstanceVariable, validateInstanceVariable, variableTableContains, variableTableFastContains, variableTableFastFetch, variableTableFastStore, variableTableFetch, variableTableRemove, variableTableStore, variableTableSync, yieldUnder, yieldUnder

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.jruby.runtime.builtin.IRubyObject

array

Field Detail

closed

protected volatile boolean closed

capacity

protected volatile int capacity

The capacity bound, or Integer.MAX_VALUE if none

count

protected final java.util.concurrent.atomic.AtomicInteger count

Current number of elements

last

protected transient org.jruby.ext.thread.Queue.Node last

Tail of linked list. Invariant: last.next == null

takeLock

protected final java.util.concurrent.locks.ReentrantLock takeLock

Lock held by takeInternal, poll, etc

notEmpty

protected final java.util.concurrent.locks.Condition notEmpty

Wait queue for waiting takes

putLock

protected final java.util.concurrent.locks.ReentrantLock putLock

Lock held by put, offer, etc

notFull

protected final java.util.concurrent.locks.Condition notFull

Wait queue for waiting puts

Constructor Detail

Queue

public Queue(Ruby runtime,
             RubyClass type)

Method Detail

signalNotEmpty

protected void signalNotEmpty()

Signals a waiting takeInternal. Called only from put/offer (which do not otherwise ordinarily lock takeLock.)

signalNotFull

protected void signalNotFull()

Signals a waiting put. Called only from take/poll.

enqueue

protected void enqueue(org.jruby.ext.thread.Queue.Node node)

dequeue

protected IRubyObject dequeue()

fullyLock

protected void fullyLock()

Locks to prevent both puts and takes.

fullyUnlock

protected void fullyUnlock()

Unlocks to allow both puts and takes.

initializedCheck

protected void initializedCheck()

setup

public static void setup(Ruby runtime)

initialize

public IRubyObject initialize(ThreadContext context)

Overrides:

initialize in class RubyBasicObject

clear

public IRubyObject clear(ThreadContext context)

Atomically removes all of the elements from this queue. The queue will be empty after this call returns.

clearInternal

protected void clearInternal()
                      throws java.lang.InterruptedException

Throws:

java.lang.InterruptedException

empty_p

public RubyBoolean empty_p(ThreadContext context)

length

public RubyNumeric length(ThreadContext context)

num_waiting

public RubyNumeric num_waiting(ThreadContext context)

pop

public IRubyObject pop(ThreadContext context)

pop

public IRubyObject pop(ThreadContext context,
                       IRubyObject arg0)

push

public IRubyObject push(ThreadContext context,
                        IRubyObject value)

putInternal

protected void putInternal(ThreadContext context,
                           IRubyObject e)
                    throws java.lang.InterruptedException

Inserts the specified element at the tail of this queue, waiting if necessary for space to become available.

Throws:

java.lang.InterruptedException

java.lang.NullPointerException

marshal_dump

public IRubyObject marshal_dump(ThreadContext context)

close

public IRubyObject close(ThreadContext context)

closeInternal

protected void closeInternal()
                      throws java.lang.InterruptedException

Throws:

java.lang.InterruptedException

closed_p

public IRubyObject closed_p(ThreadContext context)

shutdown

public void shutdown()
              throws java.lang.InterruptedException

Throws:

java.lang.InterruptedException

isShutdown

public boolean isShutdown()

checkShutdown

public void checkShutdown()

java_length

protected long java_length()

takeInternal

protected IRubyObject takeInternal(ThreadContext context)
                            throws java.lang.InterruptedException

Throws:

java.lang.InterruptedException

pollInternal

public IRubyObject pollInternal()
                         throws java.lang.InterruptedException

Throws:

java.lang.InterruptedException

raiseClosedError

public IRubyObject raiseClosedError(ThreadContext context)

createInterruptedError

protected RaiseException createInterruptedError(ThreadContext context,
                                                java.lang.String methodName)