com.hazelcast.spi

Interface WaitNotifyService

All Known Subinterfaces:

InternalWaitNotifyService

All Known Implementing Classes:

WaitNotifyServiceImpl

public interface WaitNotifyService

A service for an object where one can wait on, like ICondition or ILock when a thread needs to wait for a lock to be released.

Method Summary

Methods

Modifier and Type	Method and Description
void	await(WaitSupport waitSupport) Causes the current operation to wait in WaitNotifyService until it is notified by a Notifier operation or timeout specified by WaitSupport.getWaitTimeout() passes.
void	notify(Notifier notifier) Notifies the waiting WaitSupport operation to wake-up and continue executing.

Method Detail

await

void await(WaitSupport waitSupport)

Causes the current operation to wait in WaitNotifyService until it is notified by a Notifier operation or timeout specified by WaitSupport.getWaitTimeout() passes.

WaitSupport operation will be registered using WaitNotifyKey returned from method WaitSupport.getWaitKey().

When operation is notified, it's re-executed by related scheduled mechanism.

If wait time-outs, WaitSupport.onWaitExpire() method is called.

This method should be called in the thread executes the actual WaitSupport operation.

Parameters:

waitSupport - operation which will wait for notification

notify

void notify(Notifier notifier)

Notifies the waiting WaitSupport operation to wake-up and continue executing.

A waiting operation registered with the Notifier.getNotifiedKey() will be notified and deregistered. This method has no effect if there isn't any operation registered for related WaitNotifyKey.

This method should be called in the thread executes the actual Notifier operation.

Parameters:

notifier - operation which will notify a corresponding waiting operation