public interface ClientChannel extends Channel
Modifier and Type | Interface and Description |
---|---|
static class |
ClientChannel.ClientChannelEvent |
static class |
ClientChannel.Streaming |
CHANNEL_EXEC, CHANNEL_SHELL, CHANNEL_SUBSYSTEM
Modifier and Type | Method and Description |
---|---|
CloseFuture |
close(boolean immediate)
Close this resource asynchronously and return a future.
|
IoInputStream |
getAsyncErr() |
IoOutputStream |
getAsyncIn() |
IoInputStream |
getAsyncOut() |
String |
getExitSignal() |
Integer |
getExitStatus() |
InputStream |
getInvertedErr() |
OutputStream |
getInvertedIn()
Access to an output stream to send data directly to the remote channel.
|
InputStream |
getInvertedOut() |
ClientChannel.Streaming |
getStreaming() |
OpenFuture |
open() |
void |
setErr(OutputStream err) |
void |
setIn(InputStream in)
Set an input stream that will be read by this channel and forwarded to
the remote channel.
|
void |
setOut(OutputStream out) |
void |
setStreaming(ClientChannel.Streaming streaming) |
Set<ClientChannel.ClientChannelEvent> |
waitFor(Collection<ClientChannel.ClientChannelEvent> mask,
long timeout)
Waits until any of the specified events in the mask is signaled
|
getId, getLocalWindow, getRecipient, getRemoteWindow, getSession, handleClose, handleData, handleEof, handleExtendedData, handleFailure, handleOpenFailure, handleOpenSuccess, handleRequest, handleSuccess, handleWindowAdjust, init, open
addChannelListener, getChannelListenerProxy, removeChannelListener
getParentPropertyResolver, getProperties
ClientChannel.Streaming getStreaming()
void setStreaming(ClientChannel.Streaming streaming)
IoOutputStream getAsyncIn()
IoInputStream getAsyncOut()
IoInputStream getAsyncErr()
OutputStream getInvertedIn()
setIn(java.io.InputStream)
method
and having the channel polling for data in that stream.InputStream getInvertedOut()
InputStream getInvertedErr()
void setIn(InputStream in)
getInvertedIn()
method instead and write data directly.in
- an InputStream to be polled and forwardedvoid setOut(OutputStream out)
void setErr(OutputStream err)
OpenFuture open() throws IOException
IOException
Set<ClientChannel.ClientChannelEvent> waitFor(Collection<ClientChannel.ClientChannelEvent> mask, long timeout)
mask
- The ClientChannel.ClientChannelEvent
s masktimeout
- The timeout to wait (msec.) - if non-positive then foreverClientChannel.ClientChannelEvent.TIMEOUT
if timeout expired before the expected event was signalledCloseFuture close(boolean immediate)
Closeable
immediate
- true
if the resource should be shut down abruptly,
false
for a graceful closeInteger getExitStatus()
null
if not signaledString getExitSignal()
null
if not signaledCopyright © 2008–2016 The Apache Software Foundation. All rights reserved.