public class AbstractChannel.GracefulChannelCloseable extends IoBaseCloseable
log
CLOSE_WAIT_TIMEOUT, DEFAULT_CLOSE_WAIT_TIMEOUT
Constructor and Description |
---|
GracefulChannelCloseable() |
Modifier and Type | Method and Description |
---|---|
void |
addCloseFutureListener(SshFutureListener<CloseFuture> listener)
Pre-register a listener to be informed when resource is closed.
|
CloseFuture |
close(boolean immediately)
Close this resource asynchronously and return a future.
|
protected void |
handleClosePacketWriteFailure(Channel channel,
boolean immediately,
Throwable t) |
protected void |
handleClosePacketWritten(Channel channel,
boolean immediately) |
boolean |
isClosed()
Returns
true if this object has been closed. |
boolean |
isClosing()
Returns
true if the Closeable.close(boolean) method
has been called. |
void |
removeCloseFutureListener(SshFutureListener<CloseFuture> listener)
Remove a pre-registered close event listener
|
void |
setClosing(boolean on) |
String |
toString() |
getSimplifiedLogger
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
close, close, getMaxCloseWaitTime, isOpen
public void addCloseFutureListener(SshFutureListener<CloseFuture> listener)
Closeable
listener
- The notification SshFutureListener
- never null
public void removeCloseFutureListener(SshFutureListener<CloseFuture> listener)
Closeable
listener
- The register SshFutureListener
- never null
.
Ignored if not registered or resource already closedpublic boolean isClosing()
Closeable
true
if the Closeable.close(boolean)
method
has been called. Note that this method will return true
even if this Closeable.isClosed()
returns true
.true
if closingpublic void setClosing(boolean on)
public boolean isClosed()
Closeable
true
if this object has been closed.true
if closingpublic CloseFuture close(boolean immediately)
Closeable
immediately
- true
if the resource should be shut down abruptly,
false
for a graceful closeCloseFuture
representing the close requestprotected void handleClosePacketWritten(Channel channel, boolean immediately)
protected void handleClosePacketWriteFailure(Channel channel, boolean immediately, Throwable t)
Copyright © 2008–2022 The Apache Software Foundation. All rights reserved.