Apache Mina SSHD 2.15.0 · org.apache.sshd.common.channel.Window

A Channel implements a sliding window flow control for data packets (SSH_MSG_CHANNEL_DATA and SSH_MSG_CHANNEL_EXTENDED_DATA packets). Each channel has two windows, a local window describing how much data it is prepared to receive (and the peer is allowed to send), and a remote window that reflects this side's view of the peer's local window. When the local window size is zero, no data should be received; when the remote window size is zero, no data should be sent. Peers update the other's remote window periodically, but at the latest when a window is exhausted, by sending SSH_MSG_CHANNEL_WINDOW_ADJUST messages.

Field Summary

Modifier and Type	Field and Description
private final Channel	channelInstance
private final AtomicBoolean	closed
private final AtomicBoolean	initialized
protected final Object	lock
private long	maxSize
private long	packetSize
private long	size
private final String	suffix

Inherited from org.apache.sshd.common.util.logging.AbstractLoggingBean:: log

Constructor Summary

Access	Constructor and Description
protected	Window(Channel channel, boolean isClient)

Method Summary

Modifier and Type	Method and Description
protected void	checkInitialized(String location)
public void	close() Implements java.io.Closeable.close. Closes this stream and releases any system resources associated with it.
public abstract void	consume(long len)
public Channel	getChannel() Implements org.apache.sshd.common.channel.ChannelHolder.getChannel.
public long	getMaxSize()
public long	getPacketSize()
public long	getSize()
protected void	init(long size, long packetSize, PropertyResolver resolver)
public boolean	isOpen()
protected static Predicate<Window>	largerThan(long minSize)
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.
protected void	updateSize(long size)

Inherited from org.apache.sshd.common.util.logging.AbstractLoggingBean:: debug debug debug debug debug error error error error error getSimplifiedLogger info info warn warn warn warn warn warn warn warn

Field Detail

channelInstance	back to summary
private final Channel channelInstance

closed	back to summary
private final AtomicBoolean closed

initialized	back to summary
private final AtomicBoolean initialized

lock	back to summary
protected final Object lock

maxSize	back to summary
private long maxSize

packetSize	back to summary
private long packetSize

size	back to summary
private long size

suffix	back to summary
private final String suffix

Constructor Detail

Window	back to summary
protected Window(Channel channel, boolean isClient)

Method Detail

checkInitialized	back to summary
protected void checkInitialized(String location)

close back to summary

close	back to summary
public void close() throws IOException Implements java.io.Closeable.close. Doc from java.io.Closeable.close. Closes this stream and releases any system resources associated with it. If the stream is already closed then invoking this method has no effect. As noted in `AutoCloseable#close()`, cases where the close may fail require careful attention. It is strongly advised to relinquish the underlying resources and to internally mark the `Closeable` as closed, prior to throwing the `IOException`. Annotations @Override Exceptions IOException: if an I/O error occurs

public void close() throws IOException

Implements java.io.Closeable.close.

Doc from java.io.Closeable.close.

Closes this stream and releases any system resources associated with it. If the stream is already closed then invoking this method has no effect.

As noted in AutoCloseable#close(), cases where the close may fail require careful attention. It is strongly advised to relinquish the underlying resources and to internally mark the Closeable as closed, prior to throwing the IOException.

Annotations

@Override

Exceptions

IOException:: if an I/O error occurs

consume	back to summary
public abstract void consume(long len) throws IOException

getChannel back to summary

getChannel	back to summary
public Channel getChannel() Implements org.apache.sshd.common.channel.ChannelHolder.getChannel. Returns:Channel Doc from org.apache.sshd.common.channel.ChannelHolder.getChannel. The associated `Channel` instance Annotations @Override

public Channel getChannel()

Implements org.apache.sshd.common.channel.ChannelHolder.getChannel.

Returns:Channel

Doc from org.apache.sshd.common.channel.ChannelHolder.getChannel.

The associated Channel instance

Annotations

@Override

getMaxSize	back to summary
public long getMaxSize()

getPacketSize	back to summary
public long getPacketSize()

getSize	back to summary
public long getSize()

init	back to summary
protected void init(long size, long packetSize, PropertyResolver resolver)

isOpen	back to summary
public boolean isOpen()

largerThan	back to summary
protected static Predicate<Window> largerThan(long minSize)

toString back to summary

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Satisfying this method's contract implies a non-`null` result must be returned. Returns:String a string representation of the object Annotations @Override

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations

@Override

updateSize	back to summary
protected void updateSize(long size)

public abstract Class Window

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail