Skip to content
View as Markdown

PtyHandle

Handle for interacting with an active PTY session.

Supports bidirectional I/O, resize, kill, and waiting for connection/exit events.

Methods

waitForConnection()

public void waitForConnection(long timeoutSeconds)

Waits for PTY websocket connection to be fully established.

Parameters:

  • timeoutSeconds long - maximum seconds to wait

Throws:

  • DaytonaException - if connection fails or times out

sendInput()

public void sendInput(String data)

Sends text input to PTY.

Parameters:

  • data String - UTF-8 text to send

Throws:

  • DaytonaException - if sending fails

sendInput()

public void sendInput(byte[] data)

Sends binary input to PTY.

Parameters:

  • data byte[] - binary payload

Throws:

  • DaytonaException - if sending fails

waitForExit()

public PtyResult waitForExit()

Waits until the PTY session exits.

Returns:

  • PtyResult - final PTY result

Throws:

  • DaytonaException - if interrupted while waiting

waitForExit()

public PtyResult waitForExit(long timeoutSeconds)

Waits for PTY exit with timeout.

Parameters:

  • timeoutSeconds long - maximum seconds to wait

Returns:

  • PtyResult - final PTY result, or timeout result when exit does not occur in time

Throws:

  • DaytonaException - if interrupted while waiting

resize()

public void resize(int cols, int rows)

Resizes terminal dimensions.

Parameters:

  • cols int - terminal width in columns
  • rows int - terminal height in rows

kill()

public void kill()

Terminates PTY session.

disconnect()

public void disconnect()

Disconnects the PTY websocket.

getSessionId()

public String getSessionId()

Returns PTY session identifier.

Returns:

  • String - session ID

getExitCode()

public Integer getExitCode()

Returns PTY exit code when available.

Returns:

  • Integer - exit code, or null if not known yet

getError()

public String getError()

Returns PTY error or exit reason.

Returns:

  • String - error message, or null when none

isConnected()

public boolean isConnected()

Returns websocket connectivity status.

Returns:

  • boolean - true when socket is currently connected