Class TelnetTermOptions

java.lang.Object
io.vertx.core.net.NetworkOptions
io.vertx.core.net.TCPSSLOptions
io.vertx.core.net.NetServerOptions
io.vertx.ext.shell.term.TelnetTermOptions
public class TelnetTermOptions extends NetServerOptions
Telnet terminal options configuration, extends NetServerOptions.
Author:
Julien Viet

  • Field Details

  • Constructor Details

    • TelnetTermOptions

      public TelnetTermOptions()

    • TelnetTermOptions

      public TelnetTermOptions(TelnetTermOptions other)

    • TelnetTermOptions

      public TelnetTermOptions(JsonObject json)

  • Method Details

    • setSendBufferSize

      public TelnetTermOptions setSendBufferSize(int sendBufferSize)
      Description copied from class: NetworkOptions
      Set the TCP send buffer size
      Overrides:
      setSendBufferSize in class NetServerOptions
      Parameters:
      sendBufferSize - the buffers size, in bytes
      Returns:
      a reference to this, so the API can be used fluently

    • setReceiveBufferSize

      public TelnetTermOptions setReceiveBufferSize(int receiveBufferSize)
      Description copied from class: NetworkOptions
      Set the TCP receive buffer size
      Overrides:
      setReceiveBufferSize in class NetServerOptions
      Parameters:
      receiveBufferSize - the buffers size, in bytes
      Returns:
      a reference to this, so the API can be used fluently

    • setReuseAddress

      public TelnetTermOptions setReuseAddress(boolean reuseAddress)
      Description copied from class: NetworkOptions
      Set the value of reuse address
      Overrides:
      setReuseAddress in class NetServerOptions
      Parameters:
      reuseAddress - the value of reuse address
      Returns:
      a reference to this, so the API can be used fluently

    • setTrafficClass

      public TelnetTermOptions setTrafficClass(int trafficClass)
      Description copied from class: NetworkOptions
      Set the value of traffic class
      Overrides:
      setTrafficClass in class NetServerOptions
      Parameters:
      trafficClass - the value of traffic class
      Returns:
      a reference to this, so the API can be used fluently

    • setTcpNoDelay

      public TelnetTermOptions setTcpNoDelay(boolean tcpNoDelay)
      Description copied from class: TCPSSLOptions
      Set whether TCP no delay is enabled
      Overrides:
      setTcpNoDelay in class NetServerOptions
      Parameters:
      tcpNoDelay - true if TCP no delay is enabled (Nagle disabled)
      Returns:
      a reference to this, so the API can be used fluently

    • setTcpKeepAlive

      public TelnetTermOptions setTcpKeepAlive(boolean tcpKeepAlive)
      Description copied from class: TCPSSLOptions
      Set whether TCP keep alive is enabled
      Overrides:
      setTcpKeepAlive in class NetServerOptions
      Parameters:
      tcpKeepAlive - true if TCP keep alive is enabled
      Returns:
      a reference to this, so the API can be used fluently

    • setSoLinger

      public TelnetTermOptions setSoLinger(int soLinger)
      Description copied from class: TCPSSLOptions
      Set whether SO_linger keep alive is enabled
      Overrides:
      setSoLinger in class NetServerOptions
      Parameters:
      soLinger - true if SO_linger is enabled
      Returns:
      a reference to this, so the API can be used fluently

    • setIdleTimeout

      public TelnetTermOptions setIdleTimeout(int idleTimeout)
      Description copied from class: TCPSSLOptions
      Set the idle timeout, default time unit is seconds. Zero means don't timeout. This determines if a connection will timeout and be closed if no data is received nor sent within the timeout. If you want change default time unit, use TCPSSLOptions.setIdleTimeoutUnit(TimeUnit)
      Overrides:
      setIdleTimeout in class NetServerOptions
      Parameters:
      idleTimeout - the timeout
      Returns:
      a reference to this, so the API can be used fluently

    • setSsl

      public TelnetTermOptions setSsl(boolean ssl)
      Description copied from class: TCPSSLOptions
      Set whether SSL/TLS is enabled
      Overrides:
      setSsl in class NetServerOptions
      Parameters:
      ssl - true if enabled
      Returns:
      a reference to this, so the API can be used fluently

    • addEnabledCipherSuite

      public TelnetTermOptions addEnabledCipherSuite(String suite)
      Description copied from class: TCPSSLOptions
      Add an enabled cipher suite, appended to the ordered suites.
      Overrides:
      addEnabledCipherSuite in class NetServerOptions
      Parameters:
      suite - the suite
      Returns:
      a reference to this, so the API can be used fluently
      See Also:

    • addCrlPath

      public TelnetTermOptions addCrlPath(String crlPath) throws NullPointerException
      Description copied from class: TCPSSLOptions
      Add a CRL path
      Overrides:
      addCrlPath in class NetServerOptions
      Parameters:
      crlPath - the path
      Returns:
      a reference to this, so the API can be used fluently
      Throws:
      NullPointerException

    • addCrlValue

      public TelnetTermOptions addCrlValue(Buffer crlValue) throws NullPointerException
      Description copied from class: TCPSSLOptions
      Add a CRL value
      Overrides:
      addCrlValue in class NetServerOptions
      Parameters:
      crlValue - the value
      Returns:
      a reference to this, so the API can be used fluently
      Throws:
      NullPointerException

    • setAcceptBacklog

      public TelnetTermOptions setAcceptBacklog(int acceptBacklog)
      Description copied from class: NetServerOptions
      Set the accept back log
      Overrides:
      setAcceptBacklog in class NetServerOptions
      Parameters:
      acceptBacklog - accept backlog
      Returns:
      a reference to this, so the API can be used fluently

    • setHost

      public TelnetTermOptions setHost(String host)
      Description copied from class: NetServerOptions
      Set the host
      Overrides:
      setHost in class NetServerOptions
      Parameters:
      host - the host
      Returns:
      a reference to this, so the API can be used fluently

    • setPort

      public TelnetTermOptions setPort(int port)
      Description copied from class: NetServerOptions
      Set the port
      Overrides:
      setPort in class NetServerOptions
      Parameters:
      port - the port
      Returns:
      a reference to this, so the API can be used fluently

    • getOutBinary

      public boolean getOutBinary()

    • setOutBinary

      public TelnetTermOptions setOutBinary(boolean outBinary)
      Set the telnet connection to negociate binary data format when sending to the client, the default value is true. This allows to send data in 8 bit format and thus charset like UTF-8.
      Parameters:
      outBinary - the out binary value
      Returns:
      a reference to this, so the API can be used fluently

    • getInBinary

      public boolean getInBinary()

    • setInBinary

      public TelnetTermOptions setInBinary(boolean inBinary)
      Set the telnet connection to negociate binary data format when receiving from the client, the default value is true. This allows to send data in 8 bit format and thus charset like UTF-8.
      Parameters:
      inBinary - the in binary value
      Returns:
      a reference to this, so the API can be used fluently

    • getCharset

      public String getCharset()

    • setCharset

      public TelnetTermOptions setCharset(String charset)
      Set the charset to use when binary mode is active, see setInBinary(boolean) and setOutBinary(boolean).
      Parameters:
      charset - the charset
      Returns:
      a reference to this, so the API can be used fluently

    • getIntputrc

      public String getIntputrc()
      Returns:
      the current path of the inputrc config

    • setIntputrc

      public TelnetTermOptions setIntputrc(String intputrc)
      The path of the inputrc config.
      Parameters:
      intputrc - the path of the inputrc config
      Returns:
      a reference to this, so the API can be used fluently