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

Modifier and Type	Field and Description
private static final Predicate<Window>	SPACE_AVAILABLE_PREDICATE Default `Predicate` used to test if space became available

Access	Constructor and Description
public	RemoteWindow(Channel channel, boolean isClient)

Method Summary

Modifier and Type	Method and Description
public void	consume(long len) Implements abstract org.apache.sshd.common.channel.Window.consume.
public void	expand(long increment)
public void	init(long the initial window size size, long the peer's advertised maximum packet size packetSize, PropertyResolver {@PropertyResolver } to access properties resolver) Overrides org.apache.sshd.common.channel.Window.init. Initializes the `RemoteWindow` with the packet and window sizes received from the peer.
public void	waitAndConsume(long Size of data to consume len, long Max. time (millis) to wait for enough data to become available maxWaitTime) Waits for enough data to become available to consume the specified size
public void	waitAndConsume(long Size of data to consume len, Duration Max. time to wait for enough data to become available maxWaitTime) Waits for enough data to become available to consume the specified size
protected void	waitForCondition(Predicate<? super Window> The `Predicate` to check if the condition has been satisfied - the argument to the predicate is `this` reference predicate, Duration Max. time to wait for the condition to be satisfied maxWaitTime) Waits up to a specified amount of time for a condition to be satisfied and signaled via the lock Note assumes that lock is acquired when this method is called.
public long	Returns: Amount of available data - always positive waitForSpace(long Max. time (millis) to wait for space to become available maxWaitTime) Waits until some data becomes available or timeout expires
public long	Returns: Amount of available data - always positive waitForSpace(Duration Max. time to wait for space to become available maxWaitTime) Waits until some data becomes available or timeout expires

Inherited from org.apache.sshd.common.channel.Window:: checkInitialized close getChannel getMaxSize getPacketSize getSize isOpen largerThan toString updateSize

SPACE_AVAILABLE_PREDICATE	back to summary
private static final Predicate<Window> SPACE_AVAILABLE_PREDICATE Default `Predicate` used to test if space became available

RemoteWindow	back to summary
public RemoteWindow(Channel channel, boolean isClient)

Method Detail

consume	back to summary
public void consume(long len) Implements abstract org.apache.sshd.common.channel.Window.consume. Annotations @Override

consume

back to summary

public void consume(long len)

Implements abstract org.apache.sshd.common.channel.Window.consume.

Annotations

@Override

expand	back to summary
public void expand(long increment)

init back to summary

init	back to summary
public void init(long size, long packetSize, PropertyResolver resolver) Overrides org.apache.sshd.common.channel.Window.init. Initializes the `RemoteWindow` with the packet and window sizes received from the peer. Parameters size:long the initial window size packetSize:long the peer's advertised maximum packet size resolver:PropertyResolver {@PropertyResolver } to access properties Annotations @Override

public void init(long size, long packetSize, PropertyResolver resolver)

Overrides org.apache.sshd.common.channel.Window.init.

Initializes the RemoteWindow with the packet and window sizes received from the peer.

Parameters

size:long: the initial window size
packetSize:long: the peer's advertised maximum packet size
resolver:PropertyResolver: {@PropertyResolver } to access properties

Annotations

@Override

waitAndConsume back to summary

waitAndConsume	back to summary
public void waitAndConsume(long len, long maxWaitTime) throws InterruptedException, WindowClosedException, SocketTimeoutException Waits for enough data to become available to consume the specified size Parameters len:long Size of data to consume maxWaitTime:long Max. time (millis) to wait for enough data to become available Exceptions InterruptedException: If interrupted while waiting WindowClosedException: If window closed while waiting SocketTimeoutException: If timeout expired before enough data became available See Also `waitForCondition(Predicate, Duration)`, `consume(long)`

public void waitAndConsume(long len, long maxWaitTime) throws InterruptedException, WindowClosedException, SocketTimeoutException

Waits for enough data to become available to consume the specified size

Parameters

len:long: Size of data to consume
maxWaitTime:long: Max. time (millis) to wait for enough data to become available

Exceptions

InterruptedException:: If interrupted while waiting
WindowClosedException:: If window closed while waiting
SocketTimeoutException:: If timeout expired before enough data became available

waitAndConsume back to summary

waitAndConsume	back to summary
public void waitAndConsume(long len, Duration maxWaitTime) throws InterruptedException, WindowClosedException, SocketTimeoutException Waits for enough data to become available to consume the specified size Parameters len:long Size of data to consume maxWaitTime:Duration Max. time to wait for enough data to become available Exceptions InterruptedException: If interrupted while waiting WindowClosedException: If window closed while waiting SocketTimeoutException: If timeout expired before enough data became available See Also `waitForCondition(Predicate, Duration)`, `consume(long)`

public void waitAndConsume(long len, Duration maxWaitTime) throws InterruptedException, WindowClosedException, SocketTimeoutException

Waits for enough data to become available to consume the specified size

Parameters

len:long: Size of data to consume
maxWaitTime:Duration: Max. time to wait for enough data to become available

Exceptions

InterruptedException:: If interrupted while waiting
WindowClosedException:: If window closed while waiting
SocketTimeoutException:: If timeout expired before enough data became available

waitForCondition back to summary

waitForCondition	back to summary
protected void waitForCondition(Predicate<? super Window> predicate, Duration maxWaitTime) throws WindowClosedException, InterruptedException, SocketTimeoutException Waits up to a specified amount of time for a condition to be satisfied and signaled via the lock Note assumes that lock is acquired when this method is called. Parameters predicate:Predicate<? super Window> The `Predicate` to check if the condition has been satisfied - the argument to the predicate is `this` reference maxWaitTime:Duration Max. time to wait for the condition to be satisfied Exceptions WindowClosedException: If window closed while waiting InterruptedException: If interrupted while waiting SocketTimeoutException: If timeout expired before condition was satisfied See Also `isOpen()`

protected void waitForCondition(Predicate<? super Window> predicate, Duration maxWaitTime) throws WindowClosedException, InterruptedException, SocketTimeoutException

Waits up to a specified amount of time for a condition to be satisfied and signaled via the lock

Note

assumes that lock is acquired when this method is called.

Parameters

predicate:Predicate<? super Window>: The Predicate to check if the condition has been satisfied - the argument to the predicate is this reference
maxWaitTime:Duration: Max. time to wait for the condition to be satisfied

Exceptions

WindowClosedException:: If window closed while waiting
InterruptedException:: If interrupted while waiting
SocketTimeoutException:: If timeout expired before condition was satisfied

See Also

isOpen()

waitForSpace back to summary

waitForSpace	back to summary
public long waitForSpace(long maxWaitTime) throws InterruptedException, WindowClosedException, SocketTimeoutException Waits until some data becomes available or timeout expires Parameters maxWaitTime:long Max. time (millis) to wait for space to become available Returns:long Amount of available data - always positive Exceptions InterruptedException: If interrupted while waiting WindowClosedException: If window closed while waiting SocketTimeoutException: If timeout expired before space became available See Also `waitForCondition(Predicate, Duration)`

public long waitForSpace(long maxWaitTime) throws InterruptedException, WindowClosedException, SocketTimeoutException

Waits until some data becomes available or timeout expires

Parameters

maxWaitTime:long: Max. time (millis) to wait for space to become available

Returns:long

Amount of available data - always positive

Exceptions

InterruptedException:: If interrupted while waiting
WindowClosedException:: If window closed while waiting
SocketTimeoutException:: If timeout expired before space became available

See Also

waitForCondition(Predicate, Duration)

waitForSpace back to summary

waitForSpace	back to summary
public long waitForSpace(Duration maxWaitTime) throws InterruptedException, WindowClosedException, SocketTimeoutException Waits until some data becomes available or timeout expires Parameters maxWaitTime:Duration Max. time to wait for space to become available Returns:long Amount of available data - always positive Exceptions InterruptedException: If interrupted while waiting WindowClosedException: If window closed while waiting SocketTimeoutException: If timeout expired before space became available See Also `waitForCondition(Predicate, Duration)`

public long waitForSpace(Duration maxWaitTime) throws InterruptedException, WindowClosedException, SocketTimeoutException

Waits until some data becomes available or timeout expires

Parameters

maxWaitTime:Duration: Max. time to wait for space to become available

Returns:long

Amount of available data - always positive

Exceptions

InterruptedException:: If interrupted while waiting
WindowClosedException:: If window closed while waiting
SocketTimeoutException:: If timeout expired before space became available

See Also

waitForCondition(Predicate, Duration)

public Class RemoteWindow

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail