org.spf4j.base.ShutdownHooks Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of spf4j-core Show documentation

A continuously growing collection of utilities to measure performance, get better diagnostics, improve performance, or do things more reliably, faster that other open source libraries...

There is a newer version: 8.10.0

Show newest version

/*
 * Copyright (c) 2001-2017, Zoltan Farkas All Rights Reserved.
 *
 * This library 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 library 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 General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 *
 * Additionally licensed with:
 *
 * 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 org.spf4j.base;

import javax.annotation.CheckReturnValue;

/**
 *
 * @author Zoltan Farkas
 */
public interface ShutdownHooks {

  enum ShutdownPhase {

    NETWORK_SERVICES(1000), // http servers, etc...
    OBSERVABILITY_SERVICES(10000), // logging, metrics, profiling
    JVM_SERVICES(Integer.MAX_VALUE); // default executors, etc...

    ShutdownPhase(final int priority) {
      this.priority = priority;
    }

    private final int priority;

    public int getPriority() {
      return priority;
    }

  }

  @CheckReturnValue
  default boolean queueHook(ShutdownPhase phase, Runnable runnable) {
    return this.queueHook(phase.getPriority(), runnable);
  }

  @CheckReturnValue
  boolean queueHook(int priority, Runnable runnable);

  @CheckReturnValue
  default boolean queueHookAtBeginning(Runnable runnable) {
    return this.queueHook(Integer.MIN_VALUE, runnable);
  }

  @CheckReturnValue
  default boolean queueHookAtEnd(Runnable runnable) {
    return this.queueHook(Integer.MAX_VALUE, runnable);
  }

  boolean removeQueuedShutdownHook(Runnable runnable);

}