Top Fields Methods
org.apache.sshd.common.channel

public Interface PtyChannelConfigurationMutator

extends PtyChannelConfigurationHolder
Known Direct Implementers
org.apache.sshd.common.channel.PtyChannelConfiguration
Imports
java.io.IOException, java.util.Map, org.apache.sshd.common.util.OsUtils

Author
Apache MINA SSHD Project

Field Summary

Inherited from org.apache.sshd.common.channel.PtyChannelConfigurationHolder:
DEFAULT_COLUMNS_COUNTDEFAULT_HEIGHTDEFAULT_PTY_MODESDEFAULT_ROWS_COUNTDEFAULT_WIDTHDUMMY_PTY_TYPEWINDOWS_PTY_TYPE

Method Summary

Modifier and TypeMethod and Description
public static <M extends PtyChannelConfigurationMutator> M
public void
setPtyColumns(int ptyColumns)

public void
setPtyHeight(int ptyHeight)

public void
setPtyLines(int ptyLines)

public void
public void
setPtyType(String ptyType)

public void
setPtyWidth(int ptyWidth)

public static <M extends PtyChannelConfigurationMutator> M

Returns:

The updated mutator
setupSensitiveDefaultPtyConfiguration
(M
The mutator to update - ignored if null
mutator
)

Uses O/S detection to initialize some default PTY related values

Inherited from org.apache.sshd.common.channel.PtyChannelConfigurationHolder:
getPtyColumnsgetPtyHeightgetPtyLinesgetPtyModesgetPtyTypegetPtyWidth

Method Detail

copyConfigurationback to summary
public static <M extends PtyChannelConfigurationMutator> M copyConfiguration(PtyChannelConfigurationHolder src, M dst)
setPtyColumnsback to summary
public void setPtyColumns(int ptyColumns)
setPtyHeightback to summary
public void setPtyHeight(int ptyHeight)
setPtyLinesback to summary
public void setPtyLines(int ptyLines)
setPtyModesback to summary
public void setPtyModes(Map<PtyMode, Integer> ptyModes)
setPtyTypeback to summary
public void setPtyType(String ptyType)
setPtyWidthback to summary
public void setPtyWidth(int ptyWidth)
setupSensitiveDefaultPtyConfigurationback to summary
public static <M extends PtyChannelConfigurationMutator> M setupSensitiveDefaultPtyConfiguration(M mutator) throws IOException, InterruptedException

Uses O/S detection to initialize some default PTY related values

Parameters
<M>
Generic PtyChannelConfigurationMutator instance
mutator:M

The mutator to update - ignored if null

Returns:M

The updated mutator

Exceptions
IOException:
If failed to access some O/S related configuration
InterruptedException:
If interrupted during access of O/S related configuration