org.apache.sshd.common.channel

Class Window

java.lang.Object

org.apache.sshd.common.util.logging.AbstractLoggingBean

org.apache.sshd.common.channel.Window

public class Window
extends AbstractLoggingBean

A Window for a given channel. Windows are used to not overflow the client or server when sending datas. Both clients and servers have a local and remote window and won't send anymore data until the window has been expanded. When the local window is

Author:

Apache MINA SSHD Project

Field Summary

Fields inherited from class org.apache.sshd.common.util.logging.AbstractLoggingBean

log

Constructor Summary

Constructors

Constructor and Description
Window(AbstractChannel channel, Object lock, boolean client, boolean local)

Method Summary

Modifier and Type	Method and Description
void	check(int maxFree)
void	consume(int len)
void	consumeAndCheck(int len)
void	expand(int window)
int	getMaxSize()
int	getPacketSize()
Map<String,?>	getProperties()
int	getSize()
void	init(FactoryManager manager)
void	init(int size, int packetSize, Map<String,?> props)
void	init(Map<String,?> props)
void	init(Session session)
void	notifyClosed()
String	toString()
void	waitAndConsume(int len)
int	waitForSpace()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Window

public Window(AbstractChannel channel,
              Object lock,
              boolean client,
              boolean local)

Method Detail

getProperties

public Map<String,?> getProperties()

getSize

public int getSize()

getMaxSize

public int getMaxSize()

getPacketSize

public int getPacketSize()

init

public void init(Session session)

init

public void init(FactoryManager manager)

init

public void init(Map<String,?> props)

init

public void init(int size,
                 int packetSize,
                 Map<String,?> props)

expand

public void expand(int window)

consume

public void consume(int len)

consumeAndCheck

public void consumeAndCheck(int len)
                     throws IOException

Throws:

IOException

check

public void check(int maxFree)
           throws IOException

Throws:

IOException

waitAndConsume

public void waitAndConsume(int len)
                    throws InterruptedException,
                           WindowClosedException

Throws:

InterruptedException

WindowClosedException

waitForSpace

public int waitForSpace()
                 throws InterruptedException,
                        WindowClosedException

Throws:

InterruptedException

WindowClosedException

notifyClosed

public void notifyClosed()

toString

public String toString()

Overrides:

toString in class Object