Rendezvous.java

/*
 * Copyright 2012 The Solmix Project
 *
 * This is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation; either version 2.1 of
 * the License, or (at your option) any later version.
 *
 * This software is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 *
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * http://www.gnu.org/licenses/ 
 * or see the FSF site: http://www.fsf.org. 
 */

package org.solmix.eventservice.deliver;

import java.util.concurrent.BrokenBarrierException;
import java.util.concurrent.CyclicBarrier;
import java.util.concurrent.TimeUnit;
import java.util.concurrent.TimeoutException;

/**
 * Create a set of tasks that they perform work in parallel and then wait before proceeding to the next step until all
 * tasks are completed. This allows all of the concurrent tasks are lined up at the fence, so you can move forward
 * consistent.
 * <p>
 * 创建一组任务,它们并行地执行工作，然后在进行下一个步骤之前等待，直至所有任务都完成。这使得所有的并发任务都将在栅栏处列队，因此可以一致的向前移动。
 * 
 * @author solmix.f@gmail.com
 * @version 110035 2011-10-2
 */

public class Rendezvous extends CyclicBarrier
{

    /** Flag for timeout handling. */
    private volatile boolean timedout = false;

    /**
     * Create a Barrier for the indicated number of parties, and the default Rotator function to run at each barrier
     * point.
     */
    public Rendezvous()
    {
        super(2);
    }

    /**
     * see {@link CyclicBarrier#barrier()}
     */
    public void waitForRendezvous() {
        if (timedout) {
            // if we have timed out, we return immediately
            return;
        }
        try {
            this.await();
        } catch (BrokenBarrierException ignore1) {
        } catch (InterruptedException ignore2) {
        }
    }

   
    /**
     * @param timeout
     * @throws TimeoutException
     */
    public void waitAttemptForRendezvous(final long timeout) throws TimeoutException {
        try {
            this.await(timeout, TimeUnit.MILLISECONDS);
            // rest timeout.
            this.reset();
        } catch (BrokenBarrierException ignore1) {
        } catch (TimeoutException te) {
            timedout = true;
            throw te;
        } catch (InterruptedException ignore2) {
        }
    }
}