com.neeve.emx
Interface IEmxDispatcherRunCompletionChecker

All Known Subinterfaces:
ILnkContainerRunCompletionChecker

public interface IEmxDispatcherRunCompletionChecker

Interface through which the dispatcher run methods check for completion.

This interface is used by the dispatcher to check for completion of a dispatcher run. The method drives the dispatcher and queries isDone() after atleast one event is dispatched. Once isDone() returns true, the run methods query getCompletion() for the run completion data and return to the invoker of the dispatcher run.

Threading:
This class is always invoked by the owner thread of the dispatcher being run.

Method Summary
 Object getCompletion()
          Method queried for run completion data.
 boolean isDone()
          Method queried for completion of the run.
 

Method Detail

isDone

boolean isDone()
Method queried for completion of the run.

This method is invoked to query the completion of the dispatcher run. The implementation should return true in case the run loop should return. Upon returning true, the run method will query for the completion object via getCompletion() and return the completion object from the run method.

Threading:
This method is always invoked by the owner thread of the dispatcher being run.

getCompletion

Object getCompletion()
                     throws Exception
Method queried for run completion data.

Throws:
Exception - Any exception thrown is rethrown by the run method.

This method is queried for completion data after isDone() returns true. The object returned or the exception thrown by this method are returned/thrown by the run method.

Threading:
This method is always invoked by the owner thread of the dispatcher being run.


Copyright © 2015 Neeve Research, LLC. All Rights Reserved.