Package org.apache.sshd.common.channel
Class Window
java.lang.Object
org.apache.sshd.common.util.logging.AbstractLoggingBean
org.apache.sshd.common.channel.Window
- All Implemented Interfaces:
Closeable
,AutoCloseable
,Channel
,ChannelHolder
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
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate final AbstractChannel
private final AtomicBoolean
private final AtomicBoolean
private final Object
private long
private long
private long
DefaultPredicate
used to test if space became availableprivate final String
Fields inherited from class org.apache.sshd.common.util.logging.AbstractLoggingBean
log
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
check
(long maxFree) protected void
checkInitialized
(String location) void
close()
void
consume
(long len) void
consumeAndCheck
(long len) void
expand
(int window) long
long
long
getSize()
void
init
(long size, long packetSize, PropertyResolver resolver) void
init
(PropertyResolver resolver) boolean
isOpen()
toString()
protected void
updateSize
(long size) void
waitAndConsume
(long len, long maxWaitTime) Waits for enough data to become available to consume the specified sizevoid
waitAndConsume
(long len, Duration maxWaitTime) Waits for enough data to become available to consume the specified sizeprotected void
waitForCondition
(Predicate<? super Window> predicate, Duration maxWaitTime) Waits up to a specified amount of time for a condition to be satisfied and signaled via the lock.long
waitForSpace
(long maxWaitTime) Waits until some data becomes available or timeout expireslong
waitForSpace
(Duration maxWaitTime) Waits until some data becomes available or timeout expires
-
Field Details
-
SPACE_AVAILABLE_PREDICATE
DefaultPredicate
used to test if space became available -
closed
-
initialized
-
channelInstance
-
lock
-
suffix
-
size
private long size -
maxSize
private long maxSize -
packetSize
private long packetSize
-
-
Constructor Details
-
Window
-
-
Method Details
-
getChannel
- Specified by:
getChannel
in interfaceChannelHolder
- Returns:
- The associated
Channel
instance
-
getSize
public long getSize() -
getMaxSize
public long getMaxSize() -
getPacketSize
public long getPacketSize() -
init
-
init
-
expand
public void expand(int window) -
consume
public void consume(long len) -
consumeAndCheck
- Throws:
IOException
-
check
- Throws:
IOException
-
waitAndConsume
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
- Size of data to consumemaxWaitTime
- Max. time (millis) to wait for enough data to become available- Throws:
InterruptedException
- If interrupted while waitingWindowClosedException
- If window closed while waitingSocketTimeoutException
- If timeout expired before enough data became available- See Also:
-
waitAndConsume
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
- Size of data to consumemaxWaitTime
- Max. time to wait for enough data to become available- Throws:
InterruptedException
- If interrupted while waitingWindowClosedException
- If window closed while waitingSocketTimeoutException
- If timeout expired before enough data became available- See Also:
-
waitForSpace
public long waitForSpace(long maxWaitTime) throws InterruptedException, WindowClosedException, SocketTimeoutException Waits until some data becomes available or timeout expires- Parameters:
maxWaitTime
- Max. time (millis) to wait for space to become available- Returns:
- Amount of available data - always positive
- Throws:
InterruptedException
- If interrupted while waitingWindowClosedException
- If window closed while waitingSocketTimeoutException
- If timeout expired before space became available- See Also:
-
waitForSpace
public long waitForSpace(Duration maxWaitTime) throws InterruptedException, WindowClosedException, SocketTimeoutException Waits until some data becomes available or timeout expires- Parameters:
maxWaitTime
- Max. time to wait for space to become available- Returns:
- Amount of available data - always positive
- Throws:
InterruptedException
- If interrupted while waitingWindowClosedException
- If window closed while waitingSocketTimeoutException
- If timeout expired before space became available- See Also:
-
waitForCondition
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
- ThePredicate
to check if the condition has been satisfied - the argument to the predicate isthis
referencemaxWaitTime
- Max. time to wait for the condition to be satisfied- Throws:
WindowClosedException
- If window closed while waitingInterruptedException
- If interrupted while waitingSocketTimeoutException
- If timeout expired before condition was satisfied- See Also:
-
updateSize
protected void updateSize(long size) -
checkInitialized
-
isOpen
public boolean isOpen() -
close
- Specified by:
close
in interfaceAutoCloseable
- Specified by:
close
in interfaceChannel
- Specified by:
close
in interfaceCloseable
- Throws:
IOException
-
toString
-