org.apache.sshd.common.channel

Class AbstractChannel.GracefulChannelCloseable

java.lang.Object

org.apache.sshd.common.channel.AbstractChannel.GracefulChannelCloseable

All Implemented Interfaces:

Closeable

Enclosing class:

AbstractChannel

public class AbstractChannel.GracefulChannelCloseable
extends Object
implements Closeable

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	closing

Constructor Summary

Constructors

Constructor and Description
AbstractChannel.GracefulChannelCloseable()

Method Summary

Methods

Modifier and Type	Method and Description
CloseFuture	close(boolean immediately) Close this resource asynchronously and return a future.
boolean	isClosed() Returns true< if this object has been closed.
boolean	isClosing() Returns true if the Closeable.close(boolean) method has been called.

Methods inherited from class java.lang.Object

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

Field Detail

closing

protected volatile boolean closing

Constructor Detail

AbstractChannel.GracefulChannelCloseable

public AbstractChannel.GracefulChannelCloseable()

Method Detail

isClosing

public boolean isClosing()

Description copied from interface: Closeable

Returns true if the Closeable.close(boolean) method has been called. Note that this method will return true even if this Closeable.isClosed() returns true.

Specified by:

isClosing in interface Closeable

isClosed

public boolean isClosed()

Description copied from interface: Closeable

Returns true< if this object has been closed.

Specified by:

isClosed in interface Closeable

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