/*
 * Copyright (c) 2011-2017 Contributors to the Eclipse Foundation
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License 2.0 which is available at
 * http://www.eclipse.org/legal/epl-2.0, or the Apache License, Version 2.0
 * which is available at https://www.apache.org/licenses/LICENSE-2.0.
 *
 * SPDX-License-Identifier: EPL-2.0 OR Apache-2.0
 */

package io.vertx.core.impl;

import io.vertx.core.AsyncResult;
import io.vertx.core.Closeable;
import io.vertx.core.Future;
import io.vertx.core.Handler;
import io.vertx.core.Promise;
import io.vertx.core.logging.Logger;

import java.util.HashSet;
import java.util.Set;
import java.util.concurrent.atomic.AtomicBoolean;
import java.util.concurrent.atomic.AtomicInteger;

Author:Julien Viet
/** * @author <a href="mailto:julien@julienviet.com">Julien Viet</a> */
class CloseHooks { private final Logger log; private boolean closeHooksRun; private Set<Closeable> closeHooks; CloseHooks(Logger log) { this.log = log; }
Add a close hook, notified when the run(Handler<AsyncResult<Void>>) method is called.
Params:
  • hook – the hook to add
/** * Add a close hook, notified when the {@link #run(Handler)} method is called. * * @param hook the hook to add */
synchronized void add(Closeable hook) { if (closeHooks == null) { // Has to be concurrent as can be removed from non context thread closeHooks = new HashSet<>(); } closeHooks.add(hook); }
Remove an existing hook.
Params:
  • hook – the hook to remove
Returns: true if the hook was removed
/** * Remove an existing hook. * * @param hook the hook to remove * @return {@code} true if the hook was removed */
synchronized boolean remove(Closeable hook) { if (closeHooks != null) { return closeHooks.remove(hook); } else { return false; } }
Run the close hooks.
Params:
  • completionHandler – called when all hooks have beene executed
/** * Run the close hooks. * * @param completionHandler called when all hooks have beene executed */
void run(Handler<AsyncResult<Void>> completionHandler) { Set<Closeable> copy = null; synchronized (this) { if (closeHooksRun) { // Sanity check throw new IllegalStateException("Close hooks already run"); } closeHooksRun = true; if (closeHooks != null && !closeHooks.isEmpty()) { // Must copy before looping as can be removed during loop otherwise copy = new HashSet<>(closeHooks); } } if (copy != null && !copy.isEmpty()) { int num = copy.size(); if (num != 0) { AtomicInteger count = new AtomicInteger(); AtomicBoolean failed = new AtomicBoolean(); for (Closeable hook : copy) { Promise<Void> promise = Promise.promise(); promise.future().setHandler(ar -> { if (ar.failed()) { if (failed.compareAndSet(false, true)) { // Only report one failure completionHandler.handle(Future.failedFuture(ar.cause())); } } else { if (count.incrementAndGet() == num) { // closeHooksRun = true; completionHandler.handle(Future.succeededFuture()); } } }); try { hook.close(promise); } catch (Throwable t) { log.warn("Failed to run close hooks", t); promise.tryFail(t); } } } else { completionHandler.handle(Future.succeededFuture()); } } else { completionHandler.handle(Future.succeededFuture()); } } }