org.apache.sshd.common.util

Class CloseableUtils.AbstractCloseable

java.lang.Object

org.apache.sshd.common.util.CloseableUtils.AbstractCloseable

All Implemented Interfaces:

Closeable

Direct Known Subclasses:

CloseableUtils.AbstractInnerCloseable, Nio2Session

Enclosing class:

CloseableUtils

public abstract static class CloseableUtils.AbstractCloseable
extends java.lang.Object
implements Closeable

Field Summary

Fields

Modifier and Type	Field and Description
protected static int	CLOSED
protected CloseFuture	closeFuture A future that will be set 'closed' when the object is actually closed
protected static int	GRACEFUL
protected static int	IMMEDIATE
protected java.lang.Object	lock Lock object for this session state
protected org.slf4j.Logger	log Our logger
protected static int	OPENED
protected java.util.concurrent.atomic.AtomicInteger	state State of this object

Constructor Summary

Constructors

Constructor and Description
CloseableUtils.AbstractCloseable()

Method Summary

Methods

Modifier and Type	Method and Description
CloseFuture	close(boolean immediately) Close this resource asynchronously and return a future.
protected SshFuture	doCloseGracefully()
protected void	doCloseImmediately()
protected void	postClose()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

OPENED

protected static final int OPENED

See Also:

Constant Field Values

GRACEFUL

protected static final int GRACEFUL

See Also:

Constant Field Values

IMMEDIATE

protected static final int IMMEDIATE

See Also:

Constant Field Values

CLOSED

protected static final int CLOSED

See Also:

Constant Field Values

log

protected final org.slf4j.Logger log

Our logger

lock

protected final java.lang.Object lock

Lock object for this session state

state

protected final java.util.concurrent.atomic.AtomicInteger state

State of this object

closeFuture

protected final CloseFuture closeFuture

A future that will be set 'closed' when the object is actually closed

Constructor Detail

CloseableUtils.AbstractCloseable

public CloseableUtils.AbstractCloseable()

Method Detail

close

public CloseFuture close(boolean immediately)

Description copied from interface: Closeable

Close this resource asynchronously and return a future. Resources support two closing modes: a graceful mode which will cleanly close the resource and an immediate mode which will close the resources abruptly.

Specified by:

close in interface Closeable

Parameters:

immediately - true if the resource should be shut down abruptly, false for a graceful close

Returns:

a future

doCloseGracefully

protected SshFuture doCloseGracefully()

doCloseImmediately

protected void doCloseImmediately()

postClose

protected void postClose()