org.apache.giraph.zk

Interface BspEvent

All Known Implementing Classes:

PredicateLock

public interface BspEvent

Synchronize on waiting for an event to have happened. This is a one-time event.

Method Summary

Modifier and Type	Method and Description
void	reset() Reset the permanent signal.
void	signal() The event occurred and the occurrence has been logged for future waiters.
void	waitForTimeoutOrFail(long timeout) Waits until timeout or fails with runtime exception.
boolean	waitMsecs(int msecs) Wait until the event occurred or waiting timed out.

Method Detail

reset

void reset()

Reset the permanent signal.

signal

void signal()

The event occurred and the occurrence has been logged for future waiters.

waitMsecs

boolean waitMsecs(int msecs)

Wait until the event occurred or waiting timed out.

Parameters:

msecs - Milliseconds to wait until the event occurred. 0 indicates check immediately. -1 indicates wait forever.

Returns:

true if event occurred, false if timed out while waiting

waitForTimeoutOrFail

void waitForTimeoutOrFail(long timeout)

Waits until timeout or fails with runtime exception.

Parameters:

timeout - Throws exception if waiting takes longer than timeout.