|
RSE Release 3.4 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ITerminalShell
Interface representing a terminal connection through Streams.
Rather than the underlying IBaseShell
, an ITerminalShell connection
adds methods that describe the presentation of the data transmitted over its
Streams, as well as methods like setTerminalSize(int, int)
to change
the behavior of the presentation of this data. An instance of ITerminalShell
is typically obtained from an ITerminalService
.
In RSE, a single remote shell instance can only either support the streamed
ITerminalShell interface or the listener-based IHostShell
interface,
but not both. Note, though, that with the capabilities that an ITerminalShell
has, it is always possible to adapt it to an IHostShell; this is typically
not possible the other way round. We therefore recommend extenders of RSE
that used to subclass IHostShell to move to the new IBaseShell /
ITerminalShell APIs eventually, if they can.
IBaseShell
,
ITerminalService
,
AbstractTerminalShell
,
TerminalShellDecorator
Method Summary | |
---|---|
String |
getDefaultEncoding()
Return the default encoding that the terminal service had specified when creating this terminal connection, or that's known from the remote side to be expected. |
String |
getPtyType()
Get the Terminal Type that's expected on this connection. |
boolean |
isLocalEcho()
Test if local echo is needed on this terminal connection. |
void |
setTerminalSize(int newWidth,
int newHeight)
Notify the remote site that the size of the terminal has changed. |
Methods inherited from interface org.eclipse.rse.services.terminals.IBaseShell |
---|
exit, exitValue, getErrorStream, getInputStream, getOutputStream, isActive, waitFor |
Methods inherited from interface org.eclipse.core.runtime.IAdaptable |
---|
getAdapter |
Method Detail |
---|
String getPtyType()
null
if the ITerminalShell does not know what kind of Terminal Type is
expected.String getDefaultEncoding()
null
.
TODO I'm not actually sure if this method is a good idea. Perhaps we
should use the IAdaptable mechanism for dealing with encodings, since our
shells basically deal with binary data only.
null
if
unknown.void setTerminalSize(int newWidth, int newHeight)
newWidth
- newHeight
- boolean isLocalEcho()
false
if in doubt.
true
if a local echo is needed.
|
RSE Release 3.4 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |