jexer.net

Class TelnetInputStream

java.lang.Object

java.io.InputStream

jexer.net.TelnetInputStream

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable, SessionInfo

public class TelnetInputStream
extends java.io.InputStream
implements SessionInfo

TelnetInputStream works with TelnetSocket to perform the telnet protocol.

Method Summary

Modifier and Type	Method and Description
int	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 invocation of a method for this input stream.
void	close() Closes this input stream and releases any system resources associated with the stream.
java.lang.String	getLanguage() Language getter.
java.lang.String	getTerminalType() Get the terminal type as reported by the telnet Terminal Type option.
java.lang.String	getUsername() Username getter.
int	getWindowHeight() Text window height getter.
int	getWindowWidth() Text window width getter.
void	mark(int readLimit) Marks the current position in this input stream.
boolean	markSupported() Tests if this input stream supports the mark and reset methods.
void	queryWindowSize() Re-query the text window size.
int	read() Reads the next byte of data from the input stream.
int	read(byte[] b) Reads some number of bytes from the input stream and stores them into the buffer array b.
int	read(byte[] b, int off, int len) Reads up to len bytes of data from the input stream into an array of bytes.
void	reset() Repositions this stream to the position at the time the mark method was last called on this input stream.
void	setLanguage(java.lang.String language) Language setter.
void	setUsername(java.lang.String username) Username setter.
long	skip(long n) Skips over and discards n bytes of data from this input stream.

Methods inherited from class java.lang.Object

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

Method Detail

getUsername

public java.lang.String getUsername()

Username getter.

Specified by:

getUsername in interface SessionInfo

Returns:

the username

setUsername

public void setUsername(java.lang.String username)

Username setter.

Specified by:

setUsername in interface SessionInfo

Parameters:

username - the value

getLanguage

public java.lang.String getLanguage()

Language getter.

Specified by:

getLanguage in interface SessionInfo

Returns:

the language

setLanguage

public void setLanguage(java.lang.String language)

Language setter.

Specified by:

setLanguage in interface SessionInfo

Parameters:

language - the value

getTerminalType

public java.lang.String getTerminalType()

Get the terminal type as reported by the telnet Terminal Type option.

Returns:

the terminal type

getWindowWidth

public int getWindowWidth()

Text window width getter.

Specified by:

getWindowWidth in interface SessionInfo

Returns:

the window width

getWindowHeight

public int getWindowHeight()

Text window height getter.

Specified by:

getWindowHeight in interface SessionInfo

Returns:

the window height

queryWindowSize

public void queryWindowSize()

Re-query the text window size.

Specified by:

queryWindowSize in interface SessionInfo

available

public int available()
              throws java.io.IOException

Returns an estimate of the number of bytes that can be read (or skipped over) from this input stream without blocking by the next invocation of a method for this input stream.

Overrides:

available in class java.io.InputStream

Returns:

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

Throws:

java.io.IOException - if an I/O error occurs

close

public void close()
           throws java.io.IOException

Closes this input stream and releases any system resources associated with the stream.

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Overrides:

close in class java.io.InputStream

Throws:

java.io.IOException - if an I/O error occurs

mark

public void mark(int readLimit)

Marks the current position in this input stream.

Overrides:

mark in class java.io.InputStream

Parameters:

readLimit - the maximum limit of bytes that can be read before the mark position becomes invalid

markSupported

public boolean markSupported()

Tests if this input stream supports the mark and reset methods.

Overrides:

markSupported in class java.io.InputStream

Returns:

true if this stream instance supports the mark and reset methods; false otherwise

read

public int read()
         throws java.io.IOException

Reads the next byte of data from the input stream.

Specified by:

read in class java.io.InputStream

Returns:

the next byte of data, or -1 if there is no more data because the end of the stream has been reached.

Throws:

java.io.IOException - if an I/O error occurs

read

public int read(byte[] b)
         throws java.io.IOException

Reads some number of bytes from the input stream and stores them into the buffer array b.

Overrides:

read in class java.io.InputStream

Parameters:

b - the buffer into which the data is read.

Returns:

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.

Throws:

java.io.IOException - if an I/O error occurs

read

public int read(byte[] b,
                int off,
                int len)
         throws java.io.IOException

Reads up to len bytes of data from the input stream into an array of bytes.

Overrides:

read in class java.io.InputStream

Parameters:

b - the buffer into which the data is read.

off - the start offset in array b at which the data is written.

len - the maximum number of bytes to read.

Returns:

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.

Throws:

java.io.IOException - if an I/O error occurs

reset

public void reset()
           throws java.io.IOException

Repositions this stream to the position at the time the mark method was last called on this input stream. This is not supported by TelnetInputStream, so IOException is always thrown.

Overrides:

reset in class java.io.InputStream

Throws:

java.io.IOException - if this function is used

skip

public long skip(long n)
          throws java.io.IOException

Skips over and discards n bytes of data from this input stream.

Overrides:

skip in class java.io.InputStream

Parameters:

n - the number of bytes to be skipped

Returns:

the actual number of bytes skipped

Throws:

java.io.IOException - if an I/O error occurs