org.lsst.ccs.subsystem.shutter.statemachine

Interface EventReply

All Known Implementing Classes:

FutureReply

public interface EventReply

Response to an event, returned by event methods in states and contexts.

Author:

tether

Method Summary

Modifier and Type	Method and Description
static EventReply	accepted() Returns an event reply for which wasAccepted() returns true and does not block.
String	getMessage() Gets a short string describing the acceptance or rejection.
boolean	wasAccepted(Duration timeout) Gets a boolean flag, blocking if need be, which tells whether an event was accepted.

Method Detail

accepted

static EventReply accepted()

Returns an event reply for which wasAccepted() returns true and does not block.

Returns:

The reply instance.

wasAccepted

boolean wasAccepted(Duration timeout)
             throws InterruptedException,
                    TimeoutException

Gets a boolean flag, blocking if need be, which tells whether an event was accepted.

Parameters:

timeout - How long to wait for the decision.

Returns:

true if the event was accepted, false if timeout or event was rejected.

Throws:

InterruptedException - if interrupted.

TimeoutException - if the wait times out.

See Also:

getMessage()

getMessage

String getMessage()
           throws InterruptedException

Gets a short string describing the acceptance or rejection.

Returns:

The string.

Throws:

InterruptedException

IllegalStateException - if wasAccepted() wasn't called or threw an exception.

See Also:

#wasAccepted()