Package net.schmizz.sshj.sftp

Class RemoteFile.ReadAheadRemoteFileInputStream

java.lang.Object

java.io.InputStream

net.schmizz.sshj.sftp.RemoteFile.ReadAheadRemoteFileInputStream

All Implemented Interfaces:

Closeable, AutoCloseable

Enclosing class:

RemoteFile

public class RemoteFile.ReadAheadRemoteFileInputStream
extends InputStream

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private class	RemoteFile.ReadAheadRemoteFileInputStream.UnconfirmedRead

Field Summary

Fields

Modifier and Type	Field	Description
private final byte[]	b
private long	currentOffset
private boolean	eof
private int	maxReadLength
private final int	maxUnconfirmedReads
private ByteArrayInputStream	pending
private final long	readAheadLimit
private final Deque<RemoteFile.ReadAheadRemoteFileInputStream.UnconfirmedRead>	unconfirmedReads

Constructor Summary

Constructors

Constructor	Description
ReadAheadRemoteFileInputStream(int maxUnconfirmedReads)
ReadAheadRemoteFileInputStream(int maxUnconfirmedReads, long fileOffset)
ReadAheadRemoteFileInputStream(int maxUnconfirmedReads, long fileOffset, long readAheadLimit)

Method Summary

Modifier and Type	Method	Description
int	available()
int	read()
int	read(byte[] into, int off, int len)
private boolean	retrieveUnconfirmedRead(boolean blocking)

Methods inherited from class java.io.InputStream

close, mark, markSupported, nullInputStream, read, readAllBytes, readNBytes, readNBytes, reset, skip, skipNBytes, transferTo

Methods inherited from class java.lang.Object

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

Field Details

b

private final byte[] b

maxUnconfirmedReads

private final int maxUnconfirmedReads

readAheadLimit

private final long readAheadLimit

unconfirmedReads

private final Deque<RemoteFile.ReadAheadRemoteFileInputStream.UnconfirmedRead> unconfirmedReads

currentOffset

private long currentOffset

maxReadLength

private int maxReadLength

eof

private boolean eof

pending

private ByteArrayInputStream pending

Constructor Details

ReadAheadRemoteFileInputStream

public ReadAheadRemoteFileInputStream(int maxUnconfirmedReads)

ReadAheadRemoteFileInputStream

public ReadAheadRemoteFileInputStream(int maxUnconfirmedReads,
 long fileOffset)

Parameters:

maxUnconfirmedReads - Maximum number of unconfirmed requests to send

fileOffset - Initial offset in file to read from

ReadAheadRemoteFileInputStream

public ReadAheadRemoteFileInputStream(int maxUnconfirmedReads,
 long fileOffset,
 long readAheadLimit)

Parameters:

maxUnconfirmedReads - Maximum number of unconfirmed requests to send

fileOffset - Initial offset in file to read from

readAheadLimit - Read ahead is disabled after this limit has been reached

Method Details

retrieveUnconfirmedRead

private boolean retrieveUnconfirmedRead(boolean blocking)
                                 throws IOException

Throws:

IOException

read

public int read()
         throws IOException

Specified by:

read in class InputStream

Throws:

IOException

read

public int read(byte[] into,
 int off,
 int len)
         throws IOException

Overrides:

read in class InputStream

Throws:

IOException

available

public int available()
              throws IOException

Overrides:

available in class InputStream

Throws:

IOException