Modifier and Type	Class and Description
public static enum	AbstractCloseable.State

Modifier and Type	Field and Description
protected final CloseFuture	closeFuture A future that will be set 'closed' when the object is actually closed
protected final Object	futureLock Lock object for `Future`-s based on this closeable instance
protected final AtomicReference<AbstractCloseable.State>	state State of this object

Access	Constructor and Description
protected	AbstractCloseable()
protected	AbstractCloseable(String discriminator)

Method Summary

Modifier and Type	Method and Description
public void	addCloseFutureListener(SshFutureListener<CloseFuture> The notification `SshFutureListener` - never `null` listener) Implements org.apache.sshd.common.Closeable.addCloseFutureListener. Pre-register a listener to be informed when resource is closed.
protected Builder	builder()
public final CloseFuture	close(boolean `true` if the resource should be shut down abruptly, `false` for a graceful close immediately) Implements org.apache.sshd.common.Closeable.close. Close this resource asynchronously and return a future.
protected CloseFuture	doCloseGracefully()
protected void	doCloseImmediately() doCloseImmediately is called once and only once with state == Immediate Overriding methods should always call the base implementation.
public Object	getFutureLock()
public final boolean	isClosed() Implements org.apache.sshd.common.Closeable.isClosed. Returns `true` if this object has been closed.
public final boolean	isClosing() Implements org.apache.sshd.common.Closeable.isClosing. Returns `true` if the `close(boolean)` method has been called.
protected void	preClose() preClose is guaranteed to be called before doCloseGracefully or doCloseImmediately.
public void	removeCloseFutureListener(SshFutureListener<CloseFuture> The register `SshFutureListener` - never `null`. Ignored if not registered or resource already closed listener) Implements org.apache.sshd.common.Closeable.removeCloseFutureListener. Remove a pre-registered close event listener

Field Detail

closeFuture	back to summary
protected final CloseFuture closeFuture A future that will be set 'closed' when the object is actually closed

futureLock	back to summary
protected final Object futureLock Lock object for `Future`-s based on this closeable instance

state	back to summary
protected final AtomicReference<AbstractCloseable.State> state State of this object

Constructor Detail

AbstractCloseable	back to summary
protected AbstractCloseable()

AbstractCloseable	back to summary
protected AbstractCloseable(String discriminator)

Method Detail

addCloseFutureListener back to summary

addCloseFutureListener	back to summary
public void addCloseFutureListener(SshFutureListener<CloseFuture> listener) Implements org.apache.sshd.common.Closeable.addCloseFutureListener. Doc from org.apache.sshd.common.Closeable.addCloseFutureListener. Pre-register a listener to be informed when resource is closed. If resource is already closed, the listener will be invoked immediately and not registered for future notification Parameters listener:SshFutureListener<CloseFuture> The notification `SshFutureListener` - never `null` Annotations @Override

public void addCloseFutureListener(SshFutureListener<CloseFuture> listener)

Implements org.apache.sshd.common.Closeable.addCloseFutureListener.

Doc from org.apache.sshd.common.Closeable.addCloseFutureListener.

Pre-register a listener to be informed when resource is closed. If resource is already closed, the listener will be invoked immediately and not registered for future notification

Parameters

listener:SshFutureListener<CloseFuture>: The notification SshFutureListener - never null

Annotations

@Override

builder	back to summary
protected Builder builder()

close back to summary

close	back to summary
public final CloseFuture close(boolean immediately) Implements org.apache.sshd.common.Closeable.close. Doc from org.apache.sshd.common.Closeable.close. 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. Parameters immediately:boolean `true` if the resource should be shut down abruptly, `false` for a graceful close Returns:CloseFuture a `CloseFuture` representing the close request Annotations @Override

public final CloseFuture close(boolean immediately)

Implements org.apache.sshd.common.Closeable.close.

Doc from org.apache.sshd.common.Closeable.close.

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.

Parameters

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

Returns:CloseFuture

a CloseFuture representing the close request

Annotations

@Override

doCloseGracefully	back to summary
protected CloseFuture doCloseGracefully()

doCloseImmediately	back to summary
protected void doCloseImmediately() doCloseImmediately is called once and only once with state == Immediate Overriding methods should always call the base implementation. It may be called concurrently while preClose() or doCloseGracefully is executing

getFutureLock	back to summary
public Object getFutureLock()

isClosed back to summary

isClosed	back to summary
public final boolean isClosed() Implements org.apache.sshd.common.Closeable.isClosed. Doc from org.apache.sshd.common.Closeable.isClosed. Returns `true` if this object has been closed. Returns:boolean `true` if closing Annotations @Override

public final boolean isClosed()

Implements org.apache.sshd.common.Closeable.isClosed.

Doc from org.apache.sshd.common.Closeable.isClosed.

Returns true if this object has been closed.

Returns:boolean

true if closing

Annotations

@Override

isClosing back to summary

isClosing	back to summary
public final boolean isClosing() Implements org.apache.sshd.common.Closeable.isClosing. Doc from org.apache.sshd.common.Closeable.isClosing. Returns `true` if the `close(boolean)` method has been called. Note that this method will return `true` even if this `isClosed()` returns `true`. Returns:boolean `true` if closing Annotations @Override

public final boolean isClosing()

Implements org.apache.sshd.common.Closeable.isClosing.

Doc from org.apache.sshd.common.Closeable.isClosing.

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

Returns:boolean

true if closing

Annotations

@Override

preClose	back to summary
protected void preClose() preClose is guaranteed to be called before doCloseGracefully or doCloseImmediately. When preClose() is called, isClosing() == true

removeCloseFutureListener back to summary

removeCloseFutureListener	back to summary
public void removeCloseFutureListener(SshFutureListener<CloseFuture> listener) Implements org.apache.sshd.common.Closeable.removeCloseFutureListener. Doc from org.apache.sshd.common.Closeable.removeCloseFutureListener. Remove a pre-registered close event listener Parameters listener:SshFutureListener<CloseFuture> The register `SshFutureListener` - never `null`. Ignored if not registered or resource already closed Annotations @Override

public void removeCloseFutureListener(SshFutureListener<CloseFuture> listener)

Implements org.apache.sshd.common.Closeable.removeCloseFutureListener.

Doc from org.apache.sshd.common.Closeable.removeCloseFutureListener.

Remove a pre-registered close event listener

Parameters

listener:SshFutureListener<CloseFuture>: The register SshFutureListener - never null. Ignored if not registered or resource already closed

Annotations

@Override

org.apache.sshd.common.util.closeable back to summary

public final Enum AbstractCloseable.State

Class Inheritance

extends Enum<AbstractCloseable.State>

java.lang.Object
java.lang.Enum
org.apache.sshd.common.util.closeable.AbstractCloseable.State

Field Summary

Modifier and Type	Field and Description
public static final AbstractCloseable.State	Closed Connection is closed
public static final AbstractCloseable.State	Graceful Connection is being closed gracefully
public static final AbstractCloseable.State	Immediate Connection is being terminated immediately
public static final AbstractCloseable.State	Opened Connection is open

Constructor Summary

Access	Constructor and Description
private	State()

Method Summary

Modifier and Type	Method and Description
public static AbstractCloseable.State	valueOf(String name)
public static AbstractCloseable.State[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

Closed	back to summary
public static final AbstractCloseable.State Closed Connection is closed

Graceful	back to summary
public static final AbstractCloseable.State Graceful Connection is being closed gracefully

Immediate	back to summary
public static final AbstractCloseable.State Immediate Connection is being terminated immediately

Opened	back to summary
public static final AbstractCloseable.State Opened Connection is open

Constructor Detail

State	back to summary
private State()

Method Detail

valueOf	back to summary
public static AbstractCloseable.State valueOf(String name)

values	back to summary
public static AbstractCloseable.State[] values()

public abstract Class AbstractCloseable

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public final Enum AbstractCloseable.State

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail