Class LineDisciplineTerminal

java.lang.Object

org.aesh.terminal.tty.impl.AbstractTerminal

org.aesh.terminal.tty.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	Terminal attributes.
protected final OutputStream	masterOutput	Master output stream.
protected org.aesh.terminal.tty.Size	size	Terminal size.
protected final InputStream	slaveInput	Slave input stream.
protected final OutputStream	slaveInputPipe	Slave input pipe write side.
protected final OutputStream	slaveOutput	Slave output stream.

Fields inherited from class AbstractTerminal

device, handlers, name, type

Fields inherited from interface org.aesh.terminal.Terminal

READ_EXPIRED

Constructor Summary

Constructors

Constructor	Description
LineDisciplineTerminal(String name, String type, OutputStream masterOutput)	Create a new line discipline terminal.

Method Summary

Modifier and Type	Method	Description
void	close()
protected void	closeSlaveInputPipe()	Close the slave input pipe.
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)	Process an array of input bytes.
void	processInputBytes(byte[] input, int length)	Process input bytes up to the specified length.
void	processInputBytes(int[] input, int length)	Process input code points up to the specified 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, peek, read, read, supportsNonBlockingRead

Field Details

masterOutput

protected final OutputStream masterOutput

Master output stream.

slaveInputPipe

protected final OutputStream slaveInputPipe

Slave input pipe write side.

slaveInput

protected final InputStream slaveInput

Slave input stream.

slaveOutput

protected final OutputStream slaveOutput

Slave output stream.

attributes

protected final org.aesh.terminal.Attributes attributes

Terminal attributes.

size

protected org.aesh.terminal.tty.Size size

Terminal size.

Constructor Details

LineDisciplineTerminal

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

Create a new line discipline terminal.

Parameters:

name - the terminal name

type - the terminal type

masterOutput - the master output stream

Throws:

IOException - if an I/O error occurs

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 - if an I/O error occurs

processInputBytes

public void processInputBytes(byte[] input)
                       throws IOException

Process an array of input bytes.

Parameters:

input - the input bytes

Throws:

IOException - if an I/O error occurs

processInputBytes

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

Process input bytes up to the specified length.

Parameters:

input - the input bytes

length - the number of bytes to process

Throws:

IOException - if an I/O error occurs

processInputBytes

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

Process input code points up to the specified length.

Parameters:

input - the input code points

length - the number of code points to process

Throws:

IOException - if an I/O error occurs

closeSlaveInputPipe

protected void closeSlaveInputPipe()

Close the slave input pipe.

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 - if an I/O error occurs

close

public void close()
           throws IOException

Throws:

IOException