Class LineDisciplineTerminal

java.lang.Object

org.aesh.readline.terminal.impl.AbstractTerminal

org.aesh.readline.terminal.impl.LineDisciplineTerminal

All Implemented Interfaces:

Closeable, AutoCloseable, org.aesh.terminal.Terminal

Direct Known Subclasses:

ExternalTerminal

public class LineDisciplineTerminal
extends AbstractTerminal

Abstract console with support for line discipline. The Terminal interface represents the slave side of a PTY, but implementations derived from this class will handle both the slave and master side of things. In order to correctly handle line discipline, the console needs to read the input in advance in order to raise the signals as fast as possible. For example, when the user hits Ctrl+C, we can't wait until the application consumes all the read events. The same applies to echoing, when enabled, as the echoing has to happen as soon as the user hit the keyboard, and not only when the application running in the terminal processes the input.

Nested Class Summary

Nested classes/interfaces inherited from interface org.aesh.terminal.Terminal

org.aesh.terminal.Terminal.SignalHandler

Field Summary

Fields

Modifier and Type	Field	Description
protected final org.aesh.terminal.Attributes	attributes	Console data
protected final OutputStream	masterOutput
protected org.aesh.terminal.tty.Size	size
protected final InputStream	slaveInput
protected final OutputStream	slaveInputPipe
protected final OutputStream	slaveOutput

Fields inherited from class AbstractTerminal

device, handlers, LOGGER, name, type

Constructor Summary

Constructors

Constructor	Description
LineDisciplineTerminal(String name, String type, OutputStream masterOutput)

Method Summary

Modifier and Type	Method	Description
void	close()
protected void	closeSlaveInputPipe()
org.aesh.terminal.Attributes	getAttributes()
org.aesh.terminal.tty.Size	getSize()
InputStream	input()
OutputStream	output()
void	processInputByte(int c)	Master input processing.
void	processInputBytes(byte[] input)
void	processInputBytes(byte[] input, int length)
void	processInputBytes(int[] input, int length)
protected void	processOutputByte(int c)	Master output processing.
void	raise(org.aesh.terminal.tty.Signal signal)
void	setAttributes(org.aesh.terminal.Attributes attr)

Methods inherited from class AbstractTerminal

device, echo, echo, echoSignal, getName, getType, handle, handleDefaultSignal

Methods inherited from class Object

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

Methods inherited from interface org.aesh.terminal.Terminal

getCodePointConsumer

Field Details

masterOutput

protected final OutputStream masterOutput

slaveInputPipe

protected final OutputStream slaveInputPipe

slaveInput

protected final InputStream slaveInput

slaveOutput

protected final OutputStream slaveOutput

attributes

protected final org.aesh.terminal.Attributes attributes

Console data

size

protected org.aesh.terminal.tty.Size size

Constructor Details

LineDisciplineTerminal

public LineDisciplineTerminal(String name,
 String type,
 OutputStream masterOutput)
                       throws IOException

Throws:

IOException

Method Details

input

public InputStream input()

output

public OutputStream output()

getAttributes

public org.aesh.terminal.Attributes getAttributes()

setAttributes

public void setAttributes(org.aesh.terminal.Attributes attr)

getSize

public org.aesh.terminal.tty.Size getSize()

raise

public void raise(org.aesh.terminal.tty.Signal signal)

Specified by:

raise in interface org.aesh.terminal.Terminal

Overrides:

raise in class AbstractTerminal

processInputByte

public void processInputByte(int c)
                      throws IOException

Master input processing. All data coming to the console should be provided using this method.

Parameters:

c - the input byte

Throws:

IOException

processInputBytes

public void processInputBytes(byte[] input)
                       throws IOException

Throws:

IOException

processInputBytes

public void processInputBytes(byte[] input,
 int length)
                       throws IOException

Throws:

IOException

processInputBytes

public void processInputBytes(int[] input,
 int length)
                       throws IOException

Throws:

IOException

closeSlaveInputPipe

protected void closeSlaveInputPipe()

processOutputByte

protected void processOutputByte(int c)
                          throws IOException

Master output processing. All data going to the master should be provided by this method.

Parameters:

c - the output byte

Throws:

IOException

close

public void close()
           throws IOException

Throws:

IOException