Package org.aesh.terminal.tty.impl

Class ExternalTerminal

java.lang.Object

org.aesh.terminal.tty.impl.AbstractTerminal

org.aesh.terminal.tty.impl.LineDisciplineTerminal

org.aesh.terminal.tty.impl.ExternalTerminal

All Implemented Interfaces:

Closeable, AutoCloseable, Terminal

Direct Known Subclasses:

WinExternalTerminal

public class ExternalTerminal
extends LineDisciplineTerminal

Console implementation with embedded line disciplined. This console is well-suited for supporting incoming external connections, such as from the network (through telnet, ssh, or any kind of protocol). The console will start consuming the input in a separate thread to generate interruption events.

See Also:

• LineDisciplineTerminal

Nested Class Summary

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

Terminal.SignalHandler

Field Summary

Fields

Modifier and Type	Field	Description
protected final InputStream	masterInput	The master input stream for reading data from the external source.

Fields inherited from class org.aesh.terminal.tty.impl.LineDisciplineTerminal

attributes, masterOutput, size, slaveInput, slaveInputPipe, slaveOutput

Fields inherited from class org.aesh.terminal.tty.impl.AbstractTerminal

device, handlers, LOGGER, name, type

Constructor Summary

Constructors

Constructor	Description
ExternalTerminal(String name, String type, InputStream masterInput, OutputStream masterOutput)	Constructs an ExternalTerminal with the specified parameters.

Method Summary

Modifier and Type	Method	Description
void	close()	Closes this terminal and releases any associated resources.
void	pump()	Pumps data from the master input stream to the terminal.

Methods inherited from class org.aesh.terminal.tty.impl.LineDisciplineTerminal

closeSlaveInputPipe, getAttributes, getSize, input, output, processInputByte, processInputBytes, processInputBytes, processInputBytes, processOutputByte, raise, setAttributes

Methods inherited from class org.aesh.terminal.tty.impl.AbstractTerminal

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.aesh.terminal.Terminal

getCodePointConsumer

Field Details

masterInput

protected final InputStream masterInput

The master input stream for reading data from the external source.

Constructor Details

ExternalTerminal

public ExternalTerminal(String name,
 String type,
 InputStream masterInput,
 OutputStream masterOutput)
                 throws IOException

Constructs an ExternalTerminal with the specified parameters.

Parameters:

name - the terminal name

type - the terminal type

masterInput - the master input stream for reading external data

masterOutput - the master output stream for writing data

Throws:

IOException - if an I/O error occurs during initialization

Method Details

close

public void close()
           throws IOException

Closes this terminal and releases any associated resources.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Overrides:

close in class LineDisciplineTerminal

Throws:

IOException - if an I/O error occurs

pump

public void pump()

Pumps data from the master input stream to the terminal. This method runs in a separate thread and continuously reads from the master input, processing the bytes through the line discipline.