LocalWindow (Apache Mina SSHD :: Core 2.11.0 API)

java.lang.Object
- org.apache.sshd.common.util.logging.AbstractLoggingBean
- - org.apache.sshd.common.channel.Window
  - - org.apache.sshd.common.channel.LocalWindow

All Implemented Interfaces:

Closeable, AutoCloseable, ChannelHolder
```
public class LocalWindow
extends Window
```
A Window that describes how much data this side is prepared to receive from the peer. Initialized when the channel is created. This side reduces the window by the amount of data received on reception; if it receives more data than allowed, it closes the channel. Once the data received has been processed, for instance, passed on, this side checks the current window size and if it is low, increases it and sends an SSH_MSG_CHANNEL_WINDOW_ADJUST message to the peer, who then is allowed to send more data again.

Author:

Apache MINA SSHD Project

Field Summary
- Fields inherited from class org.apache.sshd.common.channel.Window
  lock
- Fields inherited from class org.apache.sshd.common.util.logging.AbstractLoggingBean
  log

Constructor Summary

Constructors
Constructor Description

LocalWindow(AbstractChannel channel, boolean isClient)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`consume(long len)`
`AbstractChannel`	`getChannel()`
`void`	`init(PropertyResolver resolver)`	Initializes the `LocalWindow` with the packet and window sizes from the `resolver`.
`void`	`release(long len)`	Updates the window once data that has arrived in a channel has been read, making available room for the sender too send more data, sending a window adjust message if necessary.

Methods inherited from class org.apache.sshd.common.channel.Window
checkInitialized, close, getMaxSize, getPacketSize, getSize, init, isOpen, largerThan, toString, updateSize

Methods inherited from class 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

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - LocalWindow
```
public LocalWindow(AbstractChannel channel,
                   boolean isClient)
```
- Method Detail
  - getChannel
```
public AbstractChannel getChannel()
```
    Specified by:
    
    getChannel in interface ChannelHolder
    
    Overrides:
    
    getChannel in class Window
    
    Returns:
    
    The associated Channel instance
  - init
```
public void init(PropertyResolver resolver)
```
    Initializes the LocalWindow with the packet and window sizes from the resolver.
    
    Parameters:
    
    resolver - to access properties
  - consume
```
public void consume(long len)
             throws IOException
```
    Specified by:
    
    consume in class Window
    
    Throws:
    
    IOException
  - release
```
public void release(long len)
             throws IOException
```
    Updates the window once data that has arrived in a channel has been read, making available room for the sender too send more data, sending a window adjust message if necessary.
    
    Parameters:
    
    len - length of data read from the channel
    
    Throws:
    
    IOException - if sending a window adjust message fails