Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

org.wegra.util.collection
Class BlockingQueue

java.lang.Object
  extended byorg.wegra.util.collection.BlockingQueue
public final class BlockingQueue
extends java.lang.Object

스레드에 안전한 큐로 큐가 비어잇는 상태에서 원소를 빼내려고 하면 블록킹되는 큐이다. LinkedList 를 비반으로 작성되어 JDK 1.2 전 버전에서는 사용할 수 없다. 용량에는 제한이 없다(즉, 큐가 가득차서 블록킹 되는 경우는 발생하지 않는다).

Version:
1.0 (2001-08-14)
Author:
wegra(Bok-Youn Lee)

Nested Class Summary
static class BlockingQueue.Test
          테스크용 클래스
 
Constructor Summary
BlockingQueue()
          Creates a BlockingQueue has unlimited size.
BlockingQueue(int maxSize)
          Creates a BlockingQueue has specific maximum size.
 
Method Summary
 void close()
          블록킹 큐의 사용을 종료한다.
 java.lang.Object dequeue()
          dequeue(long)에 타임아웃을 wegra.thread.asynch.Lock.TIMEOUT_FOREVER로 주어 호출한다.
 java.lang.Object dequeue(long timeout)
          원소를 큐로부터 제거한다.
 void enqueue(java.lang.Object element)
          원소를 큐에 추가한다.
 void enqueue(java.lang.Object element, long timeout)
          편의상 작성된 메소드로 enqueue(Object, long, Runnable) 메소드의 onRemoval 인자값을 null로 주어 호출한다.
 void enqueue(java.lang.Object element, long timeout, java.lang.Runnable onRemoval)
          최대 "timeout" 밀리초 동안 큐에 있을 원소를 추가한다.
 void enqueueFinal(java.lang.Object element)
          이 메소드를 통해 원소가 큐에 추가되고 나면 이후에는 어떤 원소도 큐에 추가되지 못하게 된다.
 int getWaitingThreadsCount()
          현재 큐에서 메시지를 기다리고 있는 큐의 개수를 반환한다.
 boolean isEmpty()
          [주의] 기본적으로 isEmpty() 메소드는 멀티스레드 환경에서 스레드에 안전하지 않다.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

BlockingQueue

public BlockingQueue()
Creates a BlockingQueue has unlimited size.

BlockingQueue

public BlockingQueue(int maxSize)
Creates a BlockingQueue has specific maximum size.

Parameters:
maxSize - maximum size of queue.
Method Detail

close

public void close()
블록킹 큐의 사용을 종료한다. 이 때 블록킹되어 있던 모든 스레드의 락은 풀리게 된다. 이후 dequeue() 메소드를 호출하면 정상적으로 복귀하는 대신 ClosedQueueException 이 발생한다. 한번 큐가 종료되고 나면 enqueue() 메소드를 호출할 때에도 마찬가지로 ClosedQueueException 이 발생한다. 큐가 종료될 때 큐는 비워지므로 큐 안에 있던 모든 객체 중 오직 큐가 유일하게 참조하고 있던 객체였다면 가비지 콜렉팅이 가능하다.

dequeue

public java.lang.Object dequeue()
                         throws java.lang.InterruptedException,
                                ClosedQueueException,
                                TimeoutException
dequeue(long)에 타임아웃을 wegra.thread.asynch.Lock.TIMEOUT_FOREVER로 주어 호출한다.

Throws:
java.lang.InterruptedException
ClosedQueueException
TimeoutException

dequeue

public java.lang.Object dequeue(long timeout)
                         throws java.lang.InterruptedException,
                                ClosedQueueException,
                                TimeoutException
원소를 큐로부터 제거한다. 이 때 큐가 비어있다면 큐에 뭔가 잘 때까지 블록킹된다. 이 메소드를 호출할 때에는 충첩된 모니터에 의한 교착상태에 유의해야 한다. 즉, 이 메소드를 동기화된 메소드 내에서 부른 경우라면 메소드 이외의 곳에서 큐에 원소를 집어넣을 수 있는 방법이 제공되어야만 한다. 잠재적인 경쟁 상태의 위험성 때문에 타임아웃은 지원되지 않는다. (자세한 내용은 Taming Java Threads 책을 참고하자) 블록킹 되어 있는 스레드라도 Thread.interrupt()를 사용한다면 블록킹을 취소할 수 있다.

Parameters:
timeout - 밀리초 단위의 타임아웃. 영원히 기다리고 싶을 경우에는 wegra.thead.asynch.Lock.TIMEOUT_FOREVER 나 Long.MAX_VALUE 를 사용하자.
Returns:
큐로부터 제거된 원소를 반환하거나 null을 반환한다. 타임아웃이 발생했거나 제거된 원소가 없을 경우 null을 반환한다.
Throws:
java.lang.InterruptedException - 블록킹되어 있을 때 인터럽트되면 발생한다.
wegra.thread.asynch.TimeoutException - 블릭킹되어 있는 상태에서 타임아웃이 걸리면 발생한다.
ClosedQueueException - 큐가 종료된 상태에서 호출되는 경우 발생한다.
TimeoutException

enqueue

public void enqueue(java.lang.Object element)
             throws ClosedQueueException,
                    QueueOverflowException
원소를 큐에 추가한다.

Throws:
ClosedQueueException
QueueOverflowException

enqueue

public void enqueue(java.lang.Object element,
                    long timeout)
편의상 작성된 메소드로 enqueue(Object, long, Runnable) 메소드의 onRemoval 인자값을 null로 주어 호출한다.

enqueue

public void enqueue(java.lang.Object element,
                    long timeout,
                    java.lang.Runnable onRemoval)
최대 "timeout" 밀리초 동안 큐에 있을 원소를 추가한다. 인자로 주어진 onRemoval 객체의 run() 메소드는 원소가 큐로부터 제거되면 호출된다. 만약 어떤 우넛과 한 번 이상 추가될 경우 먼저 추가되었던 원소는 제거된다.

Parameters:
element - 추가될 원소
timeout - 원소가 큐에 최대로 있을 수 있는 시간. (더 높은 우선 순위의 스레드가 실행 중인 경우에는 타임아웃이 발생하는 시간은 정확하지 않을 수도 있다)
onRemoval - null로 지정되지 않은 경우 원소가 타임아웃에 의해 큐로부터 제거될 때 이 객체의 run() 메소드가 호출된다.

enqueueFinal

public void enqueueFinal(java.lang.Object element)
                  throws ClosedQueueException
이 메소드를 통해 원소가 큐에 추가되고 나면 이후에는 어떤 원소도 큐에 추가되지 못하게 된다. 추가된 모든 원소가 큐로부터 빠져나가고 나면 큐는 자동으로 종료된다.

Throws:
ClosedQueueException

getWaitingThreadsCount

public int getWaitingThreadsCount()
현재 큐에서 메시지를 기다리고 있는 큐의 개수를 반환한다. 동기화와 관련하여 isEmpty() 와 비슷한 문제점을 가지고 있으므로 주의해서 사용하길 바란다.

isEmpty

public boolean isEmpty()
[주의] 기본적으로 isEmpty() 메소드는 멀티스레드 환경에서 스레드에 안전하지 않다. 다음과 같은 코드라면 테스트를 마친 후 아직 큐에서 원소를 제거하지 않은 상태에서 다른 스레드에게 제어권이 넘어가서 먼저 원소를 제거해버릴 수도 있다. 
	BlockingQueue queue = new BlockingQueue();
	//...
	if ( !queue.isEmptyt() ) {
		queue.dequeue();
	}
따라서, 스레드에 안전하기 위해서는 위의 코드를 다음과 같이 수정해야 한다. 
	BlockingQueue quque = new BlockingQueue();
	//...
	synchronized( queue ) {
		if ( queue.isEmpty() ) {
			queue.dequeue();
		}
	}
위의 코드와 같이 하면 테스트와 큐에서 원소를 빼내는 작업이 차례차례 일어난다.

Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD