edu.snu.coral.runtime.executor.data.blocktransfer

Class ClosableBlockingQueue<T>

java.lang.Object

edu.snu.coral.runtime.executor.data.blocktransfer.ClosableBlockingQueue<T>

Type Parameters:

T - the type of elements

All Implemented Interfaces:

AutoCloseable

@ThreadSafe
public final class ClosableBlockingQueue<T>
extends Object
implements AutoCloseable

A blocking queue implementation which is capable of closing the input end.

Constructor Summary

Constructors

Constructor and Description
ClosableBlockingQueue() Creates a closable blocking queue.
ClosableBlockingQueue(int numElements) Creates a closable blocking queue.

Method Summary

Modifier and Type	Method and Description
void	close() Mark the input end of this queue as closed.
T	peek() Retrieves, but does not removes, the head of this queue, waiting if necessary.
void	put(T element) Adds an element.
T	take() Retrieves and removes the head of this queue, waiting if necessary.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ClosableBlockingQueue

public ClosableBlockingQueue()

Creates a closable blocking queue.

ClosableBlockingQueue

public ClosableBlockingQueue(int numElements)

Creates a closable blocking queue.

Parameters:

numElements - the lower bound on initial capacity of the queue

Method Detail

put

public void put(T element)

Adds an element.

Parameters:

element - the element to add

Throws:

IllegalStateException - if the input end of this queue has been closed

close

public void close()

Mark the input end of this queue as closed.

Specified by:

close in interface AutoCloseable

take

@Nullable
public T take()
                 throws InterruptedException

Retrieves and removes the head of this queue, waiting if necessary.

Returns:

the head of this queue, or null if no elements are there and this queue has been closed

Throws:

InterruptedException - when interrupted while waiting

peek

@Nullable
public T peek()
                 throws InterruptedException

Retrieves, but does not removes, the head of this queue, waiting if necessary.

Returns:

the head of this queue, or null if no elements are there and this queue has been closed

Throws:

InterruptedException - when interrupted while waiting