001/*
002 * The contents of this file are subject to the terms of the Common Development and
003 * Distribution License (the License). You may not use this file except in compliance with the
004 * License.
005 *
006 * You can obtain a copy of the License at legal/CDDLv1.0.txt. See the License for the
007 * specific language governing permission and limitations under the License.
008 *
009 * When distributing Covered Software, include this CDDL Header Notice in each file and include
010 * the License file at legal/CDDLv1.0.txt. If applicable, add the following below the CDDL
011 * Header, with the fields enclosed by brackets [] replaced by your own identifying
012 * information: "Portions Copyright [year] [name of copyright owner]".
013 *
014 * Copyright 2013-2014 ForgeRock AS.
015 */
016package org.forgerock.opendj.ldap;
017
018/**
019 * Listener on timeout events.
020 * <p>
021 * The listener must register itself with a {@code TimeoutChecker} using
022 * {@code TimeoutChecker#addListener()} method to be called back with
023 * {@code #handleTimeout} method.
024 * <p>
025 * The listener must deregister itself using
026 * {@code TimeoutChecker#removeListener()} to stop being called back.
027 */
028public interface TimeoutEventListener {
029
030    /**
031     * Handle a timeout event.
032     *
033     * @param currentTime
034     *            Time to use as current time for any check.
035     * @return The delay to wait before next timeout callback in milliseconds,
036     *         or zero if this listener should no longer be notified.
037     */
038    long handleTimeout(long currentTime);
039
040    /**
041     * Returns the timeout for this listener.
042     *
043     * @return The timeout in milliseconds.
044     */
045    long getTimeout();
046
047}