Class TerminalConnection

java.lang.Object

org.aesh.readline.tty.terminal.TerminalConnection

All Implemented Interfaces:

AutoCloseable, org.aesh.terminal.Connection

public class TerminalConnection
extends Object
implements org.aesh.terminal.Connection

Implementation of Connection meant for local terminal connections.

Author:

Ståle W. Pedersen

Constructor Summary

Constructors

Constructor	Description
TerminalConnection()
TerminalConnection(Charset charset, InputStream inputStream, OutputStream outputStream)
TerminalConnection(Charset charset, InputStream inputStream, OutputStream outputStream, Consumer<org.aesh.terminal.Connection> handler)
TerminalConnection(Charset inputCharset, Charset outputCharset, InputStream inputStream, OutputStream outputStream, Consumer<org.aesh.terminal.Connection> handler)
TerminalConnection(Consumer<org.aesh.terminal.Connection> handler)
TerminalConnection(org.aesh.terminal.Terminal terminal)

Method Summary

Modifier and Type	Method	Description
void	awake()
void	close()
org.aesh.terminal.Device	device()
org.aesh.terminal.Attributes	getAttributes()
Consumer<Void>	getCloseHandler()
Consumer<org.aesh.terminal.tty.Signal>	getSignalHandler()
Consumer<org.aesh.terminal.tty.Size>	getSizeHandler()
Consumer<int[]>	getStdinHandler()
org.aesh.terminal.Terminal	getTerminal()
Charset	inputEncoding()
boolean	isReading()
void	openBlocking()	Opens the Connection stream, this method will block and wait for input.
void	openBlocking(String buffer)
void	openNonBlocking()
Charset	outputEncoding()
boolean	put(org.aesh.terminal.tty.Capability capability, Object... params)
void	setAttributes(org.aesh.terminal.Attributes attr)
void	setCloseHandler(Consumer<Void> closeHandler)
void	setSignalHandler(Consumer<org.aesh.terminal.tty.Signal> handler)
void	setSizeHandler(Consumer<org.aesh.terminal.tty.Size> handler)
void	setStdinHandler(Consumer<int[]> handler)
org.aesh.terminal.tty.Size	size()
Consumer<int[]>	stdoutHandler()
void	stopReading()
boolean	supportsAnsi()
void	suspend()
boolean	suspended()

Methods inherited from class Object

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

Methods inherited from interface org.aesh.terminal.Connection

close, enterRawMode, getCursorPosition, write

Constructor Details

TerminalConnection

public TerminalConnection(Charset inputCharset,
 Charset outputCharset,
 InputStream inputStream,
 OutputStream outputStream,
 Consumer<org.aesh.terminal.Connection> handler)
                   throws IOException

Throws:

IOException

TerminalConnection

public TerminalConnection(Charset charset,
 InputStream inputStream,
 OutputStream outputStream,
 Consumer<org.aesh.terminal.Connection> handler)
                   throws IOException

Throws:

IOException

TerminalConnection

public TerminalConnection(Charset charset,
 InputStream inputStream,
 OutputStream outputStream)
                   throws IOException

Throws:

IOException

TerminalConnection

public TerminalConnection()
                   throws IOException

Throws:

IOException

TerminalConnection

public TerminalConnection(Consumer<org.aesh.terminal.Connection> handler)
                   throws IOException

Throws:

IOException

TerminalConnection

public TerminalConnection(org.aesh.terminal.Terminal terminal)

Method Details

openNonBlocking

public void openNonBlocking()

Specified by:

openNonBlocking in interface org.aesh.terminal.Connection

put

public boolean put(org.aesh.terminal.tty.Capability capability,
 Object... params)

Specified by:

put in interface org.aesh.terminal.Connection

getAttributes

public org.aesh.terminal.Attributes getAttributes()

Specified by:

getAttributes in interface org.aesh.terminal.Connection

setAttributes

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

Specified by:

setAttributes in interface org.aesh.terminal.Connection

inputEncoding

public Charset inputEncoding()

Specified by:

inputEncoding in interface org.aesh.terminal.Connection

outputEncoding

public Charset outputEncoding()

Specified by:

outputEncoding in interface org.aesh.terminal.Connection

supportsAnsi

public boolean supportsAnsi()

Specified by:

supportsAnsi in interface org.aesh.terminal.Connection

openBlocking

public void openBlocking()

Opens the Connection stream, this method will block and wait for input.

Specified by:

openBlocking in interface org.aesh.terminal.Connection

openBlocking

public void openBlocking(String buffer)

suspend

public void suspend()

awake

public void awake()

suspended

public boolean suspended()

isReading

public boolean isReading()

stopReading

public void stopReading()

getTerminal

public org.aesh.terminal.Terminal getTerminal()

device

public org.aesh.terminal.Device device()

Specified by:

device in interface org.aesh.terminal.Connection

size

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

Specified by:

size in interface org.aesh.terminal.Connection

getSizeHandler

public Consumer<org.aesh.terminal.tty.Size> getSizeHandler()

Specified by:

getSizeHandler in interface org.aesh.terminal.Connection

setSizeHandler

public void setSizeHandler(Consumer<org.aesh.terminal.tty.Size> handler)

Specified by:

setSizeHandler in interface org.aesh.terminal.Connection

getSignalHandler

public Consumer<org.aesh.terminal.tty.Signal> getSignalHandler()

Specified by:

getSignalHandler in interface org.aesh.terminal.Connection

setSignalHandler

public void setSignalHandler(Consumer<org.aesh.terminal.tty.Signal> handler)

Specified by:

setSignalHandler in interface org.aesh.terminal.Connection

getStdinHandler

public Consumer<int[]> getStdinHandler()

Specified by:

getStdinHandler in interface org.aesh.terminal.Connection

setStdinHandler

public void setStdinHandler(Consumer<int[]> handler)

Specified by:

setStdinHandler in interface org.aesh.terminal.Connection

stdoutHandler

public Consumer<int[]> stdoutHandler()

Specified by:

stdoutHandler in interface org.aesh.terminal.Connection

setCloseHandler

public void setCloseHandler(Consumer<Void> closeHandler)

Specified by:

setCloseHandler in interface org.aesh.terminal.Connection

getCloseHandler

public Consumer<Void> getCloseHandler()

Specified by:

getCloseHandler in interface org.aesh.terminal.Connection

close

public void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface org.aesh.terminal.Connection