diff --git a/src/main/java/teetime/framework/pipe/InterThreadPipe.java b/src/main/java/teetime/framework/pipe/InterThreadPipe.java index 0825c2809b8d72590c4f3852a80b825b87f44124..258b6412f9e1447ac8b1bcb9cb947c624ef41a91 100644 --- a/src/main/java/teetime/framework/pipe/InterThreadPipe.java +++ b/src/main/java/teetime/framework/pipe/InterThreadPipe.java @@ -24,6 +24,11 @@ public abstract class InterThreadPipe extends AbstractPipe { this.signalQueue.offer(signal); } + /** + * Retrieves and removes the head of the signal queue + * + * @return Head of signal queue, <code>null</code> if signal queue is empty. + */ public ISignal getSignal() { return this.signalQueue.poll(); }