Apache Mina SSHD 2.15.0 · org.apache.sshd.client.channel.AsyncCapableClientChannel

Modifier and Type	Field and Description
protected Future<?>	pumper
protected CloseableExecutorService	pumperService
protected final boolean	withErrorStream

Modifier and Type

Field and Description

protected Future<?>

pumper

protected CloseableExecutorService

pumperService

protected final boolean

withErrorStream

Access	Constructor and Description
protected	AsyncCapableClientChannel(String type, boolean withErrorStream)

Access

Constructor and Description

protected

AsyncCapableClientChannel(String type, boolean withErrorStream)

Modifier and Type	Method and Description
protected void	closeImmediately0()
protected void	doOpen() Implements abstract org.apache.sshd.client.channel.AbstractClientChannel.doOpen.
protected void	doWriteExtendedData(byte[] data, int off, long len) Overrides org.apache.sshd.client.channel.AbstractClientChannel.doWriteExtendedData.
public IoInputStream	getAsyncErr() Overrides org.apache.sshd.client.channel.AbstractClientChannel.getAsyncErr. Implements org.apache.sshd.client.channel.ClientChannel.getAsyncErr.
public OutputStream	getErr() Overrides org.apache.sshd.client.channel.AbstractClientChannel.getErr.
protected Closeable	getInnerCloseable() Overrides org.apache.sshd.client.channel.AbstractClientChannel.getInnerCloseable.
public InputStream	getInvertedErr() Overrides org.apache.sshd.client.channel.AbstractClientChannel.getInvertedErr. Implements org.apache.sshd.client.channel.ClientChannel.getInvertedErr. Obtains an `InputStream` to read received `SshConstants#SSH_MSG_CHANNEL_EXTENDED_DATA` data directly from the channel.
protected void	pumpInputStream()
protected int	securedRead(InputStream in, int maxChunkSize, byte[] buf, int off, int len)
public void	setErr(OutputStream the `OutputStream` err) Overrides org.apache.sshd.client.channel.AbstractClientChannel.setErr. Implements org.apache.sshd.client.channel.ClientChannel.setErr. Sets an output stream for the channel to write received `SshConstants#SSH_MSG_CHANNEL_EXTENDED_DATA` data to.
private <T> T	unsupported(Supplier<? extends T> err)

Modifier and Type

Method and Description

protected void

closeImmediately0()

protected void

doOpen()

Implements abstract org.apache.sshd.client.channel.AbstractClientChannel.doOpen.

protected void

doWriteExtendedData(byte[] data, int off, long len)

Overrides org.apache.sshd.client.channel.AbstractClientChannel.doWriteExtendedData.

public IoInputStream

getAsyncErr()

Overrides org.apache.sshd.client.channel.AbstractClientChannel.getAsyncErr.

Implements org.apache.sshd.client.channel.ClientChannel.getAsyncErr.

public OutputStream

getErr()

Overrides org.apache.sshd.client.channel.AbstractClientChannel.getErr.

protected Closeable

getInnerCloseable()

Overrides org.apache.sshd.client.channel.AbstractClientChannel.getInnerCloseable.

public InputStream

getInvertedErr()

Overrides org.apache.sshd.client.channel.AbstractClientChannel.getInvertedErr.

Implements org.apache.sshd.client.channel.ClientChannel.getInvertedErr.

Obtains an InputStream to read received SshConstants#SSH_MSG_CHANNEL_EXTENDED_DATA data directly from the channel.

protected void

pumpInputStream()

protected int

securedRead(InputStream in, int maxChunkSize, byte[] buf, int off, int len)

public void

setErr(OutputStream

the OutputStream

err)

Overrides org.apache.sshd.client.channel.AbstractClientChannel.setErr.

Implements org.apache.sshd.client.channel.ClientChannel.setErr.

Sets an output stream for the channel to write received SshConstants#SSH_MSG_CHANNEL_EXTENDED_DATA data to.

private <T> T

unsupported(Supplier<? extends T> err)

pumper	back to summary
protected Future<?> pumper

pumper

back to summary

protected Future<?> pumper

pumperService	back to summary
protected CloseableExecutorService pumperService

pumperService

back to summary

protected CloseableExecutorService pumperService

withErrorStream	back to summary
protected final boolean withErrorStream

withErrorStream

back to summary

protected final boolean withErrorStream

AsyncCapableClientChannel	back to summary
protected AsyncCapableClientChannel(String type, boolean withErrorStream)

AsyncCapableClientChannel

back to summary

protected AsyncCapableClientChannel(String type, boolean withErrorStream)

Method Detail

closeImmediately0	back to summary
protected void closeImmediately0()

doOpen	back to summary
protected void doOpen() throws IOException Implements abstract org.apache.sshd.client.channel.AbstractClientChannel.doOpen. Annotations @Override

doOpen

back to summary

protected void doOpen() throws IOException

Implements abstract org.apache.sshd.client.channel.AbstractClientChannel.doOpen.

Annotations

@Override

doWriteExtendedData	back to summary
protected void doWriteExtendedData(byte[] data, int off, long len) throws IOException Overrides org.apache.sshd.client.channel.AbstractClientChannel.doWriteExtendedData. Annotations @Override

doWriteExtendedData

back to summary

protected void doWriteExtendedData(byte[] data, int off, long len) throws IOException

Overrides org.apache.sshd.client.channel.AbstractClientChannel.doWriteExtendedData.

Annotations

@Override

getAsyncErr	back to summary
public IoInputStream getAsyncErr() Overrides org.apache.sshd.client.channel.AbstractClientChannel.getAsyncErr. Implements org.apache.sshd.client.channel.ClientChannel.getAsyncErr. Annotations @Override

getAsyncErr

back to summary

public IoInputStream getAsyncErr()

Overrides org.apache.sshd.client.channel.AbstractClientChannel.getAsyncErr.

Implements org.apache.sshd.client.channel.ClientChannel.getAsyncErr.

Annotations

@Override

getErr	back to summary
public OutputStream getErr() Overrides org.apache.sshd.client.channel.AbstractClientChannel.getErr. Annotations @Override

getErr

back to summary

public OutputStream getErr()

Overrides org.apache.sshd.client.channel.AbstractClientChannel.getErr.

Annotations

@Override

getInnerCloseable	back to summary
protected Closeable getInnerCloseable() Overrides org.apache.sshd.client.channel.AbstractClientChannel.getInnerCloseable. Annotations @Override

getInnerCloseable

back to summary

protected Closeable getInnerCloseable()

Overrides org.apache.sshd.client.channel.AbstractClientChannel.getInnerCloseable.

Annotations

@Override

getInvertedErr back to summary

getInvertedErr	back to summary
public InputStream getInvertedErr() Overrides org.apache.sshd.client.channel.AbstractClientChannel.getInvertedErr. Implements org.apache.sshd.client.channel.ClientChannel.getInvertedErr. Doc from org.apache.sshd.client.channel.ClientChannel.getInvertedErr. Obtains an `InputStream` to read received `SshConstants#SSH_MSG_CHANNEL_EXTENDED_DATA` data directly from the channel. This is an alternative to `setErr(OutputStream)`. If the error stream is redirected to the output stream via `setRedirectErrorStream(true)`, the returned stream will not receive any data and be always at EOF. When the channel closes, it will not close the returned stream. It is the caller's responsibility to close the returned stream if needed. Closing the stream while the channel is open may cause the channel to be closed forcibly if more data arrives. The stream remains open after the channel has closed, so that the caller can read the last arrived data even afterwards. As with all external processes, the application should read this stream (unless it was redirected) to avoid that the channel blocks when the stream's buffer is full. The buffer size for the returned stream is bounded by the channel's local window size. If the caller does not read this stream, the channel will block once the local window is exhausted. This method should be called only after the channel has been opened. Returns:InputStream an `InputStream` for reading received data, or `null` if an output stream was set via `setErr(OutputStream)` Annotations @Override

public InputStream getInvertedErr()

Overrides org.apache.sshd.client.channel.AbstractClientChannel.getInvertedErr.

Implements org.apache.sshd.client.channel.ClientChannel.getInvertedErr.

Doc from org.apache.sshd.client.channel.ClientChannel.getInvertedErr.

Obtains an InputStream to read received SshConstants#SSH_MSG_CHANNEL_EXTENDED_DATA data directly from the channel. This is an alternative to setErr(OutputStream). If the error stream is redirected to the output stream via setRedirectErrorStream(true), the returned stream will not receive any data and be always at EOF.

When the channel closes, it will not close the returned stream. It is the caller's responsibility to close the returned stream if needed. Closing the stream while the channel is open may cause the channel to be closed forcibly if more data arrives. The stream remains open after the channel has closed, so that the caller can read the last arrived data even afterwards.

As with all external processes, the application should read this stream (unless it was redirected) to avoid that the channel blocks when the stream's buffer is full. The buffer size for the returned stream is bounded by the channel's local window size. If the caller does not read this stream, the channel will block once the local window is exhausted.

This method should be called only after the channel has been opened.

Returns:InputStream

an InputStream for reading received data, or null if an output stream was set via setErr(OutputStream)

Annotations

@Override

pumpInputStream	back to summary
protected void pumpInputStream()

securedRead	back to summary
protected int securedRead(InputStream in, int maxChunkSize, byte[] buf, int off, int len) throws IOException

setErr back to summary

setErr	back to summary
public void setErr(OutputStream err) Overrides org.apache.sshd.client.channel.AbstractClientChannel.setErr. Implements org.apache.sshd.client.channel.ClientChannel.setErr. Doc from org.apache.sshd.client.channel.ClientChannel.setErr. Sets an output stream for the channel to write received `SshConstants#SSH_MSG_CHANNEL_EXTENDED_DATA` data to. For remote command execution, this is typically the remote command's `stderr`. The stream must be set before the channel is opened. When the channel closes, it will `close` the given stream. If no stream is set by the time the channel is opened, the channel will internally forward data to a stream that can be read via the `InputStream` obtained via `getInvertedErr()`. (Or it might forward the data to the output stream if `setRedirectErrorStream(true)` is set.) Parameters err:OutputStream the `OutputStream` Annotations @Override

public void setErr(OutputStream err)

Overrides org.apache.sshd.client.channel.AbstractClientChannel.setErr.

Implements org.apache.sshd.client.channel.ClientChannel.setErr.

Doc from org.apache.sshd.client.channel.ClientChannel.setErr.

Sets an output stream for the channel to write received SshConstants#SSH_MSG_CHANNEL_EXTENDED_DATA data to. For remote command execution, this is typically the remote command's stderr.

The stream must be set before the channel is opened. When the channel closes, it will close the given stream.

If no stream is set by the time the channel is opened, the channel will internally forward data to a stream that can be read via the InputStream obtained via getInvertedErr(). (Or it might forward the data to the output stream if setRedirectErrorStream(true) is set.)

Parameters

err:OutputStream: the OutputStream

Annotations

@Override

unsupported	back to summary
private <T> T unsupported(Supplier<? extends T> err)

public abstract Class AsyncCapableClientChannel

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail