Top Fields Constructors Methods
io.vertx.core.impl

public Class CloseFuture

extends Object
implements Closeable
Class Inheritance
All Implemented Interfaces
io.vertx.core.Closeable
Imports
io.vertx.core.Closeable, .Future, .Promise, io.vertx.core.impl.logging.Logger, java.util.ArrayList, .HashMap, .List, .Map, .WeakHashMap, java.util.concurrent.atomic.AtomicInteger
Author
Julien Viet

Field Summary

Modifier and TypeField and Description
private boolean
closed

private Map<Closeable, CloseFuture>
hooks

private final Logger
log

private final Promise<Void>
promise

private Map<Closeable, CloseFuture>
weakHooks

Constructor Summary

AccessConstructor and Description
public
CloseFuture()

public
CloseFuture(Logger log)

Method Summary

Modifier and TypeMethod and Description
public synchronized boolean
add(Closeable
the hook to add
hook)

Add a close hook, notified when the close(Promise) )} method is called.

public Future<Void>

Returns:

the future completed after completion of all close hooks
close()

Run all close hooks, after completion of all hooks, the future is closed.

public void
close(Promise<Void>
called when all hooks have been executed
completionHandler)

Implements io.vertx.core.Closeable.close.

Run the close hooks.

protected void
finalize()

Overrides java.lang.Object.finalize.

Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.

public Future<Void>

Returns:

the future completed after completion of all close hooks.
future()

public synchronized boolean

Returns:

whether the future is closed.
isClosed()

public synchronized boolean
remove(Closeable
the hook to remove
hook)

Remove an existing hook.

Inherited from java.lang.Object:
cloneequalsgetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

closedback to summary
private boolean closed
hooksback to summary
private Map<Closeable, CloseFuture> hooks
logback to summary
private final Logger log
promiseback to summary
private final Promise<Void> promise
weakHooksback to summary
private Map<Closeable, CloseFuture> weakHooks

Constructor Detail

CloseFutureback to summary
public CloseFuture()
CloseFutureback to summary
public CloseFuture(Logger log)

Method Detail

addback to summary
public synchronized boolean add(Closeable hook)

Add a close hook, notified when the close(Promise) )} method is called. The hook will be weakly referenced therefore, the caller needs to retain a reference to the hook otherwise it might be reclaimed and therefore never be called.

Parameters
hook:Closeable

the hook to add

closeback to summary
public Future<Void> close()

Run all close hooks, after completion of all hooks, the future is closed.

Returns:Future<Void>

the future completed after completion of all close hooks

closeback to summary
public void close(Promise<Void> completionHandler)

Implements io.vertx.core.Closeable.close.

Run the close hooks.

Parameters
completionHandler:Promise<Void>

called when all hooks have been executed

finalizeback to summary
protected void finalize()

Overrides java.lang.Object.finalize.

Doc from java.lang.Object.finalize.

Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. A subclass overrides the finalize method to dispose of system resources or to perform other cleanup.

When running in a Java virtual machine in which finalization has been disabled or removed, the garbage collector will never call finalize(). In a Java virtual machine in which finalization is enabled, the garbage collector might call finalize only after an indefinite delay.

The general contract of finalize is that it is invoked if and when the Java virtual machine has determined that there is no longer any means by which this object can be accessed by any thread that has not yet died, except as a result of an action taken by the finalization of some other object or class which is ready to be finalized. The finalize method may take any action, including making this object available again to other threads; the usual purpose of finalize, however, is to perform cleanup actions before the object is irrevocably discarded. For example, the finalize method for an object that represents an input/output connection might perform explicit I/O transactions to break the connection before the object is permanently discarded.

The finalize method of class Object performs no special action; it simply returns normally. Subclasses of Object may override this definition.

The Java programming language does not guarantee which thread will invoke the finalize method for any given object. It is guaranteed, however, that the thread that invokes finalize will not be holding any user-visible synchronization locks when finalize is invoked. If an uncaught exception is thrown by the finalize method, the exception is ignored and finalization of that object terminates.

After the finalize method has been invoked for an object, no further action is taken until the Java virtual machine has again determined that there is no longer any means by which this object can be accessed by any thread that has not yet died, including possible actions by other objects or classes which are ready to be finalized, at which point the object may be discarded.

The finalize method is never invoked more than once by a Java virtual machine for any given object.

Any exception thrown by the finalize method causes the finalization of this object to be halted, but is otherwise ignored.

Annotations
@Override
futureback to summary
public Future<Void> future()
Returns:Future<Void>

the future completed after completion of all close hooks.

isClosedback to summary
public synchronized boolean isClosed()
Returns:boolean

whether the future is closed.

removeback to summary
public synchronized boolean remove(Closeable hook)

Remove an existing hook.

Parameters
hook:Closeable

the hook to remove