org.jline.terminal.impl

Class ExternalTerminal

java.lang.Object

org.jline.terminal.impl.AbstractTerminal

org.jline.terminal.impl.LineDisciplineTerminal

org.jline.terminal.impl.ExternalTerminal

All Implemented Interfaces:

Closeable, Flushable, AutoCloseable, Terminal

public class ExternalTerminal
extends LineDisciplineTerminal

Console implementation with embedded line disciplined. This terminal is well-suited for supporting incoming external connections, such as from the network (through telnet, ssh, or any kind of protocol). The terminal 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.jline.terminal.Terminal

Terminal.MouseTracking, Terminal.Signal, Terminal.SignalHandler

Field Summary

Fields

Modifier and Type	Field and Description
protected AtomicBoolean	closed
protected InputStream	masterInput
protected Thread	pumpThread

Fields inherited from class org.jline.terminal.impl.LineDisciplineTerminal

attributes, masterOutput, size, slaveInput, slaveInputPipe, slaveOutput, slaveReader, slaveWriter

Fields inherited from class org.jline.terminal.impl.AbstractTerminal

bools, handlers, ints, name, strings, type

Fields inherited from interface org.jline.terminal.Terminal

TYPE_DUMB

Constructor Summary

Constructors

Constructor and Description
ExternalTerminal(String name, String type, InputStream masterInput, OutputStream masterOutput, String encoding)
ExternalTerminal(String name, String type, InputStream masterInput, OutputStream masterOutput, String encoding, Terminal.SignalHandler signalHandler)

Method Summary

Modifier and Type	Method and Description
void	close()
Cursor	getCursorPosition(IntConsumer discarded) Query the terminal to report the cursor position.
void	pump()

Methods inherited from class org.jline.terminal.impl.LineDisciplineTerminal

getAttributes, getSize, input, output, processInputByte, processOutputByte, raise, reader, setAttributes, setSize, writer

Methods inherited from class org.jline.terminal.impl.AbstractTerminal

echo, echo, echoSignal, enterRawMode, flush, getBooleanCapability, getKind, getName, getNumericCapability, getStringCapability, getType, handle, hasMouseSupport, parseInfoCmp, puts, readMouseEvent, readMouseEvent, trackMouse

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.jline.terminal.Terminal

getHeight, getWidth

Field Detail

closed

protected final AtomicBoolean closed

pumpThread

protected final Thread pumpThread

masterInput

protected final InputStream masterInput

Constructor Detail

ExternalTerminal

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

Throws:

IOException

ExternalTerminal

public ExternalTerminal(String name,
                        String type,
                        InputStream masterInput,
                        OutputStream masterOutput,
                        String encoding,
                        Terminal.SignalHandler signalHandler)
                 throws IOException

Throws:

IOException

Method Detail

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Overrides:

close in class LineDisciplineTerminal

Throws:

IOException

pump

public void pump()

getCursorPosition

public Cursor getCursorPosition(IntConsumer discarded)

Description copied from interface: Terminal

Query the terminal to report the cursor position. As the response is read from the input stream, some characters may be read before the cursor position is actually read. Those characters can be given back using org.jline.keymap.BindingReader#runMacro(String).

Specified by:

getCursorPosition in interface Terminal

Overrides:

getCursorPosition in class AbstractTerminal

Parameters:

discarded - a consumer receiving discarded characters

Returns:

null if cursor position reporting is not supported or a valid cursor position