Timeout.java

/* ***** BEGIN LICENSE BLOCK *****
 * Version: MPL 1.1/GPL 2.0/LGPL 2.1
 *
 * The contents of this file are subject to the Mozilla Public License Version
 * 1.1 (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.mozilla.org/MPL/
 *
 * Software distributed under the License is distributed on an "AS IS" basis,
 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
 * for the specific language governing rights and limitations under the
 * License.
 *
 * The Original Code is part of dcm4che, an implementation of DICOM(TM) in
 * Java(TM), hosted at https://github.com/gunterze/dcm4che.
 *
 * The Initial Developer of the Original Code is
 * Agfa Healthcare.
 * Portions created by the Initial Developer are Copyright (C) 2012
 * the Initial Developer. All Rights Reserved.
 *
 * Contributor(s):
 * See @authors listed below
 *
 * Alternatively, the contents of this file may be used under the terms of
 * either the GNU General Public License Version 2 or later (the "GPL"), or
 * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
 * in which case the provisions of the GPL or the LGPL are applicable instead
 * of those above. If you wish to allow use of your version of this file only
 * under the terms of either the GPL or the LGPL, and not to allow others to
 * use your version of this file under the terms of the MPL, indicate your
 * decision by deleting the provisions above and replace them with the notice
 * and other provisions required by the GPL or the LGPL. If you do not delete
 * the provisions above, a recipient may use your version of this file under
 * the terms of any one of the MPL, the GPL or the LGPL.
 *
 * ***** END LICENSE BLOCK ***** */

package org.dcm4che3.net;

import java.util.concurrent.ScheduledFuture;
import java.util.concurrent.TimeUnit;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

/**
 * Schedules an association.abort() on the given association
 * using the scheduledExecutor assigned to the device of that association.
 *
 * @author Gunter Zeilinger <gunterze@gmail.com>
 *
 */
public class Timeout implements Runnable {

    public static Logger LOG = LoggerFactory.getLogger(Timeout.class);

    private final Association as;
    private final String expiredMsg;
    private final String cancelMsg;
    private final ScheduledFuture<?> future;
    
    private Timeout(Association as, String expiredMsg, String cancelMsg,
            int timeout) {
        this.as = as;
        this.expiredMsg = expiredMsg;
        this.cancelMsg = cancelMsg;
        this.future = as.getDevice()
                .schedule(this, timeout, TimeUnit.MILLISECONDS);
    }

    public static Timeout start(Association as, String startMsg,
            String expiredMsg, String cancelMsg, int timeout) {
        LOG.debug(startMsg, as, timeout);
        return new Timeout(as, expiredMsg, cancelMsg, timeout);
    }

    /**
     * Permanently cancels the potential effect of the timeout
     */
    public void stop() {
        LOG.debug(cancelMsg, as);
        future.cancel(false);
    }

    @Override
    public void run() {
        LOG.warn(expiredMsg, as);
        as.abort();
    }

}