jadex.commons.future

Interface ISuspendable

All Known Implementing Classes:

AbstractInitiatorPlan, AbstractReceiverPlan, AnswerPingPlan, CMApproveCancelPlan, CMHandlerPlan, CMInitiatorPlan, CMSCreateComponentPlan, CMSDestroyComponentPlan, CMSLocalCreateComponentPlan, CMSLocalDestroyComponentPlan, CMSLocalGetExternalAccessPlan, CMSLocalResumeComponentPlan, CMSLocalSearchComponentsPlan, CMSLocalShutdownPlatformPlan, CMSLocalSuspendComponentPlan, CMSLocalUpdateComponentsPlan, CMSRemoteCreateComponentPlan, CMSRemoteDestroyComponentPlan, CMSRemoteResumeComponentPlan, CMSRemoteSearchComponentsPlan, CMSRemoteShutdownPlatformPlan, CMSRemoteSuspendComponentPlan, CMSResumeComponentPlan, CMSSearchComponentsPlan, CMSShutdownPlatformPlan, CMSSuspendComponentPlan, CNPEvaluateProposalsPlan, CNPInitiatorPlan, CNPQueryNextroundInfoPlan, CNPReceiverPlan, DAInitiatorPlan, DAReceiverPlan, DFDeregisterPlan, DFLocalDeregisterPlan, DFLocalModifyPlan, DFLocalRegisterPlan, DFLocalSearchPlan, DFModifyPlan, DFRegisterPlan, DFRemoteDeregisterPlan, DFRemoteModifyPlan, DFRemoteRegisterPlan, DFRemoteSearchPlan, DFSearchPlan, DoPingPlan, EAInitiatorPlan, EAReceiverPlan, FinishedPlan, InteractionGoalCreationPlan, NotifyAdminPlan, NotUnderstoodPlan, ObserveAgentPlan, ParallelActivationPlan, PingingPlan, Plan, RPInitiatorPlan, RPQPInitiatorPlan, RPQPReceiverPlan, RPReceiverPlan, SendEmailPlan, SendICQPlan, SendXMPPPlan, SequentialActivationPlan, SPHandleUpdatePlan, SPInitiationPlan, SPReceptionPlan, SPSubmitUpdatePlan, StartAndMonitorProcessPlan, ThreadSuspendable

public interface ISuspendable

Interface for suspendable entities. Is used by the IFuture to suspend callers.

Method Summary

Methods

Modifier and Type	Method and Description
Object	getMonitor() Get the monitor for waiting.
void	resume(IFuture<?> future) Resume the execution of the suspendable.
void	suspend(IFuture<?> future, long timeout) Suspend the execution of the suspendable.

Method Detail

suspend

void suspend(IFuture<?> future,
           long timeout)

Suspend the execution of the suspendable.

Parameters:

future - The future to wait for.

timeout - The timeout.

resume

void resume(IFuture<?> future)

Resume the execution of the suspendable.

Parameters:

future - The future that issues the resume.

getMonitor

Object getMonitor()

Get the monitor for waiting.

Returns:

The monitor.