org.jlab.coda.emu

Class EmuEventNotify

java.lang.Object

org.jlab.coda.emu.EmuEventNotify

public class EmuEventNotify
extends java.lang.Object

This class is designed for allowing the Emu to wait until a DataChannel or Transport or Module has received a desired event. An object of this class can only be used once (created and then endWait() called), before the reset() method needs to be called in order to be able to call endWait() again.

Author:

timmer Date: 4/22/13

Constructor Summary

Constructors

Constructor and Description
EmuEventNotify() Constructor with default wait time of 1 seconds.

Method Summary

Modifier and Type	Method and Description
void	endWait() This method allows the waitForEvent() method to return immediately.
void	reset() This method enables reuse of this object.
void	waitForEvent() This method waits indefinitely for the endWait() method to be called before it returns.
boolean	waitForEvent(long timeout, java.util.concurrent.TimeUnit unit) This method waits for the endWait() method to be called or for the timeout to expire before it returns.

Methods inherited from class java.lang.Object

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

Constructor Detail

EmuEventNotify

public EmuEventNotify()

Constructor with default wait time of 1 seconds.

Method Detail

reset

public void reset()

This method enables reuse of this object. Call this before endWait and waitForEvent.

endWait

public void endWait()

This method allows the waitForEvent() method to return immediately.

waitForEvent

public void waitForEvent()
                  throws java.lang.InterruptedException

This method waits indefinitely for the endWait() method to be called before it returns.

Throws:

java.lang.InterruptedException - if interrupted during wait

waitForEvent

public boolean waitForEvent(long timeout,
                            java.util.concurrent.TimeUnit unit)
                     throws java.lang.InterruptedException

This method waits for the endWait() method to be called or for the timeout to expire before it returns.

Parameters:

timeout - the maximum time to wait

unit - the time unit of the timeout argument

Returns:

true if endWait() called and false if the waiting time elapsed before endWait() called

Throws:

java.lang.InterruptedException - if interrupted during wait