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 Object	lock
protected InputStream	masterInput
protected boolean	paused
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, encoding, handlers, ints, name, status, strings, type

Fields inherited from interface org.jline.terminal.Terminal

TYPE_DUMB, TYPE_DUMB_COLOR

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
boolean	canPauseResume() Whether this terminal supports Terminal.pause() and Terminal.resume() calls.
void	close()
Cursor	getCursorPosition(IntConsumer discarded) Query the terminal to report the cursor position.
void	pause() Stop reading the input stream.
void	pause(boolean wait) Stop reading the input stream and optionally wait for the underlying threads to finish.
boolean	paused() Check whether the terminal is currently reading the input stream or not.
void	pump()
void	resume() Resume reading the input stream.

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

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

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

checkInterrupted, echo, echo, echoSignal, encoding, enterRawMode, flush, getBooleanCapability, getKind, getName, getNumericCapability, getStatus, getStatus, getStringCapability, getType, handle, hasFocusSupport, hasMouseSupport, parseInfoCmp, puts, readMouseEvent, readMouseEvent, trackFocus, 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

masterInput

protected final InputStream masterInput

lock

protected final Object lock

paused

protected boolean paused

pumpThread

protected Thread pumpThread

Constructor Detail

ExternalTerminal

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

Throws:

IOException

ExternalTerminal

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

Throws:

IOException

ExternalTerminal

public ExternalTerminal(String name,
                        String type,
                        InputStream masterInput,
                        OutputStream masterOutput,
                        Charset encoding,
                        Terminal.SignalHandler signalHandler,
                        boolean paused)
                 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

canPauseResume

public boolean canPauseResume()

Description copied from interface: Terminal

Whether this terminal supports Terminal.pause() and Terminal.resume() calls.

Specified by:

canPauseResume in interface Terminal

Overrides:

canPauseResume in class AbstractTerminal

Returns:

whether this terminal supports Terminal.pause() and Terminal.resume() calls.

See Also:

Terminal.paused(), Terminal.pause(), Terminal.resume()

pause

public void pause()

Description copied from interface: Terminal

Stop reading the input stream.

Specified by:

pause in interface Terminal

Overrides:

pause in class AbstractTerminal

See Also:

Terminal.resume(), Terminal.paused()

pause

public void pause(boolean wait)
           throws InterruptedException

Description copied from interface: Terminal

Stop reading the input stream and optionally wait for the underlying threads to finish.

Specified by:

pause in interface Terminal

Overrides:

pause in class AbstractTerminal

Parameters:

wait - true to wait until the terminal is actually paused

Throws:

InterruptedException - if the call has been interrupted

resume

public void resume()

Description copied from interface: Terminal

Resume reading the input stream.

Specified by:

resume in interface Terminal

Overrides:

resume in class AbstractTerminal

See Also:

Terminal.pause(), Terminal.paused()

paused

public boolean paused()

Description copied from interface: Terminal

Check whether the terminal is currently reading the input stream or not. In order to process signal as quickly as possible, the terminal need to read the input stream and buffer it internally so that it can detect specific characters in the input stream (Ctrl+C, Ctrl+D, etc...) and raise the appropriate signals. However, there are some cases where this processing should be disabled, for example when handing the terminal control to a subprocess.

Specified by:

paused in interface Terminal

Overrides:

paused in class AbstractTerminal

Returns:

whether the terminal is currently reading the input stream or not

See Also:

Terminal.pause(), Terminal.resume()

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