com.hazelcast.spi.impl.waitnotifyservice.WaitNotifyService Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of hazelcast-all Show documentation
There is a newer version: 3.9.3
/*
 * Copyright (c) 2008-2016, Hazelcast, Inc. All Rights Reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.hazelcast.spi.impl.waitnotifyservice;

import com.hazelcast.spi.BlockingOperation;
import com.hazelcast.spi.Notifier;

/**
 * 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.
 */
public interface WaitNotifyService {

    String SERVICE_NAME = "hz:impl:waitNotifyService";

    /**
     * Causes the current operation to wait in WaitNotifyService until it is notified
     * by a {@link com.hazelcast.spi.Notifier} operation or timeout specified by
     * {@link BlockingOperation#getWaitTimeout()} passes.
     * 
     * {@link BlockingOperation} operation will be registered using {@link com.hazelcast.spi.WaitNotifyKey}
     * returned from method {@link BlockingOperation#getWaitKey()}.
     * 

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

     * If wait time-outs, {@link BlockingOperation#onWaitExpire()} method is called.
     * 

     * This method should be called in the thread executes the actual {@link BlockingOperation} operation.
     *
     * @param blockingOperation operation which will wait for notification
     */
    void await(BlockingOperation blockingOperation);

    /**
     * Notifies the waiting {@link BlockingOperation} operation to wake-up and continue executing.
     * 

     * A waiting operation registered with the {@link Notifier#getNotifiedKey()} will be notified and deregistered.
     * This method has no effect if there isn't any operation registered
     * for related {@link com.hazelcast.spi.WaitNotifyKey}.
     * 
     * This method should be called in the thread executes the actual {@link com.hazelcast.spi.Notifier} operation.
     *
     * @param notifier operation which will notify a corresponding waiting operation
     */
    void notify(Notifier notifier);

    void cancelWaitingOps(String serviceName, Object objectId, Throwable cause);
}