Apache Mina SSHD 2.15.0 · org.apache.sshd.server.shell.TtyFilterInputStream

Modifier and Type	Field and Description
private Buffer	buffer
public static final Set<PtyMode>	INPUT_OPTIONS
private int	lastChar
private final Set<PtyMode>	ttyOptions

Access	Constructor and Description
public	TtyFilterInputStream(InputStream in, Map<PtyMode, ?> modes)
public	TtyFilterInputStream(InputStream in, Collection<PtyMode> ttyOptions)

Method Summary

Modifier and Type	Method and Description
public synchronized int	available() Overrides java.io.FilterInputStream.available. Returns an estimate of the number of bytes that can be read (or skipped over) from this input stream without blocking by the next caller of a method for this input stream.
protected int	handleCR()
protected int	handleLF()
protected Buffer	insertCharacter(Buffer org, int c)
public synchronized int	read() Overrides java.io.FilterInputStream.read. Reads the next byte of data from the input stream.
public synchronized int	read(byte[] the buffer into which the data is read. b, int the start offset in array `b` at which the data is written. off, int the maximum number of bytes to read. len) Overrides java.io.FilterInputStream.read. Reads up to `len` bytes of data from this input stream into an array of bytes.
protected int	readRawInput()
public synchronized void	write(int c)
public synchronized void	write(byte[] buf, int off, int len)

Inherited from java.io.FilterInputStream:: close mark markSupported read reset skip

buffer	back to summary
private Buffer buffer

INPUT_OPTIONS	back to summary
public static final Set<PtyMode> INPUT_OPTIONS

lastChar	back to summary
private int lastChar

ttyOptions	back to summary
private final Set<PtyMode> ttyOptions

TtyFilterInputStream	back to summary
public TtyFilterInputStream(InputStream in, Map<PtyMode, ?> modes)

TtyFilterInputStream	back to summary
public TtyFilterInputStream(InputStream in, Collection<PtyMode> ttyOptions)

Method Detail

available	back to summary
public synchronized int available() throws IOException Overrides java.io.FilterInputStream.available. Doc from java.io.FilterInputStream.available. Returns an estimate of the number of bytes that can be read (or skipped over) from this input stream without blocking by the next caller of a method for this input stream. The next caller might be the same thread or another thread. A single read or skip of this many bytes will not block, but may read or skip fewer bytes. Returns:int an estimate of the number of bytes that can be read (or skipped over) from this input stream without blocking. Annotations @Override Exceptions IOException: if an I/O error occurs.

available

back to summary

public synchronized int available() throws IOException

Overrides java.io.FilterInputStream.available.

Doc from java.io.FilterInputStream.available.

Returns an estimate of the number of bytes that can be read (or skipped over) from this input stream without blocking by the next caller of a method for this input stream. The next caller might be the same thread or another thread. A single read or skip of this many bytes will not block, but may read or skip fewer bytes.

Returns:int

an estimate of the number of bytes that can be read (or skipped over) from this input stream without blocking.

Annotations

@Override

Exceptions

IOException:: if an I/O error occurs.

handleCR	back to summary
protected int handleCR() throws IOException

handleLF	back to summary
protected int handleLF() throws IOException

insertCharacter	back to summary
protected Buffer insertCharacter(Buffer org, int c)

read back to summary

read	back to summary
public synchronized int read() throws IOException Overrides java.io.FilterInputStream.read. Doc from java.io.FilterInputStream.read. Reads the next byte of data from the input stream. The value byte is returned as an `int` in the range `0` to `255`. If no byte is available because the end of the stream has been reached, the value `-1` is returned. This method blocks until input data is available, the end of the stream is detected, or an exception is thrown. Returns:int the next byte of data, or `-1` if the end of the stream is reached. Annotations @Override Exceptions IOException: if an I/O error occurs.

public synchronized int read() throws IOException

Overrides java.io.FilterInputStream.read.

Doc from java.io.FilterInputStream.read.

Reads the next byte of data from the input stream. The value byte is returned as an int in the range 0 to 255. If no byte is available because the end of the stream has been reached, the value -1 is returned. This method blocks until input data is available, the end of the stream is detected, or an exception is thrown.

Returns:int

the next byte of data, or -1 if the end of the stream is reached.

Annotations

@Override

Exceptions

IOException:: if an I/O error occurs.

read back to summary

read	back to summary
public synchronized int read(byte[] b, int off, int len) throws IOException Overrides java.io.FilterInputStream.read. Doc from java.io.FilterInputStream.read. Reads up to `len` bytes of data from this input stream into an array of bytes. If `len` is not zero, the method blocks until some input is available; otherwise, no bytes are read and `0` is returned. Parameters b:byte[] the buffer into which the data is read. off:int the start offset in array `b` at which the data is written. len:int the maximum number of bytes to read. Returns:int the total number of bytes read into the buffer, or `-1` if there is no more data because the end of the stream has been reached. Annotations @Override Exceptions IOException: if an I/O error occurs.

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

Overrides java.io.FilterInputStream.read.

Doc from java.io.FilterInputStream.read.

Reads up to len bytes of data from this input stream into an array of bytes. If len is not zero, the method blocks until some input is available; otherwise, no bytes are read and 0 is returned.

Parameters

b:byte[]: the buffer into which the data is read.
off:int: the start offset in array b at which the data is written.
len:int: the maximum number of bytes to read.

Returns:int

the total number of bytes read into the buffer, or -1 if there is no more data because the end of the stream has been reached.

Annotations

@Override

Exceptions

IOException:: if an I/O error occurs.

readRawInput	back to summary
protected int readRawInput() throws IOException

write	back to summary
public synchronized void write(int c)

write	back to summary
public synchronized void write(byte[] buf, int off, int len)

public Class TtyFilterInputStream

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail