io.termd.core.tty.TtyConnection Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of termd-core Show documentation

An open source terminal daemon library providing terminal handling in Java, back ported to Alibaba by core engine team to support running on JDK 6+.

There is a newer version: 1.1.7.14

Show newest version

/*
 * Copyright 2015 Julien Viet
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package io.termd.core.tty;

import io.termd.core.function.BiConsumer;
import io.termd.core.function.Consumer;
import io.termd.core.util.Vector;

import java.nio.charset.Charset;
import java.util.concurrent.TimeUnit;

/**
 * A connection to a tty.
 *
 * @author Julien Viet
 */
public interface TtyConnection {

  /**
   * @return the last time this connection received input
   */
  long lastAccessedTime();

  Vector size();

  /**
   * @return the current charset for sending data
   */
  Charset inputCharset();

  /**
   * @return the current charset for receiving data
   */
  Charset outputCharset();

  /**
   * @return the terminal type value, this can be null when the terminal has not declared its type yet. The {@link #setTerminalTypeHandler(Consumer)}
   *         can be used to aware when the terminal type is known.
   */
  String terminalType();

  /**
   * @return the terminal type handler
   */
  Consumer getTerminalTypeHandler();

  /**
   *
   * @param handler set an handler called when the terminal type value is known
   */
  void setTerminalTypeHandler(Consumer handler);

  Consumer getSizeHandler();

  void setSizeHandler(Consumer handler);

  BiConsumer getEventHandler();

  void setEventHandler(BiConsumer handler);

  Consumer getStdinHandler();

  /**
   * Set the read handler on this connection.
   *
   * @param handler the event handler
   */
  void setStdinHandler(Consumer handler);

  /**
   * @return the stdout handler of this connection
   */
  Consumer stdoutHandler();

  void setCloseHandler(Consumer closeHandler);

  Consumer getCloseHandler();

  void close();

  void close(int exit);

  /**
   * Write a string to the client.
   *
   * @param s the string to write
   */
  TtyConnection write(String s);

  /**
   * Schedule a task for execution.
   *
   * @param task the task to schedule
   */
  void execute(Runnable task);

  /**
   * Schedule a task for execution.
   *
   * @param task the task to schedule
   * @param delay the delay
   * @param unit the time unit
   */
  void schedule(Runnable task, long delay, TimeUnit unit);

}